Apache HttpCore 4.4.16 · org.apache.http.message.BasicHeaderIterator

Modifier and Type	Field and Description
protected final Header[]	allHeaders An array of headers to iterate over.
protected int	currentIndex The position of the next header in `allHeaders`.
protected String	headerName The header name to filter by.

Access	Constructor and Description
public	BasicHeaderIterator(final Header[] an array of headers over which to iterate headers, final String the name of the headers over which to iterate, or `null` for any name) Creates a new header iterator.

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if the header should be part of the iteration, `false` to skip filterHeader(final int the index of the header to check index) Checks whether a header is part of the iteration.
protected int	Returns: the index of the next header that matches the filter name, or negative if there are no more headers findNext(final int one less than the index to consider first, -1 to search for the first header pos) Determines the index of the next header.
public boolean	hasNext() Implements org.apache.http.HeaderIterator.hasNext. Indicates whether there is another header in this iteration.
public final Object	Returns: the next header in this iteration next() Implements java.util.Iterator.next. Returns the next header.
public Header	Returns: the next header in this iteration nextHeader() Implements org.apache.http.HeaderIterator.nextHeader. Obtains the next header from this iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removing headers is not supported.

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

Field Detail

allHeaders	back to summary
protected final Header[] allHeaders An array of headers to iterate over. Not all elements of this array are necessarily part of the iteration. This array will never be modified by the iterator. Derived implementations are expected to adhere to this restriction.

currentIndex	back to summary
protected int currentIndex The position of the next header in `allHeaders`. Negative if the iteration is over.

headerName	back to summary
protected String headerName The header name to filter by. `null` to iterate over all headers in the array.

Constructor Detail

BasicHeaderIterator back to summary

BasicHeaderIterator	back to summary
public BasicHeaderIterator(final Header[] headers, final String name) Creates a new header iterator. Parameters headers:Header[] an array of headers over which to iterate name:String the name of the headers over which to iterate, or `null` for any

public BasicHeaderIterator(final Header[] headers, final String name)

Creates a new header iterator.

Parameters

headers:Header[]: an array of headers over which to iterate
name:String: the name of the headers over which to iterate, or null for any

Method Detail

filterHeader back to summary

filterHeader	back to summary
protected boolean filterHeader(final int index) Checks whether a header is part of the iteration. Parameters index:int the index of the header to check Returns:boolean `true` if the header should be part of the iteration, `false` to skip

protected boolean filterHeader(final int index)

Checks whether a header is part of the iteration.

Parameters

index:int: the index of the header to check

Returns:boolean

true if the header should be part of the iteration, false to skip

findNext	back to summary
protected int findNext(final int pos) Determines the index of the next header. Parameters pos:int one less than the index to consider first, -1 to search for the first header Returns:int the index of the next header that matches the filter name, or negative if there are no more headers

findNext

back to summary

protected int findNext(final int pos)

Determines the index of the next header.

Parameters

pos:int: one less than the index to consider first, -1 to search for the first header

Returns:int

the index of the next header that matches the filter name, or negative if there are no more headers

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements org.apache.http.HeaderIterator.hasNext. Doc from org.apache.http.HeaderIterator.hasNext. Indicates whether there is another header in this iteration. Returns:boolean `true` if there is another header, `false` otherwise Annotations @Override

public boolean hasNext()

Implements org.apache.http.HeaderIterator.hasNext.

Doc from org.apache.http.HeaderIterator.hasNext.

Indicates whether there is another header in this iteration.

Returns:boolean

true if there is another header, false otherwise

Annotations

@Override

next back to summary

next	back to summary
public final Object next() throws NoSuchElementException Implements java.util.Iterator.next. Returns the next header. Same as `nextHeader`, but not type-safe. Returns:Object the next header in this iteration Annotations @Override Exceptions NoSuchElementException: if there are no more headers

public final Object next() throws NoSuchElementException

Implements java.util.Iterator.next.

Returns the next header. Same as nextHeader, but not type-safe.

Returns:Object

the next header in this iteration

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no more headers

nextHeader	back to summary
public Header nextHeader() throws NoSuchElementException Implements org.apache.http.HeaderIterator.nextHeader. Obtains the next header from this iteration. Returns:Header the next header in this iteration Annotations @Override Exceptions NoSuchElementException: if there are no more headers

nextHeader

back to summary

public Header nextHeader() throws NoSuchElementException

Implements org.apache.http.HeaderIterator.nextHeader.

Obtains the next header from this iteration.

Returns:Header

the next header in this iteration

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no more headers

remove	back to summary
public void remove() throws UnsupportedOperationException Overrides default java.util.Iterator.remove. Removing headers is not supported. Annotations @Override Exceptions UnsupportedOperationException: always

remove

back to summary

public void remove() throws UnsupportedOperationException

Overrides default java.util.Iterator.remove.

Removing headers is not supported.

Annotations

@Override

Exceptions

UnsupportedOperationException:: always

public Class BasicHeaderIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail