Package org.apache.juneau.rest.server.httppart

Class RequestPathParam

java.lang.Object

org.apache.juneau.rest.server.httppart.RequestHttpPart

org.apache.juneau.rest.server.httppart.RequestPathParam

All Implemented Interfaces:

HttpPart

public class RequestPathParam
extends RequestHttpPart
implements HttpPart

Represents a single path parameter on an HTTP request.

Typically accessed through the RequestPathParamList class.

Some important methods on this class are:

• RequestPathParam
  • Methods for retrieving simple string values:
    • asString()
    • get()
    • isPresent()
    • orElse(String)
  • Methods for retrieving as other common types:
    • asBoolean()
    • asBooleanPart()
    • asCsvArray()
    • asCsvArrayPart()
    • asDate()
    • asDatePart()
    • asInteger()
    • asIntegerPart()
    • asLong()
    • asLongPart()
    • asMatcher(Pattern)
    • asMatcher(String)
    • asMatcher(String,int)
    • asStringPart()
    • asUriPart()
  • Methods for retrieving as custom types:
    • as(Class)
    • as(ClassMeta)
    • as(Type,Type...)
    • parser(HttpPartParserSession)
    • schema(HttpPartSchema)
  • Methods for performing assertion checks:
    • assertCsvArray()
    • assertDate()
    • assertInteger()
    • assertLong()
    • assertString()
  • Other methods:
    • getName()
    • getValue()

  See Also:

  • HTTP parts in REST servers

Constructor Summary

Constructors

Constructor	Description
RequestPathParam(RestRequest request, String name, String value)	Constructor.

Method Summary

Modifier and Type	Method	Description
RequestPathParam	def(String def)	Sets a default value for this part.
RequestPathParam	parser(HttpPartParserSession value)	Specifies the part parser to use for this part.
RequestPathParam	schema(HttpPartSchema value)	Specifies the part schema for this part.

Methods inherited from class org.apache.juneau.rest.server.httppart.RequestHttpPart

as, as, as, asBoolean, asBooleanPart, asCsvArray, asCsvArrayPart, asDate, asDatePart, asInteger, asIntegerPart, asLong, asLongPart, asMatcher, asMatcher, asMatcher, assertCsvArray, assertDate, assertInteger, assertLong, assertString, asString, asStringPart, asUriPart, equals, get, getName, getRequest, getValue, hashCode, isPresent, orElse, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.http.HttpPart

getName, getValue

Constructor Details

RequestPathParam

public RequestPathParam(RestRequest request,
 String name,
 String value)

Constructor.

Parameters:

request - The request object.

name - The parameter name.

value - The parameter value.

Method Details

def

public RequestPathParam def(String def)

Description copied from class: RequestHttpPart

Sets a default value for this part.

Overrides:

def in class RequestHttpPart

Parameters:

def - The default value.

Returns:

This object.

parser

public RequestPathParam parser(HttpPartParserSession value)

Description copied from class: RequestHttpPart

Specifies the part parser to use for this part.

If not specified, uses the part parser defined on the resource via @Rest(partParser=...).

Overrides:

parser in class RequestHttpPart

Parameters:

value - The new part parser to use for this part.
If null, SimplePartParser.DEFAULT will be used.

Returns:

This object.

schema

public RequestPathParam schema(HttpPartSchema value)

Description copied from class: RequestHttpPart

Specifies the part schema for this part.

Used by schema-based part parsers such as OpenApiParser.

Overrides:

schema in class RequestHttpPart

Parameters:

value - The part schema.

Returns:

This object.