Package org.apache.juneau.rest.arg

Class ResponseBeanArg

java.lang.Object

org.apache.juneau.rest.arg.ResponseBeanArg

All Implemented Interfaces:

RestOpArg

public class ResponseBeanArg
extends Object
implements RestOpArg

Resolves method parameters and parameter types annotated with Response on RestOp-annotated Java methods.

The parameter value must be of type Value that accepts a value that is then set via:

opSession .getResponse() .setOutput(value);

See Also:

• @Response Beans

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResponseBeanArg(ParamInfo paramInfo, AnnotationWorkList annotations)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ResponseBeanArg	create(ParamInfo paramInfo, AnnotationWorkList annotations)	Static creator.
Object	resolve(RestOpSession opSession)	Resolves the parameter object.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseBeanArg

protected ResponseBeanArg(ParamInfo paramInfo,
 AnnotationWorkList annotations)

Constructor.

Parameters:

paramInfo - The Java method parameter being resolved.

annotations - The annotations to apply to any new part parsers.

Method Details

create

public static ResponseBeanArg create(ParamInfo paramInfo,
 AnnotationWorkList annotations)

Static creator.

Parameters:

paramInfo - The Java method parameter being resolved.

annotations - The annotations to apply to any new part parsers.

Returns:

A new ResponseBeanArg, or null if the parameter is not annotated with Response.

resolve

public Object resolve(RestOpSession opSession)
               throws Exception

Description copied from interface: RestOpArg

Resolves the parameter object.

Specified by:

resolve in interface RestOpArg

Parameters:

opSession - The rest call.

Returns:

The resolved object.

Throws:

Exception - Generic error occurred.