org.apache.juneau.rest.client

Class NameValuePairs

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<org.apache.http.NameValuePair>

org.apache.juneau.rest.client.NameValuePairs

All Implemented Interfaces:

Serializable, Cloneable, Iterable<org.apache.http.NameValuePair>, Collection<org.apache.http.NameValuePair>, Deque<org.apache.http.NameValuePair>, List<org.apache.http.NameValuePair>, Queue<org.apache.http.NameValuePair>

public final class NameValuePairs
extends LinkedList<org.apache.http.NameValuePair>

Convenience class for constructing instances of List<NameValuePair> for the UrlEncodedFormEntity class.

Instances of this method can be passed directly to the RestClient.doPost(Object, Object) method or RestCall.body(Object) methods to perform URL-encoded form posts.

Example:

NameValuePairs params = new NameValuePairs() .append("j_username", user) .append("j_password", pw); restClient.doPost(url, params).run();

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NameValuePairs()

Method Summary

Modifier and Type	Method and Description
NameValuePairs	append(org.apache.http.NameValuePair pair) Appends the specified pair to the end of this list.
NameValuePairs	append(String name, Object value) Appends the specified name/value pair to the end of this list.
NameValuePairs	append(String name, Object value, HttpPartSerializer serializer, HttpPartSchema schema) Appends the specified name/value pair to the end of this list.

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

NameValuePairs

public NameValuePairs()

Method Detail

append

public NameValuePairs append(org.apache.http.NameValuePair pair)

Appends the specified pair to the end of this list.

Parameters:

pair - The pair to append to this list.

Returns:

This object (for method chaining).

append

public NameValuePairs append(String name,
                             Object value)

Appends the specified name/value pair to the end of this list.

The value is simply converted to a string using toString(), or "null" if null.

Parameters:

name - The pair name.

value - The pair value.

Returns:

This object (for method chaining).

append

public NameValuePairs append(String name,
                             Object value,
                             HttpPartSerializer serializer,
                             HttpPartSchema schema)

Appends the specified name/value pair to the end of this list.

The value is converted to UON notation using the UrlEncodingSerializer defined on the client.

Parameters:

name - The pair name.

value - The pair value.

serializer - The serializer to use for serializing the value to a string value.

schema - The schema object that defines the format of the output.
If null, defaults to the schema defined on the parser.
If that's also null, defaults to HttpPartSchema.DEFAULT.
Only used if serializer is schema-aware (e.g. OpenApiSerializer).

Returns:

This object (for method chaining).