org.apache.juneau.httppart.bean

Class ResponseBeanMeta

java.lang.Object

org.apache.juneau.httppart.bean.ResponseBeanMeta

public class ResponseBeanMeta
extends Object

Represents the metadata gathered from a parameter or class annotated with Response.

Field Summary

Fields

Modifier and Type	Field and Description
static ResponseBeanMeta	NULL Represents a non-existent meta object.

Method Summary

Modifier and Type	Method and Description
static ResponseBeanMeta	create(Method m, int i, PropertyStore ps) Create metadata from specified method parameter.
static ResponseBeanMeta	create(Method m, PropertyStore ps) Create metadata from specified method return.
static ResponseBeanMeta	create(Type t, PropertyStore ps) Create metadata from specified class.
ResponseBeanPropertyMeta	getBodyMethod() Returns the @ResponseBody-annotated method.
ClassMeta<?>	getClassMeta() Returns metadata about the class.
int	getCode() Returns the HTTP status code.
Collection<ResponseBeanPropertyMeta>	getHeaderMethods() Returns metadata about the @ResponseHeader-annotated methods.
HttpPartSerializer	getPartSerializer() Returns the part serializer to use to serialize this response.
Collection<ResponseBeanPropertyMeta>	getProperties() Returns all the annotated methods on this bean.
ResponseBeanPropertyMeta	getProperty(String name) Returns metadata about the bean property with the specified method getter name.
HttpPartSchema	getSchema() Returns the schema information about the response object.
ResponseBeanPropertyMeta	getStatusMethod() Returns the @ResponseStatus-annotated method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL

public static ResponseBeanMeta NULL

Represents a non-existent meta object.

Method Detail

create

public static ResponseBeanMeta create(Type t,
                                      PropertyStore ps)

Create metadata from specified class.

Parameters:

t - The class annotated with Response.

ps - Configuration information used to instantiate part serializers and part parsers.
Can be null.

Returns:

Metadata about the class, or null if class not annotated with Response.

create

public static ResponseBeanMeta create(Method m,
                                      PropertyStore ps)

Create metadata from specified method return.

Parameters:

m - The method annotated with Response.

ps - Configuration information used to instantiate part serializers and part parsers.
Can be null.

Returns:

Metadata about the class, or null if class not annotated with Response.

create

public static ResponseBeanMeta create(Method m,
                                      int i,
                                      PropertyStore ps)

Create metadata from specified method parameter.

Parameters:

m - The method containing the parameter annotated with Response.

i - The parameter index.

ps - Configuration information used to instantiate part serializers and part parsers.
Can be null.

Returns:

Metadata about the class, or null if class not annotated with Response.

getCode

public int getCode()

Returns the HTTP status code.

Returns:

The HTTP status code.

getSchema

public HttpPartSchema getSchema()

Returns the schema information about the response object.

Returns:

The schema information about the response object.

getHeaderMethods

public Collection<ResponseBeanPropertyMeta> getHeaderMethods()

Returns metadata about the @ResponseHeader-annotated methods.

Returns:

Metadata about the @ResponseHeader-annotated methods, or an empty collection if none exist.

getBodyMethod

public ResponseBeanPropertyMeta getBodyMethod()

Returns the @ResponseBody-annotated method.

Returns:

The @ResponseBody-annotated method, or null if it doesn't exist.

getStatusMethod

public ResponseBeanPropertyMeta getStatusMethod()

Returns the @ResponseStatus-annotated method.

Returns:

The @ResponseStatus-annotated method, or null if it doesn't exist.

getPartSerializer

public HttpPartSerializer getPartSerializer()

Returns the part serializer to use to serialize this response.

Returns:

The part serializer to use to serialize this response.

getClassMeta

public ClassMeta<?> getClassMeta()

Returns metadata about the class.

Returns:

Metadata about the class.

getProperty

public ResponseBeanPropertyMeta getProperty(String name)

Returns metadata about the bean property with the specified method getter name.

Parameters:

name - The bean method getter name.

Returns:

Metadata about the bean property, or null if none found.

getProperties

public Collection<ResponseBeanPropertyMeta> getProperties()

Returns all the annotated methods on this bean.

Returns:

All the annotated methods on this bean.