Package org.apache.juneau.rest.httppart

Class RequestPathParams

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<RequestPathParam>

org.apache.juneau.rest.httppart.RequestPathParams

All Implemented Interfaces:

Serializable, Cloneable, Iterable<RequestPathParam>, Collection<RequestPathParam>, List<RequestPathParam>, RandomAccess

public class RequestPathParams
extends ArrayList<RequestPathParam>

Represents the path parameters in an HTTP request.

The RequestPathParams object is the API for accessing the matched variables and remainder on the URL path.

@RestPost(...) public Object myMethod(RequestPathParams path) {...}

Example:

@RestPost(..., path="/{foo}/{bar}/{baz}/*") public void doGet(RequestPathParams path) { // Example URL: /123/qux/true/quux int foo = path.get("foo").asInteger().orElse(0); // =123 String bar = path.get("bar").orElse(null); // =qux boolean baz = path.get("baz").asBoolean().orElse(false); // =true String remainder = path.getRemainder(); // =quux }

Some important methods on this class are:

• RequestPathParams
  • Methods for retrieving path parameters:
    • contains(String)
    • containsAny(String...)
    • get(Class)
    • get(String)
    • getAll(String)
    • getFirst(String)
    • getLast(String)
    • getRemainder()
    • getRemainderUndecoded()
  • Methods overridding path parameters:
    • add(NameValuePair...)
    • add(String,Object)
    • addDefault(List)
    • addDefault(NameValuePair...)
    • remove(String)
    • set(NameValuePair...)
    • set(String,Object)
  • Other methods:
    • copy()
    • isEmpty()

See Also:

• RequestPathParam
• Path
• HTTP Parts

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
RequestPathParams(RestSession session, RestRequest req, boolean caseSensitive)	Constructor.

Method Summary

Modifier and Type	Method	Description
RequestPathParams	add(String name, Object value)	Adds a parameter value.
RequestPathParams	add(NameValuePair... parameters)	Adds request parameter values.
RequestPathParams	addDefault(String name, String value)	Adds a default entry to the query parameters.
RequestPathParams	addDefault(List<NameValuePair> pairs)	Adds default entries to these parameters.
RequestPathParams	addDefault(NameValuePair... pairs)	Adds default entries to these parameters.
RequestPathParams	caseSensitive(boolean value)	Sets case sensitivity for names in this list.
boolean	contains(String name)	Returns true if the parameters with the specified name is present.
boolean	containsAny(String... names)	Returns true if the parameter with any of the specified names are present.
RequestPathParams	copy()	Makes a copy of these parameters.
<T> Optional<T>	get(Class<T> type)	Returns the path parameter as the specified bean type.
RequestPathParam	get(String name)	Returns the last parameter with the specified name.
List<RequestPathParam>	getAll(String name)	Returns all the parameters with the specified name.
RequestPathParam	getFirst(String name)	Returns the first parameter with the specified name.
RequestPathParam	getLast(String name)	Returns the last parameter with the specified name.
List<String>	getNames()	Returns all the unique header names in this list.
RequestPathParam	getRemainder()	Returns the decoded remainder of the URL following any path pattern matches.
RequestPathParam	getRemainderUndecoded()	Same as getRemainder() but doesn't decode characters.
Stream<RequestPathParam>	getSorted()	Returns all headers in sorted order.
RequestPathParams	parser(HttpPartParserSession value)	Sets the parser to use for part values.
RequestPathParams	remove(String name)	Remove parameters.
RequestPathParams	set(String name, Object value)	Sets a parameter value.
RequestPathParams	set(NameValuePair... parameters)	Sets request header values.
Stream<RequestPathParam>	stream(String name)	Returns all headers with the specified name.
RequestPathParams	subset(String... names)	Returns a copy of this object but only with the specified param names copied.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

RequestPathParams

public RequestPathParams(RestSession session,
 RestRequest req,
 boolean caseSensitive)

Constructor.

Parameters:

session - The current HTTP request session.

req - The current HTTP request.

caseSensitive - Whether case-sensitive name matching is enabled.

Method Details

parser

public RequestPathParams parser(HttpPartParserSession value)

Sets the parser to use for part values.

Parameters:

value - The new value for this setting.

Returns:

This object.

caseSensitive

public RequestPathParams caseSensitive(boolean value)

Sets case sensitivity for names in this list.

Parameters:

value - The new value for this setting.

Returns:

This object (for method chaining).

addDefault

public RequestPathParams addDefault(List<NameValuePair> pairs)

Adds default entries to these parameters.

Similar to set(String, Object) but doesn't override existing values.

Parameters:

pairs - The default entries.
Can be null.

Returns:

This object.

addDefault

public RequestPathParams addDefault(NameValuePair... pairs)

Adds default entries to these parameters.

Similar to set(String, Object) but doesn't override existing values.

Parameters:

pairs - The default entries.
Can be null.

Returns:

This object.

addDefault

public RequestPathParams addDefault(String name,
 String value)

Adds a default entry to the query parameters.

Parameters:

name - The name.

value - The value.

Returns:

This object.

add

public RequestPathParams add(String name,
 Object value)

Adds a parameter value.

Parameter is added to the end.
Existing parameter with the same name are not changed.

Parameters:

name - The parameter name. Must not be null.

value - The parameter value.

Returns:

This object.

add

public RequestPathParams add(NameValuePair... parameters)

Adds request parameter values.

Parameters are added to the end.
Existing parameters with the same name are not changed.

Parameters:

parameters - The parameter objects. Must not be null.

Returns:

This object.

set

public RequestPathParams set(String name,
 Object value)

Sets a parameter value.

Parameter is added to the end.
Any previous parameters with the same name are removed.

Parameters:

name - The parameter name. Must not be null.

value - The parameter value.
Converted to a string using Object.toString().
Can be null.

Returns:

This object.

set

public RequestPathParams set(NameValuePair... parameters)

Sets request header values.

Parameters are added to the end of the headers.
Any previous parameters with the same name are removed.

Parameters:

parameters - The parameters to set. Must not be null or contain null.

Returns:

This object.

remove

public RequestPathParams remove(String name)

Remove parameters.

Parameters:

name - The parameter name. Must not be null.

Returns:

This object.

subset

public RequestPathParams subset(String... names)

Returns a copy of this object but only with the specified param names copied.

Parameters:

names - The list to include in the copy.

Returns:

A new list object.

contains

public boolean contains(String name)

Returns true if the parameters with the specified name is present.

Parameters:

name - The parameter name. Must not be null.

Returns:

true if the parameters with the specified name is present.

containsAny

public boolean containsAny(String... names)

Returns true if the parameter with any of the specified names are present.

Parameters:

names - The parameter names. Must not be null.

Returns:

true if the parameter with any of the specified names are present.

getAll

public List<RequestPathParam> getAll(String name)

Returns all the parameters with the specified name.

Parameters:

name - The parameter name.

Returns:

The list of all parameters with the specified name, or an empty list if none are found.

stream

public Stream<RequestPathParam> stream(String name)

Returns all headers with the specified name.

Parameters:

name - The header name.

Returns:

The stream of all headers with matching names. Never null.

getSorted

public Stream<RequestPathParam> getSorted()

Returns all headers in sorted order.

Returns:

The stream of all headers in sorted order.

getNames

public List<String> getNames()

Returns all the unique header names in this list.

Returns:

The list of all unique header names in this list.

getFirst

public RequestPathParam getFirst(String name)

Returns the first parameter with the specified name.

Note that this method never returns null and that RequestHttpPart.isPresent() can be used to test for the existence of the parameter.

Parameters:

name - The parameter name.

Returns:

The parameter. Never null.

getLast

public RequestPathParam getLast(String name)

Returns the last parameter with the specified name.

Note that this method never returns null and that RequestHttpPart.isPresent() can be used to test for the existence of the parameter.

Parameters:

name - The parameter name.

Returns:

The parameter. Never null.

get

public RequestPathParam get(String name)

Returns the last parameter with the specified name.

This is equivalent to getLast(String).

Parameters:

name - The parameter name.

Returns:

The parameter value, or Optional.empty() if it doesn't exist.

get

public <T> Optional<T> get(Class<T> type)

Returns the path parameter as the specified bean type.

Type must have a name specified via the Path annotation and a public constructor that takes in either value or name,value as strings.

Type Parameters:

T - The bean type to create.

Parameters:

type - The bean type to create.

Returns:

The bean, never null.

copy

public RequestPathParams copy()

Makes a copy of these parameters.

Returns:

A new parameters object.

getRemainder

public RequestPathParam getRemainder()

Returns the decoded remainder of the URL following any path pattern matches.

The behavior of path remainder is shown below given the path pattern "/foo/*":

URL	Path Remainder
/foo	null
/foo/	""
/foo//	"/"
/foo///	"//"
/foo/a/b	"a/b"
/foo//a/b/	"/a/b/"
/foo/a%2Fb	"a/b"

Example:

// REST method @RestGet("/foo/{bar}/*") public String doGetById(RequestPathParams path, int bar) { return path.remainder().orElse(null); }

The remainder can also be retrieved by calling get("/**").

Returns:

The path remainder string.

getRemainderUndecoded

public RequestPathParam getRemainderUndecoded()

Same as getRemainder() but doesn't decode characters.

The undecoded remainder can also be retrieved by calling get("/*").

Returns:

The un-decoded path remainder.

toString

public String toString()

Overrides:

toString in class AbstractCollection<RequestPathParam>