Undertow 2.3.12.Final · io.undertow.util.HeaderMap · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Collection<HttpString>	headerNames
private int	size
private Object[]	table

Access	Constructor and Description
public	HeaderMap()

Method Summary

Modifier and Type	Method and Description
public HeaderMap	add(HttpString headerName, String headerValue)
public HeaderMap	add(HttpString headerName, long headerValue)
public HeaderMap	addAll(HttpString headerName, Collection<String> headerValues)
public HeaderMap	addFirst(final HttpString headerName, final String headerValue)
public HeaderMap	addLast(final HttpString headerName, final String headerValue)
public HeaderMap	clear()
public boolean	contains(HttpString headerName)
public boolean	contains(String headerName)
public int	count(HttpString headerName)
public int	count(String headerName)
public Iterable<String>	eachValue(final HttpString headerName)
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public long	Returns: an opaque iterating cookie, or -1 if no iteration is possible fastIterate() Do a fast iteration of this header map without creating any objects.
public long	Returns: an opaque iterating cookie, or -1 if no iteration is possible fastIterateNonEmpty() Do a fast iteration of this header map without creating any objects, only considering non-empty header values.
public HeaderValues	Returns: the values object at this position fiCurrent(long the iteration cookie value cookie) Return the value at the current index in a fast iteration.
public long	Returns: the next cookie value, or -1L if iteration is done fiNext(long the previous cookie value cookie) Find the next index in a fast iteration.
public long	Returns: the next cookie value, or -1L if iteration is done fiNextNonEmpty(long the previous cookie value cookie) Find the next non-empty index in a fast iteration.
public HeaderValues	get(final HttpString headerName)
public HeaderValues	get(final String headerName)
public String	get(HttpString headerName, int index)
public String	get(String headerName, int index)
private HeaderValues	getEntry(final HttpString headerName)
private HeaderValues	getEntry(final String headerName)
public String	getFirst(HttpString headerName)
public String	getFirst(String headerName)
public Collection<HttpString>	getHeaderNames()
public String	getLast(HttpString headerName)
public String	getLast(String headerName)
private HeaderValues	getOrCreateEntry(final HttpString headerName)
private HeaderValues	getOrCreateNonEmpty(HttpString headerName, Object[] table, int length, int idx, Object o)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Iterator<HeaderValues>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public HeaderMap	put(HttpString headerName, String headerValue)
public HeaderMap	put(HttpString headerName, long headerValue)
public HeaderMap	putAll(HttpString headerName, Collection<String> headerValues)
public HeaderMap	putAll(HeaderMap headerMap)
public Collection<String>	remove(HttpString headerName)
public Collection<String>	remove(String headerName)
private HeaderValues	removeEntry(final HttpString headerName)
private HeaderValues	removeEntry(final String headerName)
private void	resize()
public int	size()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

headerNames	back to summary
private Collection<HttpString> headerNames

size	back to summary
private int size

table	back to summary
private Object[] table

HeaderMap	back to summary
public HeaderMap()

Method Detail

add	back to summary
public HeaderMap add(HttpString headerName, String headerValue)

add	back to summary
public HeaderMap add(HttpString headerName, long headerValue)

addAll	back to summary
public HeaderMap addAll(HttpString headerName, Collection<String> headerValues)

addFirst	back to summary
public HeaderMap addFirst(final HttpString headerName, final String headerValue)

addLast	back to summary
public HeaderMap addLast(final HttpString headerName, final String headerValue)

clear	back to summary
public HeaderMap clear()

contains	back to summary
public boolean contains(HttpString headerName)

contains	back to summary
public boolean contains(String headerName)

count	back to summary
public int count(HttpString headerName)

count	back to summary
public int count(String headerName)

eachValue	back to summary
public Iterable<String> eachValue(final HttpString headerName)

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

fastIterate back to summary

fastIterate	back to summary
public long fastIterate() Do a fast iteration of this header map without creating any objects. Returns:long an opaque iterating cookie, or -1 if no iteration is possible See Also `fiNext(long)`, `fiCurrent(long)`

