org.apache.http.message

Class BasicHeaderIterator

java.lang.Object

org.apache.http.message.BasicHeaderIterator

All Implemented Interfaces:

Iterator<Object>, HeaderIterator

public class BasicHeaderIterator
extends Object
implements HeaderIterator

Basic implementation of a HeaderIterator.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
BasicHeaderIterator(Header[] headers, String name) Creates a new header iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Indicates whether there is another header in this iteration.
Object	next() Returns the next header.
Header	nextHeader() Obtains the next header from this iteration.
void	remove() Removing headers is not supported.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

BasicHeaderIterator

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

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: HeaderIterator

Indicates whether there is another header in this iteration.

Specified by:

hasNext in interface Iterator<Object>

Specified by:

hasNext in interface HeaderIterator

Returns:

true if there is another header, false otherwise

nextHeader

public Header nextHeader()
                  throws NoSuchElementException

Obtains the next header from this iteration.

Specified by:

nextHeader in interface HeaderIterator

Returns:

the next header in this iteration

Throws:

NoSuchElementException - if there are no more headers

next

public final Object next()
                  throws NoSuchElementException

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

Specified by:

next in interface Iterator<Object>

Returns:

the next header in this iteration

Throws:

NoSuchElementException - if there are no more headers

remove

public void remove()
            throws UnsupportedOperationException

Removing headers is not supported.

Specified by:

remove in interface Iterator<Object>

Throws:

UnsupportedOperationException - always