Top Description Inners Fields Constructors Methods
org.eclipse.jetty.http

pack-priv Class ImmutableHttpFields

extends Object
implements HttpFields
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.http.HttpFields, java.util.function.Supplier, java.lang.Iterable
Known Direct Subclasses
org.eclipse.jetty.http.HttpFields.ImmutableHttpFields
Imports
java.util.Arrays, .ListIterator, .NoSuchElementException, .Objects, java.util.stream.Stream
HTTP Fields. A collection of HTTP header and or Trailer fields.

This class is not synchronized as it is expected that modifications will only be performed by a single thread.

The cookie handling provided by this class is guided by the Servlet specification and RFC6265.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
ImmutableHttpFields.Listerator

Field Summary

Modifier and TypeField and Description
pack-priv final HttpField[]
_fields

pack-priv final int
_size

Constructor Summary

AccessConstructor and Description
protected
ImmutableHttpFields(HttpField[]
the fields to copy data from
fields)

Initialize HttpFields from copy.

protected
ImmutableHttpFields(HttpField[] fields, int size)

Method Summary

Modifier and TypeMethod and Description
public HttpFields
asImmutable()

Overrides default org.eclipse.jetty.http.HttpFields.asImmutable.

Returns an immutable copy of this HttpFields instance.

public boolean
equals(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 String
get(String
the case-insensitive field name to search for
name)

Overrides default org.eclipse.jetty.http.HttpFields.get.

Returns the encoded value of the first field with the given field name, or null if no such field is present.

public String
get(HttpHeader
the field name to search for
header)

Overrides default org.eclipse.jetty.http.HttpFields.get.

Returns the encoded value of the first field with the given field name, or null if no such header is present.

public HttpField
getField(HttpHeader
the field name to search for
header)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Returns the first HttpField with the given field name, or null if no such field is present.

public HttpField
getField(String
the case-insensitive field name to search for
name)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Returns the first HttpField with the given field name, or null if no such field is present.

public HttpField
getField(int
the index of the HttpField
index)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Returns the HttpField at the given index, or null if there is no field at the given index.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public ListIterator<HttpField>
listIterator(int index)

Implements org.eclipse.jetty.http.HttpFields.listIterator.

public int
size()

Overrides default org.eclipse.jetty.http.HttpFields.size.

public Stream<HttpField>
stream()

Overrides default org.eclipse.jetty.http.HttpFields.stream.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_fieldsback to summary
pack-priv final HttpField[] _fields
_sizeback to summary
pack-priv final int _size

Constructor Detail

ImmutableHttpFieldsback to summary
protected ImmutableHttpFields(HttpField[] fields)

Initialize HttpFields from copy.

Parameters
fields:HttpField[]

the fields to copy data from

ImmutableHttpFieldsback to summary
protected ImmutableHttpFields(HttpField[] fields, int size)

Method Detail

asImmutableback to summary
public HttpFields asImmutable()

Overrides default org.eclipse.jetty.http.HttpFields.asImmutable.

Doc from org.eclipse.jetty.http.HttpFields.asImmutable.

Returns an immutable copy of this HttpFields instance.

Returns:HttpFields

a new immutable copy of this HttpFields instance

Annotations
@Override
equalsback to summary
public boolean equals(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
getback to summary
public String get(String name)

Overrides default org.eclipse.jetty.http.HttpFields.get.

Doc from org.eclipse.jetty.http.HttpFields.get.

Returns the encoded value of the first field with the given field name, or null if no such field is present.

The comparison of field name is case-insensitive via HttpField#is(String).

In case of multi-valued fields, the returned value is the encoded value, including commas and quotes, as returned by HttpField#getValue().

Parameters
name:String

the case-insensitive field name to search for

Returns:String

the raw value of the first field with the given field name, or null if no such field is present

Annotations
@Override
getback to summary
public String get(HttpHeader header)

Overrides default org.eclipse.jetty.http.HttpFields.get.

Doc from org.eclipse.jetty.http.HttpFields.get.

Returns the encoded value of the first field with the given field name, or null if no such header is present.

In case of multi-valued fields, the returned value is the encoded value, including commas and quotes, as returned by HttpField#getValue().

Parameters
header:HttpHeader

the field name to search for

Returns:String

the raw value of the first field with the given field name, or null if no such header is present

Annotations
@Override
getFieldback to summary
public HttpField getField(HttpHeader header)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Doc from org.eclipse.jetty.http.HttpFields.getField.

Returns the first HttpField with the given field name, or null if no such field is present.

Parameters
header:HttpHeader

the field name to search for

Returns:HttpField

the first HttpField with the given field name, or null if no such field is present

Annotations
@Override
getFieldback to summary
public HttpField getField(String name)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Doc from org.eclipse.jetty.http.HttpFields.getField.

Returns the first HttpField with the given field name, or null if no such field is present.

The comparison of field name is case-insensitive via HttpField#is(String).

Parameters
name:String

the case-insensitive field name to search for

Returns:HttpField

the first HttpField with the given field name, or null if no such field is present

Annotations
@Override
getFieldback to summary
public HttpField getField(int index)

Overrides default org.eclipse.jetty.http.HttpFields.getField.

Doc from org.eclipse.jetty.http.HttpFields.getField.

Returns the HttpField at the given index, or null if there is no field at the given index.

Parameters
index:int

the index of the HttpField

Returns:HttpField

the HttpField at the given index, or null if there is no field at the given index

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
listIteratorback to summary
public ListIterator<HttpField> listIterator(int index)

Implements org.eclipse.jetty.http.HttpFields.listIterator.

Returns:ListIterator<HttpField>

Doc from org.eclipse.jetty.http.HttpFields.listIterator.

an iterator over the HttpFields in this HttpFields starting at the given index.

Annotations
@Override
sizeback to summary
public int size()

Overrides default org.eclipse.jetty.http.HttpFields.size.

Returns:int

Doc from org.eclipse.jetty.http.HttpFields.size.

the number of HttpFields in this instance

Annotations
@Override
streamback to summary
public Stream<HttpField> stream()

Overrides default org.eclipse.jetty.http.HttpFields.stream.

Returns:Stream<HttpField>

Doc from org.eclipse.jetty.http.HttpFields.stream.

a sequential stream of the HttpFields in this instance

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.eclipse.jetty.http back to summary

private Class ImmutableHttpFields.Listerator

extends Object
implements ListIterator<HttpField>
Class Inheritance
All Implemented Interfaces
java.util.ListIterator, java.util.Iterator

Field Summary

Modifier and TypeField and Description
private int
_index

private int
_last

Constructor Summary

AccessConstructor and Description
pack-priv
Listerator(int index)

Method Summary

Modifier and TypeMethod and Description
public void
add(HttpField
the element to insert
field)

Implements java.util.ListIterator.add.

Inserts the specified element into the list (optional operation).
public boolean
hasNext()

Implements java.util.ListIterator.hasNext.

Returns true if this list iterator has more elements when traversing the list in the forward direction.
public boolean
hasPrevious()

Implements java.util.ListIterator.hasPrevious.

Returns true if this list iterator has more elements when traversing the list in the reverse direction.
public HttpField
next()

Implements java.util.ListIterator.next.

Returns the next element in the list and advances the cursor position.
public int
nextIndex()

Implements java.util.ListIterator.nextIndex.

Returns the index of the element that would be returned by a subsequent call to next.
public HttpField
previous()

Implements java.util.ListIterator.previous.

Returns the previous element in the list and moves the cursor position backwards.
public int
previousIndex()

Implements java.util.ListIterator.previousIndex.

Returns the index of the element that would be returned by a subsequent call to previous.
public void
remove()

Implements java.util.ListIterator.remove.

Removes from the list the last element that was returned by next or previous (optional operation).
public void
set(HttpField
the element with which to replace the last element returned by next or previous
field)

Implements java.util.ListIterator.set.

Replaces the last element returned by next or previous with the specified element (optional operation).
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_indexback to summary
private int _index
_lastback to summary
private int _last

Constructor Detail

Listeratorback to summary
pack-priv Listerator(int index)

Method Detail

addback to summary
public void add(HttpField field)

Implements java.util.ListIterator.add.

Doc from java.util.ListIterator.add.

Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by next, if any, and after the element that would be returned by previous, if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters
field:HttpField

the element to insert

Annotations
@Override
hasNextback to summary
public boolean hasNext()

Implements java.util.ListIterator.hasNext.

Doc from java.util.ListIterator.hasNext.

Returns true if this list iterator has more elements when traversing the list in the forward direction. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the list iterator has more elements when traversing the list in the forward direction

Annotations
@Override
hasPreviousback to summary
public boolean hasPrevious()

Implements java.util.ListIterator.hasPrevious.

Doc from java.util.ListIterator.hasPrevious.

Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if previous would return an element rather than throwing an exception.)

Returns:boolean

true if the list iterator has more elements when traversing the list in the reverse direction

Annotations
@Override
nextback to summary
public HttpField next()

Implements java.util.ListIterator.next.

Doc from java.util.ListIterator.next.

Returns the next element in the list and advances the cursor position. This method may be called repeatedly to iterate through the list, or intermixed with calls to previous to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns:HttpField

the next element in the list

Annotations
@Override
nextIndexback to summary
public int nextIndex()

Implements java.util.ListIterator.nextIndex.

Doc from java.util.ListIterator.nextIndex.

Returns the index of the element that would be returned by a subsequent call to next. (Returns list size if the list iterator is at the end of the list.)

Returns:int

the index of the element that would be returned by a subsequent call to next, or list size if the list iterator is at the end of the list

Annotations
@Override
previousback to summary
public HttpField previous()

Implements java.util.ListIterator.previous.

Doc from java.util.ListIterator.previous.

Returns the previous element in the list and moves the cursor position backwards. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns:HttpField

the previous element in the list

Annotations
@Override
previousIndexback to summary
public int previousIndex()

Implements java.util.ListIterator.previousIndex.

Doc from java.util.ListIterator.previousIndex.

Returns the index of the element that would be returned by a subsequent call to previous. (Returns -1 if the list iterator is at the beginning of the list.)

Returns:int

the index of the element that would be returned by a subsequent call to previous, or -1 if the list iterator is at the beginning of the list

Annotations
@Override
removeback to summary
public void remove()

Implements java.util.ListIterator.remove.

Doc from java.util.ListIterator.remove.

Removes from the list the last element that was returned by next or previous (optional operation). This call can only be made once per call to next or previous. It can be made only if add has not been called after the last call to next or previous.

Annotations
@Override
setback to summary
public void set(HttpField field)

Implements java.util.ListIterator.set.

Doc from java.util.ListIterator.set.

Replaces the last element returned by next or previous with the specified element (optional operation). This call can be made only if neither remove nor add have been called after the last call to next or previous.

Parameters
field:HttpField

the element with which to replace the last element returned by next or previous

Annotations
@Override