Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItemIterator

pack-priv Class PDOutlineItemIterator

extends Object
implements Iterator<PDOutlineItem>

Class Inheritance

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItemIterator

All Implemented Interfaces

java.util.Iterator

Imports

java.util.Iterator, .NoSuchElementException

Iterator over the linked list of PDOutlineItem siblings.

Author

Andrea Vacondio

Field Summary

Modifier and Type	Field and Description
private PDOutlineItem	currentItem
private final PDOutlineItem	startingItem

Constructor Summary

Access	Constructor and Description
pack-priv	PDOutlineItemIterator(PDOutlineItem startingItem)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public PDOutlineItem	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Field Detail

currentItem	back to summary
private PDOutlineItem currentItem

startingItem	back to summary
private final PDOutlineItem startingItem

Constructor Detail

PDOutlineItemIterator	back to summary
pack-priv PDOutlineItemIterator(PDOutlineItem startingItem)

Method Detail

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 PDOutlineItem next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:PDOutlineItem the next element in the iteration Annotations @Override

back to summary

public PDOutlineItem next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:PDOutlineItem

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override