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

Class RequestQueryParamList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<RequestQueryParam>

org.apache.juneau.rest.server.httppart.RequestQueryParamList

All Implemented Interfaces:

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

public class RequestQueryParamList
extends ArrayList<RequestQueryParam>

Represents the query parameters in an HTTP request.

The RequestQueryParamList object is the API for accessing the GET query parameters of an HTTP request. It can be accessed by passing it as a parameter on your REST Java method:

@RestPost(...) public Object myMethod(RequestQueryParamList query) {...}

Example:

@RestPost(...) public Object myMethod(RequestQueryParamList query) { // Get query parameters converted to various types. int p1 = query.get("p1").asInteger().orElse(0); String p2 = query.get("p2").orElse(null); UUID p3 = query.get("p3").as(UUID.class).orElse(null); }

An important distinction between the behavior of this object and HttpServletRequest.getParameter(String) is that the former will NOT load the content of the request on FORM POSTS and will only look at parameters found in the query string. This can be useful in cases where you're mixing GET parameters and FORM POSTS and you don't want to inadvertently read the content of the request to get a query parameter.

Some important methods on this class are:

• RequestQueryParamList
  • Methods for retrieving query parameters:
    • contains(String)
    • containsAny(String...)
    • get(Class)
    • get(String)
    • getAll(String)
    • getFirst(String)
    • getLast(String)
  • Methods overridding query parameters:
    • add(HttpPart...)
    • add(String,Object)
    • addDefault(List)
    • addDefault(HttpPart...)
    • addDefault(String,String)
    • remove(String)
    • set(HttpPart...)
    • set(String,Object)
  • Other methods:
    • asQueryString()
    • copy()
    • isEmpty()

Entries are stored in a case-sensitive map unless overridden via the constructor.

See Also:

• RequestQueryParam
• Query
• HasQuery
• HTTP parts in REST servers

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
RequestQueryParamList(RestRequest req, Map<String,String[]> query, boolean caseSensitive)	Constructor.

Method Summary

Modifier and Type	Method	Description
RequestQueryParamList	add(String name, Object value)	Adds a parameter value.
RequestQueryParamList	add(HttpPart... parameters)	Adds request parameter values.
RequestQueryParamList	addDefault(String name, String value)	Adds a default entry to the query parameters.
RequestQueryParamList	addDefault(List<? extends HttpPart> pairs)	Adds default entries to these parameters.
RequestQueryParamList	addDefault(HttpPart... pairs)	Adds default entries to these parameters.
String	asQueryString()	Converts this object to a query string.
RequestQueryParamList	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.
RequestQueryParamList	copy()	Makes a copy of these parameters.
boolean	equals(Object o)
<T> Optional<T>	get(Class<T> type)	Returns the query parameter as the specified bean type.
RequestQueryParam	get(String name)	Returns the condensed header with the specified name.
List<RequestQueryParam>	getAll(String name)	Returns all the parameters with the specified name.
RequestQueryParam	getFirst(String name)	Returns the first parameter with the specified name.
RequestQueryParam	getLast(String name)	Returns the last parameter with the specified name.
List<String>	getNames()	Returns all the unique header names in this list.
Stream<RequestQueryParam>	getSorted()	Returns all headers in sorted order.
int	hashCode()
RequestQueryParamList	parser(HttpPartParserSession value)	Sets the parser to use for part values.
protected FluentMap<String,Object>	properties()
RequestQueryParamList	remove(String name)	Remove parameters.
RequestQueryParamList	set(String name, Object value)	Sets a parameter value.
RequestQueryParamList	set(HttpPart... parameters)	Sets request header values.
Stream<RequestQueryParam>	stream(String name)	Returns all headers with the specified name.
RequestQueryParamList	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, forEach, get, 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

RequestQueryParamList

public RequestQueryParamList(RestRequest req,
 Map<String,String[]> query,
 boolean caseSensitive)

Constructor.

Parameters:

req - The request creating this bean. Must not be null.

query - The raw parsed query parameter values. Must not be null.

caseSensitive - Whether case-sensitive name matching is enabled.

Method Details

add

public RequestQueryParamList add(HttpPart... 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.

add

public RequestQueryParamList 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.

addDefault

public RequestQueryParamList addDefault(List<? extends HttpPart> 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 (no-op).

Returns:

This object.

addDefault

public RequestQueryParamList addDefault(HttpPart... 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 (no-op).

Returns:

This object.

addDefault

public RequestQueryParamList addDefault(String name,
 String value)

Adds a default entry to the query parameters.

Parameters:

name - The name.

value - The value.

Returns:

This object.

asQueryString

public String asQueryString()

Converts this object to a query string.

Returned query string does not start with '?'.

Returns:

A new query string, or an empty string if this object is empty.

caseSensitive

public RequestQueryParamList 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).

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 names are 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.

copy

public RequestQueryParamList copy()

Makes a copy of these parameters.

Returns:

A new parameters object.

get

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

Returns the query parameter as the specified bean type.

Type must have a name specified via the Query 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, or Optional.empty() if the parameter is not present.

get

public RequestQueryParam get(String name)

Returns the condensed header with the specified name.

If multiple headers are present, they will be combined into a single comma-delimited list.

Parameters:

name - The header name.

Returns:

The header, never null.

getAll

public List<RequestQueryParam> 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.
List is unmodifiable.

getFirst

public RequestQueryParam 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 RequestQueryParam 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.

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.
List is unmodifiable.

getSorted

public Stream<RequestQueryParam> getSorted()

Returns all headers in sorted order.

Returns:

The stream of all headers in sorted order.

parser

public RequestQueryParamList parser(HttpPartParserSession value)

Sets the parser to use for part values.

Parameters:

value - The new value for this setting.

Returns:

This object.

remove

public RequestQueryParamList remove(String name)

Remove parameters.

Parameters:

name - The parameter names. Must not be null.

Returns:

This object.

set

public RequestQueryParamList set(HttpPart... 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.

set

public RequestQueryParamList 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 (the parameter is set with a null value).

Returns:

This object.

stream

public Stream<RequestQueryParam> 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.

subset

public RequestQueryParamList 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.

properties

protected FluentMap<String,Object> properties()

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<RequestQueryParam>

Specified by:

equals in interface List<RequestQueryParam>

Overrides:

equals in class ArrayList<RequestQueryParam>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<RequestQueryParam>

Specified by:

hashCode in interface List<RequestQueryParam>

Overrides:

hashCode in class ArrayList<RequestQueryParam>

toString

public String toString()

Overrides:

toString in class AbstractCollection<RequestQueryParam>