WebResult (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.webmvc.AbstractWebResult<Integer>
- - net.ymate.platform.webmvc.util.WebResult

All Implemented Interfaces:

Serializable, IWebResult<Integer>
```
public final class WebResult
extends AbstractWebResult<Integer>
```
Since:

2.0.6

Author:

刘镇 (suninformation@163.com) on 15/8/18 下午2:18

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface net.ymate.platform.webmvc.IWebResult
  IWebResult.IDataFilter

Constructor Summary

Constructors
Constructor and Description

WebResult()

WebResult(int code)

Constructors
Constructor and Description
`WebResult()`
`WebResult(int code)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebResult`	`attr(String attrKey, Object attrValue)`
`WebResult`	`attrs(Map<String,Object> attrs)`
`static IWebResultBuilder`	`builder()`
`static IWebResultBuilder`	`builder(ErrorCode errorCode)`
`static IWebResultBuilder`	`builder(IWebMvc owner, ErrorCode errorCode)`
`static IWebResultBuilder`	`builder(IWebMvc owner, String resourceName, ErrorCode errorCode)`
`static IWebResultBuilder`	`builder(String resourceName, ErrorCode errorCode)`
`WebResult`	`code(Integer code)`
`static WebResult`	`create()`
`static WebResult`	`create(ErrorCode errorCode)`
`static WebResult`	`create(int code)`
`static WebResult`	`create(IWebMvc owner, ErrorCode errorCode)`
`static WebResult`	`create(IWebMvc owner, String resourceName, ErrorCode errorCode)`
`static WebResult`	`create(String resourceName, ErrorCode errorCode)`
`WebResult`	`data(Object data)`
`WebResult`	`dataAttr(String dataKey, Object dataValue)`
`static IView`	`formatView(IWebResult<?> result)`
`static IView`	`formatView(IWebResult<?> result, String defaultFormat)`
`static IView`	`formatView(String path, IWebResult<?> result)`
`static IView`	`formatView(String path, String paramFormat, String paramCallback, IWebResult<?> result)`
`static IView`	`formatView(String path, String paramFormat, String defaultFormat, String paramCallback, IWebResult<?> result)`
`boolean`	`isSuccess()`
`WebResult`	`keepNullValue()`
`WebResult`	`msg(String msg)`
`WebResult`	`snakeCase()`
`static WebResult`	`succeed()`
`WebResult`	`withContentType()`

Methods inherited from class net.ymate.platform.webmvc.AbstractWebResult
attr, attrs, code, data, dataAttr, dataFilter, doContentAppend, doFilter, msg, toJsonObject, toJsonView, toJsonView, toXml, toXmlView, toXmlView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebResult
```
public WebResult()
```

WebResult
```
public WebResult(int code)
```

Method Detail

builder

public static IWebResultBuilder builder()

builder

public static IWebResultBuilder builder(ErrorCode errorCode)

builder

public static IWebResultBuilder builder(String resourceName,
                                        ErrorCode errorCode)

builder

public static IWebResultBuilder builder(IWebMvc owner,
                                        ErrorCode errorCode)

builder

public static IWebResultBuilder builder(IWebMvc owner,
                                        String resourceName,
                                        ErrorCode errorCode)

create
```
public static WebResult create()
```

create

public static WebResult create(int code)

create

public static WebResult create(ErrorCode errorCode)

create

public static WebResult create(IWebMvc owner,
                               ErrorCode errorCode)

create

public static WebResult create(String resourceName,
                               ErrorCode errorCode)

create

public static WebResult create(IWebMvc owner,
                               String resourceName,
                               ErrorCode errorCode)

succeed
```
public static WebResult succeed()
```

isSuccess
```
public boolean isSuccess()
```

code
```
public WebResult code(Integer code)
```
Specified by:

code in interface IWebResult<Integer>

Overrides:

code in class AbstractWebResult<Integer>

msg
```
public WebResult msg(String msg)
```
Specified by:

msg in interface IWebResult<Integer>

Overrides:

msg in class AbstractWebResult<Integer>

data
```
public WebResult data(Object data)
```
Specified by:

data in interface IWebResult<Integer>

Overrides:

data in class AbstractWebResult<Integer>

attrs
```
public WebResult attrs(Map<String,Object> attrs)
```
Specified by:

attrs in interface IWebResult<Integer>

Overrides:

attrs in class AbstractWebResult<Integer>

dataAttr

public WebResult dataAttr(String dataKey,
                          Object dataValue)

Specified by:: dataAttr in interface IWebResult<Integer>
Overrides:: dataAttr in class AbstractWebResult<Integer>

attr

public WebResult attr(String attrKey,
                      Object attrValue)

Specified by:: attr in interface IWebResult<Integer>
Overrides:: attr in class AbstractWebResult<Integer>

withContentType
```
public WebResult withContentType()
```
Specified by:

withContentType in interface IWebResult<Integer>

Overrides:

withContentType in class AbstractWebResult<Integer>

keepNullValue
```
public WebResult keepNullValue()
```
Specified by:

keepNullValue in interface IWebResult<Integer>

Overrides:

keepNullValue in class AbstractWebResult<Integer>

snakeCase
```
public WebResult snakeCase()
```
Specified by:

snakeCase in interface IWebResult<Integer>

Overrides:

snakeCase in class AbstractWebResult<Integer>

formatView

public static IView formatView(IWebResult<?> result)

formatView

public static IView formatView(String path,
                               IWebResult<?> result)

formatView

public static IView formatView(IWebResult<?> result,
                               String defaultFormat)

formatView

public static IView formatView(String path,
                               String paramFormat,
                               String paramCallback,
                               IWebResult<?> result)

Parameters:: path - JSP模块路径; paramFormat - 数据格式，可选值：json|jsonp|xml; paramCallback - 当数据结式为jsonp时，指定回调方法参数名; result - 回应的数据对象
Returns:: 根据paramFormat等参数判断返回对应的视图对象

formatView

public static IView formatView(String path,
                               String paramFormat,
                               String defaultFormat,
                               String paramCallback,
                               IWebResult<?> result)

Class WebResult

Nested Class Summary

Nested classes/interfaces inherited from interface net.ymate.platform.webmvc.IWebResult

Constructor Summary

Method Summary

Methods inherited from class net.ymate.platform.webmvc.AbstractWebResult

Methods inherited from class java.lang.Object

Constructor Detail

WebResult

WebResult

Method Detail

builder

builder

builder

builder

builder

create

create

create

create

create

create

succeed

isSuccess

code

msg

data

attrs

dataAttr

attr

withContentType

keepNullValue

snakeCase

formatView

formatView

formatView

formatView

formatView