public long fastIterate()

Do a fast iteration of this header map without creating any objects.

Returns:long: an opaque iterating cookie, or -1 if no iteration is possible
See Also: fiNext(long), fiCurrent(long)

fastIterateNonEmpty	back to summary
public long fastIterateNonEmpty() Do a fast iteration of this header map without creating any objects, only considering non-empty header values. Returns:long an opaque iterating cookie, or -1 if no iteration is possible

fastIterateNonEmpty

back to summary

public long fastIterateNonEmpty()

Do a fast iteration of this header map without creating any objects, only considering non-empty header values.

Returns:long: an opaque iterating cookie, or -1 if no iteration is possible

fiCurrent	back to summary
public HeaderValues fiCurrent(long cookie) Return the value at the current index in a fast iteration. Parameters cookie:long the iteration cookie value Returns:HeaderValues the values object at this position Exceptions NoSuchElementException: if the cookie value is invalid

fiCurrent

back to summary

public HeaderValues fiCurrent(long cookie)

Return the value at the current index in a fast iteration.

Parameters

cookie:long: the iteration cookie value

Returns:HeaderValues

the values object at this position

Exceptions

NoSuchElementException:: if the cookie value is invalid

fiNext	back to summary
public long fiNext(long cookie) Find the next index in a fast iteration. Parameters cookie:long the previous cookie value Returns:long the next cookie value, or -1L if iteration is done

fiNext

back to summary

public long fiNext(long cookie)

Find the next index in a fast iteration.

Parameters

cookie:long: the previous cookie value

Returns:long

the next cookie value, or -1L if iteration is done

fiNextNonEmpty	back to summary
public long fiNextNonEmpty(long cookie) Find the next non-empty index in a fast iteration. Parameters cookie:long the previous cookie value Returns:long the next cookie value, or -1L if iteration is done

fiNextNonEmpty

back to summary

public long fiNextNonEmpty(long cookie)

Find the next non-empty index in a fast iteration.

Parameters

cookie:long: the previous cookie value

Returns:long

the next cookie value, or -1L if iteration is done

get	back to summary
public HeaderValues get(final HttpString headerName)

get	back to summary
public HeaderValues get(final String headerName)

get	back to summary
public String get(HttpString headerName, int index) throws IndexOutOfBoundsException

get	back to summary
public String get(String headerName, int index) throws IndexOutOfBoundsException

getEntry	back to summary
private HeaderValues getEntry(final HttpString headerName)

getEntry	back to summary
private HeaderValues getEntry(final String headerName)

getFirst	back to summary
public String getFirst(HttpString headerName)

getFirst	back to summary
public String getFirst(String headerName)

getHeaderNames	back to summary
public Collection<HttpString> getHeaderNames()

getLast	back to summary
public String getLast(HttpString headerName)

getLast	back to summary
public String getLast(String headerName)

getOrCreateEntry	back to summary
private HeaderValues getOrCreateEntry(final HttpString headerName)

getOrCreateNonEmpty	back to summary
private HeaderValues getOrCreateNonEmpty(HttpString headerName, Object[] table, int length, int idx, Object o)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<HeaderValues> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<HeaderValues> an Iterator.

public Iterator<HeaderValues> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<HeaderValues>: an Iterator.

put	back to summary
public HeaderMap put(HttpString headerName, String headerValue)

put	back to summary
public HeaderMap put(HttpString headerName, long headerValue)

putAll	back to summary
public HeaderMap putAll(HttpString headerName, Collection<String> headerValues)

putAll	back to summary
public HeaderMap putAll(HeaderMap headerMap)

remove	back to summary
public Collection<String> remove(HttpString headerName)

remove	back to summary
public Collection<String> remove(String headerName)

removeEntry	back to summary
private HeaderValues removeEntry(final HttpString headerName)

removeEntry	back to summary
private HeaderValues removeEntry(final String headerName)

resize	back to summary
private void resize()

size	back to summary
public int size()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class HeaderMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail