Package org.apache.juneau.http.classic.part

Class PartList.Unmodifiable

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<NameValuePair>

org.apache.juneau.http.classic.part.PartList

org.apache.juneau.http.classic.part.PartList.Unmodifiable

All Implemented Interfaces:

Serializable, Cloneable, Iterable<NameValuePair>, Collection<NameValuePair>, List<NameValuePair>, RandomAccess, UnmodifiableBean

Enclosing class:

PartList

public static class PartList.Unmodifiable
extends PartList
implements UnmodifiableBean

An unmodifiable snapshot of a PartList.

This is the "collection-mutator-override" variant of the immutability paradigm. Because PartList extends ArrayList, a single modify() funnel cannot intercept the inherited ArrayList mutators, so this subclass snapshot-copies the elements in its constructor and overrides the entire collection-mutator surface — its own fluent mutators plus the inherited ArrayList mutators (including the iterator() / listIterator() mutators) — to throw UnsupportedOperationException. Read operations and non-mutating iteration continue to work.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.http.classic.part.PartList

PartList.Unmodifiable, PartList.Void

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
void	add(int index, NameValuePair element)
boolean	add(NameValuePair e)
boolean	addAll(int index, Collection<? extends NameValuePair> c)
boolean	addAll(Collection<? extends NameValuePair> c)
PartList	append(String name, Object value)	Appends the specified part to the end of this list.
PartList	append(String name, Supplier<?> value)	Appends the specified part to the end of this list using a value supplier.
PartList	append(List<NameValuePair> values)	Adds the specified parts to the end of the parts in this list.
PartList	append(NameValuePair value)	Adds the specified part to the end of the parts in this list.
PartList	append(NameValuePair... values)	Adds the specified parts to the end of the parts in this list.
PartList	caseInsensitive(boolean value)	Specifies that the parts in this list should be treated as case-sensitive.
void	clear()
Iterator<NameValuePair>	iterator()
ListIterator<NameValuePair>	listIterator()
ListIterator<NameValuePair>	listIterator(int index)
PartList	prepend(String name, Object value)	Appends the specified part to the beginning of this list.
PartList	prepend(String name, Supplier<?> value)	Appends the specified part to the beginning of this list using a value supplier.
PartList	prepend(List<NameValuePair> values)	Adds the specified parts to the beginning of the parts in this list.
PartList	prepend(NameValuePair value)	Adds the specified part to the beginning of the parts in this list.
PartList	prepend(NameValuePair... values)	Adds the specified parts to the beginning of the parts in this list.
NameValuePair	remove(int index)
boolean	remove(Object o)
PartList	remove(String name)	Removes the part with the specified name from this list.
PartList	remove(String... names)	Removes the part with the specified name from this list.
PartList	remove(List<NameValuePair> values)	Removes the specified parts from this list.
PartList	remove(NameValuePair value)	Removes the specified part from this list.
PartList	remove(NameValuePair... values)	Removes the specified parts from this list.
boolean	removeAll(Collection<?> c)
boolean	removeIf(Predicate<? super NameValuePair> filter)
void	replaceAll(UnaryOperator<NameValuePair> operator)
PartList	resolving()	Allows part values to contain SVL variables.
PartList	resolving(VarResolver varResolver)	Allows part values to contain SVL variables.
boolean	retainAll(Collection<?> c)
NameValuePair	set(int index, NameValuePair element)
PartList	set(String name, Object value)	Replaces the first occurrence of the parts with the same name.
PartList	set(String name, Supplier<?> value)	Replaces the first occurrence of the parts with the same name.
PartList	set(List<NameValuePair> values)	Replaces the first occurrence of the parts with the same name.
PartList	set(NameValuePair value)	Adds or replaces the part(s) with the same name.
PartList	set(NameValuePair... values)	Adds or replaces the part(s) with the same name.
PartList	setDefault(String name, Object value)	Replaces the first occurrence of the part with the same name.
PartList	setDefault(String name, Supplier<?> value)	Replaces the first occurrence of the headers with the same name.
PartList	setDefault(List<NameValuePair> parts)	Adds a collection of default parts.
PartList	setDefault(NameValuePair... parts)	Makes a copy of this list of parts and adds a collection of default parts.
void	sort(Comparator<? super NameValuePair> c)

Methods inherited from class org.apache.juneau.http.classic.part.PartList

contains, copy, create, forEach, forEach, forEachValue, forEachValue, get, get, get, getAll, getAll, getFirst, getLast, getValues, isUnmodifiable, of, of, ofPairs, partIterator, partIterator, stream, toString, unmodifiable

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, lastIndexOf, removeRange, size, 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

Method Details

append

public PartList append(List<NameValuePair> values)

Description copied from class: PartList

Adds the specified parts to the end of the parts in this list.

Overrides:

append in class PartList

Parameters:

values - The parts to add. null values are ignored.

Returns:

This object.

append

public PartList append(NameValuePair value)

Description copied from class: PartList

Adds the specified part to the end of the parts in this list.

