Package org.apache.juneau.http.classic.header

Class HeaderList.Unmodifiable

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Header>

org.apache.juneau.http.classic.header.HeaderList

org.apache.juneau.http.classic.header.HeaderList.Unmodifiable

All Implemented Interfaces:

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

Enclosing class:

HeaderList

public static class HeaderList.Unmodifiable
extends HeaderList
implements UnmodifiableBean

An unmodifiable snapshot of a HeaderList.

This is the "collection-mutator-override" variant of the immutability paradigm. Because HeaderList 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.header.HeaderList

HeaderList.Unmodifiable, HeaderList.Void

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

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

Methods inherited from class org.apache.juneau.http.classic.header.HeaderList

contains, copy, create, forEach, forEach, forEachValue, forEachValue, get, get, get, getAll, getAll, getFirst, getLast, getValues, headerIterator, headerIterator, isUnmodifiable, of, of, ofPairs, 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 HeaderList append(Header value)

Description copied from class: HeaderList

Adds the specified header to the end of the headers in this list.

Overrides:

append in class HeaderList

Parameters:

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

Returns:

This object.

append

public HeaderList append(Header... values)

Description copied from class: HeaderList

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

Overrides:

append in class HeaderList

Parameters:

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

Returns:

This object.

append

public HeaderList append(List<Header> values)

Description copied from class: HeaderList

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

Overrides:

append in class HeaderList

Parameters:

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

Returns:

This object.

append

public HeaderList append(String name,
 Object value)

Description copied from class: HeaderList

Appends the specified header to the end of this list.

The header is added as a BasicHeader.

Overrides:

append in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

append

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

Description copied from class: HeaderList

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

The header is added as a BasicHeader.

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

Overrides:

append in class HeaderList

Parameters:

name - The header name.

value - The header value supplier.

Returns:

This object.

caseSensitive

public HeaderList caseSensitive(boolean value)

Description copied from class: HeaderList

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

The default behavior is case-insensitive.

Overrides:

caseSensitive in class HeaderList

Parameters:

value - The new value for this setting.

Returns:

This object.

prepend

public HeaderList prepend(Header value)

Description copied from class: HeaderList

Adds the specified header to the beginning of the headers in this list.

Overrides:

prepend in class HeaderList

Parameters:

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

Returns:

This object.

prepend

public HeaderList prepend(Header... values)

Description copied from class: HeaderList

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

Overrides:

prepend in class HeaderList

Parameters:

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

Returns:

This object.

prepend

public HeaderList prepend(List<Header> values)

Description copied from class: HeaderList

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

Overrides:

prepend in class HeaderList

Parameters:

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

Returns:

This object.

prepend

public HeaderList prepend(String name,
 Object value)

Description copied from class: HeaderList

Appends the specified header to the beginning of this list.

The header is added as a BasicHeader.

Overrides:

prepend in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

prepend

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

Description copied from class: HeaderList

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

The header is added as a BasicHeader.

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

Overrides:

prepend in class HeaderList

Parameters:

name - The header name.

value - The header value supplier.

Returns:

This object.

remove

public HeaderList remove(Header value)

Description copied from class: HeaderList

Removes the specified header from this list.

Overrides:

remove in class HeaderList

Parameters:

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

Returns:

This object.

remove

public HeaderList remove(Header... values)

Description copied from class: HeaderList

Removes the specified headers from this list.

Overrides:

remove in class HeaderList

Parameters:

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

Returns:

This object.

remove

public HeaderList remove(List<Header> values)

Description copied from class: HeaderList

Removes the specified headers from this list.

Overrides:

remove in class HeaderList

Parameters:

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

Returns:

This object.

remove

public HeaderList remove(String name)

Description copied from class: HeaderList

Removes the header with the specified name from this list.

Overrides:

remove in class HeaderList

Parameters:

name - The header name.

Returns:

This object.

remove

public HeaderList remove(String... names)

Description copied from class: HeaderList

Removes the header with the specified name from this list.

Overrides:

remove in class HeaderList

Parameters:

names - The header name.

Returns:

This object.

removeAll

public HeaderList removeAll()

Description copied from class: HeaderList

Removes all headers from this list.

Overrides:

