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

Class PathArg

java.lang.Object

org.apache.juneau.rest.server.arg.PathArg

All Implemented Interfaces:

RestOpArg

public class PathArg
extends Object
implements RestOpArg

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

The parameter value is resolved using:

opSession .getRequest() .getPathParams() .get(name) .as(type);

schema is derived from the Path annotation.

See Also:

• Java Method Parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathArg(ParameterInfo paramInfo, AnnotationWorkList annotations, UrlPathMatcher pathMatcher)	Constructor.

Method Summary

Modifier and Type	Method	Description
static PathArg	create(ParameterInfo paramInfo, AnnotationWorkList annotations, UrlPathMatcher pathMatcher)	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

PathArg

protected PathArg(ParameterInfo paramInfo,
 AnnotationWorkList annotations,
 UrlPathMatcher pathMatcher)

Constructor.

Parameters:

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

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

pathMatcher - Path matcher for the specified method. Can be null (the name must then be specified on the Path annotation).

Method Details

create

public static PathArg create(ParameterInfo paramInfo,
 AnnotationWorkList annotations,
 UrlPathMatcher pathMatcher)

Static creator.

Parameters:

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

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

pathMatcher - Path matcher for the specified method. Can be null (the name must then be specified on the Path annotation).

Returns:

A new PathArg, or null if the parameter is not annotated with Path.

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.