Overrides:

append in class PartList

Parameters:

value - The part to add. null values are ignored.

Returns:

This object.

append

public PartList append(NameValuePair... values)

Description copied from class: PartList

Adds the specified parts to the end of the parts in this list.

Overrides:

append in class PartList

Parameters:

values - The parts to add. null values are ignored.

Returns:

This object.

append

public PartList append(String name,
 Object value)

Description copied from class: PartList

Appends the specified part to the end of this list.

The part is added as a BasicPart.

Overrides:

append in class PartList

Parameters:

name - The part name.

value - The part value.

Returns:

This object.

append

public PartList append(String name,
 Supplier<?> value)

Description copied from class: PartList

Appends the specified part to the end of this list using a value supplier.

The part is added as a BasicPart.

Value is re-evaluated on each call to BasicPart.getValue().

Overrides:

append in class PartList

Parameters:

name - The part name.

value - The part value supplier.

Returns:

This object.

caseInsensitive

public PartList caseInsensitive(boolean value)

Description copied from class: PartList

Specifies that the parts in this list should be treated as case-sensitive.

The default behavior is case-sensitive.

Overrides:

caseInsensitive in class PartList

Parameters:

value - The new value for this setting.

Returns:

This object.

prepend

public PartList prepend(List<NameValuePair> values)

Description copied from class: PartList

Adds the specified parts to the beginning of the parts in this list.

Overrides:

prepend in class PartList

Parameters:

values - The parts to add. null values are ignored.

Returns:

This object.

prepend

public PartList prepend(NameValuePair value)

Description copied from class: PartList

Adds the specified part to the beginning of the parts in this list.

Overrides:

prepend in class PartList

Parameters:

value - The part to add. null values are ignored.

Returns:

This object.

prepend

public PartList prepend(NameValuePair... values)

Description copied from class: PartList

Adds the specified parts to the beginning of the parts in this list.

Overrides:

prepend in class PartList

Parameters:

values - The parts to add. null values are ignored.

Returns:

This object.

prepend

public PartList prepend(String name,
 Object value)

Description copied from class: PartList

Appends the specified part to the beginning of this list.

The part is added as a BasicPart.

Overrides:

prepend in class PartList

Parameters:

name - The part name.

value - The part value.

Returns:

This object.

prepend

public PartList prepend(String name,
 Supplier<?> value)

Description copied from class: PartList

Appends the specified part to the beginning of this list using a value supplier.

The part is added as a BasicPart.

Value is re-evaluated on each call to BasicPart.getValue().

Overrides:

prepend in class PartList

Parameters:

name - The part name.

value - The part value supplier.

Returns:

This object.

remove

public PartList remove(List<NameValuePair> values)

Description copied from class: PartList

Removes the specified parts from this list.

Overrides:

remove in class PartList

Parameters:

values - The parts to remove. null values are ignored.

Returns:

This object.

remove

public PartList remove(NameValuePair value)

Description copied from class: PartList

Removes the specified part from this list.

Overrides:

remove in class PartList

Parameters:

value - The part to remove. null values are ignored.

Returns:

This object.

remove

public PartList remove(NameValuePair... values)

Description copied from class: PartList

Removes the specified parts from this list.

Overrides:

remove in class PartList

Parameters:

values - The parts to remove. null values are ignored.

Returns:

This object.

remove

public PartList remove(String name)

Description copied from class: PartList

Removes the part with the specified name from this list.

Overrides:

remove in class PartList

Parameters:

name - The part name.

Returns:

This object.

remove

public PartList remove(String... names)

Description copied from class: PartList

Removes the part with the specified name from this list.

Overrides:

remove in class PartList

Parameters:

names - The part name.

Returns:

This object.

resolving

public PartList resolving()

Description copied from class: PartList

Allows part values to contain SVL variables.

Resolves variables in part values when using the following methods:

• append(String,Object)
• append(String,Supplier<?>)
• prepend(String,Object)
• prepend(String,Supplier<?>)
• set(String,Object)
• set(String,Supplier<?>)

Uses VarResolver.DEFAULT to resolve variables.

Overrides:

resolving in class PartList

Returns:

This object.

resolving

public PartList resolving(VarResolver varResolver)

Description copied from class: PartList

Allows part values to contain SVL variables.

Resolves variables in part values when using the following methods:

• append(String,Object)
• append(String,Supplier<?>)
• prepend(String,Object)
• prepend(String,Supplier<?>)
• set(String,Object)
• set(String,Supplier<?>)

Overrides:

resolving in class PartList

Parameters:

varResolver - The variable resolver to use for resolving variables. Can be null (disables variable resolution).

Returns:

This object.

set

public PartList set(List<NameValuePair> values)

Description copied from class: PartList

Replaces the first occurrence of the parts with the same name.

If no part with the same name is found the given part is added to the end of the list.

Overrides:

set in class PartList

Parameters:

values - The parts to replace. null values are ignored.

Returns:

This object.

set

public PartList set(NameValuePair value)