removeAll in class HeaderList

Returns:

This object.

resolving

public HeaderList resolving()

Description copied from class: HeaderList

Allows header values to contain SVL variables.

Resolves variables in header 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 HeaderList

Returns:

This object.

resolving

public HeaderList resolving(VarResolver varResolver)

Description copied from class: HeaderList

Allows header values to contain SVL variables.

Resolves variables in header 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 HeaderList

Parameters:

varResolver - The variable resolver to use for resolving variables. Can be null to disable variable resolution.

Returns:

This object.

set

public HeaderList set(Header value)

Description copied from class: HeaderList

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

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

Overrides:

set in class HeaderList

Parameters:

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

Returns:

This object.

set

public HeaderList set(Header... values)

Description copied from class: HeaderList

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

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

Overrides:

set in class HeaderList

Parameters:

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

Returns:

This object.

set

public HeaderList set(List<Header> values)

Description copied from class: HeaderList

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

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

Overrides:

set in class HeaderList

Parameters:

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

Returns:

This object.

set

public HeaderList set(String name,
 Object value)

Description copied from class: HeaderList

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

Overrides:

set in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

set

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

Description copied from class: HeaderList

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

Overrides:

set in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setDefault

public HeaderList setDefault(Header... headers)

Description copied from class: HeaderList

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

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

Overrides:

setDefault in class HeaderList

Parameters:

headers - The list of default headers.

Returns:

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

setDefault

public HeaderList setDefault(List<Header> headers)

Description copied from class: HeaderList

Adds a collection of default headers.

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

Overrides:

setDefault in class HeaderList

Parameters:

headers - The list of default headers.

Returns:

This object.

setDefault

public HeaderList setDefault(String name,
 Object value)

Description copied from class: HeaderList

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

Overrides:

setDefault in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setDefault

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

Description copied from class: HeaderList

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

Overrides:

setDefault in class HeaderList

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

add

public boolean add(Header e)

Specified by:

add in interface Collection<Header>

Specified by:

add in interface List<Header>

Overrides:

add in class ArrayList<Header>

add

public void add(int index,
 Header element)

Specified by:

add in interface List<Header>

Overrides:

add in class ArrayList<Header>

addAll

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

Specified by:

addAll in interface Collection<Header>

Specified by:

addAll in interface List<Header>

Overrides:

addAll in class ArrayList<Header>

addAll

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

Specified by:

addAll in interface List<Header>

Overrides:

addAll in class ArrayList<Header>

clear

public void clear()

Specified by:

clear in interface Collection<Header>

Specified by:

clear in interface List<Header>

Overrides:

clear in class ArrayList<Header>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Header>

Specified by:

remove in interface List<Header>

Overrides:

remove in class ArrayList<Header>

remove

public Header remove(int index)

Specified by:

remove in interface List<Header>

Overrides:

remove in class ArrayList<Header>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<Header>

Specified by:

removeAll in interface List<Header>

Overrides:

removeAll in class ArrayList<Header>

removeIf

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

Specified by:

removeIf in interface Collection<Header>

Overrides:

removeIf in class ArrayList<Header>

replaceAll

public void replaceAll(UnaryOperator<Header> operator)

Specified by:

replaceAll in interface List<Header>

Overrides:

replaceAll in class ArrayList<Header>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<Header>

Specified by:

retainAll in interface List<Header>

Overrides:

retainAll in class ArrayList<Header>

set

public Header set(int index,
 Header element)

Specified by:

set in interface List<Header>

Overrides:

set in class ArrayList<Header>

sort

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

Specified by:

sort in interface List<Header>

Overrides:

sort in class ArrayList<Header>

iterator

public Iterator<Header> iterator()

Specified by:

iterator in interface Collection<Header>

Specified by:

iterator in interface Iterable<Header>

Specified by:

iterator in interface List<Header>

Overrides:

iterator in class ArrayList<Header>

listIterator

public ListIterator<Header> listIterator()

Specified by:

listIterator in interface List<Header>

Overrides:

listIterator in class ArrayList<Header>

listIterator

public ListIterator<Header> listIterator(int index)

Specified by:

listIterator in interface List<Header>

Overrides:

listIterator in class ArrayList<Header>