public class

BasicHeaderIterator

extends Object
implements HeaderIterator
java.lang.Object
   ↳ org.apache.http.message.BasicHeaderIterator

Class Overview

Basic implementation of a HeaderIterator.

Summary

Fields
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.
Public Constructors
BasicHeaderIterator(Header[] headers, String name)
Creates a new header iterator.
Public Methods
boolean hasNext()
Indicates whether there is another header in this iteration.
final Object next()
Returns the next header.
Header nextHeader()
Obtains the next header from this iteration.
void remove()
Removing headers is not supported.
Protected Methods
boolean filterHeader(int index)
Checks whether a header is part of the iteration.
int findNext(int from)
Determines the index of the next header.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.http.HeaderIterator

Fields

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.

protected int currentIndex

The position of the next header in allHeaders. Negative if the iteration is over.

protected String headerName

The header name to filter by. null to iterate over all headers in the array.

Public Constructors

public BasicHeaderIterator (Header[] headers, String name)

Creates a new header iterator.

Parameters
headers an array of headers over which to iterate
name the name of the headers over which to iterate, or null for any

Public Methods

public boolean hasNext ()

Indicates whether there is another header in this iteration.

Returns
  • true if there is another header, false otherwise

public final Object next ()

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

Returns
  • the next header in this iteration
Throws
NoSuchElementException if there are no more headers

public Header nextHeader ()

Obtains the next header from this iteration.

Returns
  • the next header in this iteration
Throws
NoSuchElementException if there are no more headers

public void remove ()

Removing headers is not supported.

Throws
UnsupportedOperationException always

Protected Methods

protected boolean filterHeader (int index)

Checks whether a header is part of the iteration.

Parameters
index the index of the header to check
Returns
  • true if the header should be part of the iteration, false to skip

protected int findNext (int from)

Determines the index of the next header.

Parameters
from one less than the index to consider first, -1 to search for the first header
Returns
  • the index of the next header that matches the filter name, or negative if there are no more headers