Package org.apache.juneau.rest.arg

Class ResponseHeaderArg

java.lang.Object

org.apache.juneau.rest.arg.ResponseHeaderArg

All Implemented Interfaces:

RestOpArg

public class ResponseHeaderArg
extends Object
implements RestOpArg

Resolves method parameters annotated with Header of type Value representing response headers 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(name,value);

See Also:

• Java Method Parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResponseHeaderArg(ParamInfo pi, AnnotationWorkList annotations)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ResponseHeaderArg	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

ResponseHeaderArg

protected ResponseHeaderArg(ParamInfo pi,
 AnnotationWorkList annotations)

Constructor.

Parameters:

pi - The Java method parameter being resolved.

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

Method Details

create

public static ResponseHeaderArg 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 ResponseHeaderArg, or null if the parameter is not annotated with Header.

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.