Package org.apache.juneau.rest.server.arg

Class PathRemainderArg

java.lang.Object

org.apache.juneau.rest.server.arg.PathRemainderArg

All Implemented Interfaces:

RestOpArg

public class PathRemainderArg
extends Object
implements RestOpArg

Resolves method parameters annotated with PathRemainder on RestOp-annotated Java methods.

This is a specialized version of PathArg for the path remainder (the part matched by /*). It's functionally equivalent to using @Path("/*"), but provides a more intuitive annotation name.

The parameter value is resolved using:

opSession .getRequest() .getPathParams() .get("/*") .as(type);

schema is derived from the PathRemainder annotation.

See Also:

• Java Method Parameters
• PathRemainder
• PathArg

Since:

9.2.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathRemainderArg(ParameterInfo paramInfo, AnnotationWorkList annotations)	Constructor.

Method Summary

Modifier and Type	Method	Description
static PathRemainderArg	create(ParameterInfo 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

PathRemainderArg

protected PathRemainderArg(ParameterInfo paramInfo,
 AnnotationWorkList annotations)

Constructor.

Parameters:

paramInfo - The Java method parameter being resolved. Must not be null.

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

Method Details

create

public static PathRemainderArg create(ParameterInfo paramInfo,
 AnnotationWorkList annotations)

Static creator.

Parameters:

paramInfo - The Java method parameter being resolved. Must not be null.

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

Returns:

A new PathRemainderArg, or null if the parameter is not annotated with PathRemainder.

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.