Description copied from class: PartList

Adds or replaces the part(s) with the same name.

If no part with the same name is found the given part is added to the end of the list.

Overrides:

set in class PartList

Parameters:

value - The part to replace. null values are ignored.

Returns:

This object.

set

public PartList set(NameValuePair... values)

Description copied from class: PartList

Adds or replaces the part(s) with the same name.

If no part with the same name is found the given part is added to the end of the list.

Overrides:

set in class PartList

Parameters:

values - The part to replace. null values are ignored.

Returns:

This object.

set

public PartList set(String name,
 Object value)

Description copied from class: PartList

Replaces the first occurrence of the parts with the same name.

Overrides:

set in class PartList

Parameters:

name - The part name.

value - The part value.

Returns:

This object.

set

public PartList set(String name,
 Supplier<?> value)

Description copied from class: PartList

Replaces the first occurrence of the parts with the same name.

Overrides:

set in class PartList

Parameters:

name - The part name.

value - The part value.

Returns:

This object.

setDefault

public PartList setDefault(List<NameValuePair> parts)

Description copied from class: PartList

Adds a collection of default parts.

Default parts are set if they're not already in the list.

Overrides:

setDefault in class PartList

Parameters:

parts - The list of default parts.

Returns:

This object.

setDefault

public PartList setDefault(NameValuePair... parts)

Description copied from class: PartList

Makes a copy of this list of parts and adds a collection of default parts.

Default parts are set if they're not already in the list.

Overrides:

setDefault in class PartList

Parameters:

parts - The list of default parts.

Returns:

A new list, or the same list if the parts were empty.

setDefault

public PartList setDefault(String name,
 Object value)

Description copied from class: PartList

Replaces the first occurrence of the part with the same name.

Overrides:

setDefault in class PartList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setDefault

public PartList setDefault(String name,
 Supplier<?> value)

Description copied from class: PartList

Replaces the first occurrence of the headers with the same name.

Overrides:

setDefault in class PartList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

add

public boolean add(NameValuePair e)

Specified by:

add in interface Collection<NameValuePair>

Specified by:

add in interface List<NameValuePair>

Overrides:

add in class ArrayList<NameValuePair>

add

public void add(int index,
 NameValuePair element)

Specified by:

add in interface List<NameValuePair>

Overrides:

add in class ArrayList<NameValuePair>

addAll

public boolean addAll(Collection<? extends NameValuePair> c)

Specified by:

addAll in interface Collection<NameValuePair>

Specified by:

addAll in interface List<NameValuePair>

Overrides:

addAll in class ArrayList<NameValuePair>

addAll

public boolean addAll(int index,
 Collection<? extends NameValuePair> c)

Specified by:

addAll in interface List<NameValuePair>

Overrides:

addAll in class ArrayList<NameValuePair>

clear

public void clear()

Specified by:

clear in interface Collection<NameValuePair>

Specified by:

clear in interface List<NameValuePair>

Overrides:

clear in class ArrayList<NameValuePair>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<NameValuePair>

Specified by:

remove in interface List<NameValuePair>

Overrides:

remove in class ArrayList<NameValuePair>

remove

public NameValuePair remove(int index)

Specified by:

remove in interface List<NameValuePair>

Overrides:

remove in class ArrayList<NameValuePair>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<NameValuePair>

Specified by:

removeAll in interface List<NameValuePair>

Overrides:

removeAll in class ArrayList<NameValuePair>

removeIf

public boolean removeIf(Predicate<? super NameValuePair> filter)

Specified by:

removeIf in interface Collection<NameValuePair>

Overrides:

removeIf in class ArrayList<NameValuePair>

replaceAll

public void replaceAll(UnaryOperator<NameValuePair> operator)

Specified by:

replaceAll in interface List<NameValuePair>

Overrides:

replaceAll in class ArrayList<NameValuePair>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<NameValuePair>

Specified by:

retainAll in interface List<NameValuePair>

Overrides:

retainAll in class ArrayList<NameValuePair>

set

public NameValuePair set(int index,
 NameValuePair element)

Specified by:

set in interface List<NameValuePair>

Overrides:

set in class ArrayList<NameValuePair>

sort

public void sort(Comparator<? super NameValuePair> c)

Specified by:

sort in interface List<NameValuePair>

Overrides:

sort in class ArrayList<NameValuePair>

iterator

public Iterator<NameValuePair> iterator()

Specified by:

iterator in interface Collection<NameValuePair>

Specified by:

iterator in interface Iterable<NameValuePair>

Specified by:

iterator in interface List<NameValuePair>

Overrides:

iterator in class ArrayList<NameValuePair>

listIterator

public ListIterator<NameValuePair> listIterator()

Specified by:

listIterator in interface List<NameValuePair>

Overrides:

listIterator in class ArrayList<NameValuePair>

listIterator

public ListIterator<NameValuePair> listIterator(int index)

Specified by:

listIterator in interface List<NameValuePair>

Overrides:

listIterator in class ArrayList<NameValuePair>