Package com.marklogic.client.util

Class RequestParameters

java.lang.Object

com.marklogic.client.impl.RequestParametersImplementation

com.marklogic.client.util.RequestParameters

All Implemented Interfaces:

java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Direct Known Subclasses:

ResourceExtensionsManager.MethodParameters, ServerTransform

public class RequestParameters
extends com.marklogic.client.impl.RequestParametersImplementation
implements java.util.Map<java.lang.String,java.util.List<java.lang.String>>

RequestParameters supports a map with a string as the key and a list of strings as the value, which can represent parameters of an operation including parameters transported over HTTP.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors

Constructor	Description
RequestParameters()	Zero-argument constructor.

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String name, java.lang.String value)	Appends a value to the list for a parameter.
void	add(java.lang.String name, java.lang.String... values)	Appends a list of values to the list for a parameter.
void	clear()	Removes all parameters.
boolean	containsKey(java.lang.Object key)	Checks whether the parameter name has been specified.
boolean	containsValue(java.lang.Object value)	Checks whether any parameters have the value.
RequestParameters	copy(java.lang.String prefix)	Creates a copy of the parameters, prepending a namespace prefix to each parameter name.
java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>	entrySet()	Returns a set of parameter-list entries.
java.util.List<java.lang.String>	get(java.lang.Object key)	Gets the values for a parameter name.
boolean	isEmpty()	Returns whether or not any request parameters have been specified.
java.util.Set<java.lang.String>	keySet()	Returns the set of specified parameter names.
void	put(java.lang.String name, java.lang.String value)	Set a parameter to a single value.
void	put(java.lang.String name, java.lang.String... values)	Sets a parameter to a list of values.
java.util.List<java.lang.String>	put(java.lang.String key, java.util.List<java.lang.String> value)	Sets the values of a parameter name, returning the previous values if any.
void	putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> m)	Adds existing parameter names and values.
java.util.List<java.lang.String>	remove(java.lang.Object key)	Removes a parameter name, returning its values if any.
int	size()	Returns the number of request parameters.
java.util.Collection<java.util.List<java.lang.String>>	values()	Returns a list of value lists.

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, entry, equals, forEach, getOrDefault, hashCode, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.marklogic.client.impl.RequestParametersImplementation

getMap

Constructor Detail

RequestParameters

public RequestParameters()

Zero-argument constructor.

Method Detail

put

public void put(java.lang.String name,
                java.lang.String value)

Set a parameter to a single value.

Parameters:

name - the parameter name

value - the value of the parameter

put

public void put(java.lang.String name,
                java.lang.String... values)

Sets a parameter to a list of values.

Parameters:

name - the parameter

values - the list of values

add

public void add(java.lang.String name,
                java.lang.String value)

Appends a value to the list for a parameter.

Parameters:

name - the parameter

value - the value to add to the list

add

public void add(java.lang.String name,
                java.lang.String... values)

Appends a list of values to the list for a parameter.

Parameters:

name - the parameter

values - the values to add to the list

size

public int size()

Returns the number of request parameters.

Specified by:

size in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

isEmpty

public boolean isEmpty()

Returns whether or not any request parameters have been specified.

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

containsKey

public boolean containsKey(java.lang.Object key)

Checks whether the parameter name has been specified.

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

containsValue

public boolean containsValue(java.lang.Object value)

Checks whether any parameters have the value.

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

get

public java.util.List<java.lang.String> get(java.lang.Object key)

Gets the values for a parameter name.

Specified by:

get in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

put

public java.util.List<java.lang.String> put(java.lang.String key,
                                            java.util.List<java.lang.String> value)

Sets the values of a parameter name, returning the previous values if any.

Specified by:

put in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

remove

public java.util.List<java.lang.String> remove(java.lang.Object key)

Removes a parameter name, returning its values if any.

Specified by:

remove in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> m)

Adds existing parameter names and values.

Specified by:

putAll in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

clear

public void clear()

Removes all parameters.

Specified by:

clear in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

keySet

public java.util.Set<java.lang.String> keySet()

Returns the set of specified parameter names.

Specified by:

keySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

values

public java.util.Collection<java.util.List<java.lang.String>> values()

Returns a list of value lists.

Specified by:

values in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> entrySet()

Returns a set of parameter-list entries.

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

copy

public RequestParameters copy(java.lang.String prefix)

Creates a copy of the parameters, prepending a namespace prefix to each parameter name.

Parameters:

prefix - the prefix to prepend

Returns:

the copy of the parameters