Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.message.BasicHeaderIterator

Modifier and Type	Field and Description
private final Header[]	allHeaders An array of headers to iterate over.
private int	currentIndex The position of the next header in `allHeaders`.
private final 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
private 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.
private 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 java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Header	Returns: the next header in this iteration next() Implements java.util.Iterator.next. 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
private 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
private int currentIndex The position of the next header in `allHeaders`. Negative if the iteration is over.

headerName	back to summary
private final 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
private 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

private 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
private 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

private 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 java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public Header next() throws NoSuchElementException Implements java.util.Iterator.next. 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

back to summary

public Header next() throws NoSuchElementException

Implements java.util.Iterator.next.

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