public Class PDFieldTree

The field tree.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	PDFieldTree.FieldIterator Iterator which walks all fields in the tree, in order.

Field Summary

Modifier and Type	Field and Description
private final PDAcroForm	acroForm
private static final Log	LOG

Constructor Summary

Access	Constructor and Description
public	PDFieldTree(PDAcroForm the AcroForm containing the fields. acroForm) Constructor for reading.

Modifier and Type	Method and Description
public Iterator<PDField>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator which walks all fields in the tree, in order.

Modifier and Type

Method and Description

public Iterator<PDField>

iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator which walks all fields in the tree, in order.

Field Detail

acroForm	back to summary
private final PDAcroForm acroForm

LOG	back to summary
private static final Log LOG

Constructor Detail

PDFieldTree	back to summary
public PDFieldTree(PDAcroForm acroForm) Constructor for reading. Parameters acroForm:PDAcroForm the AcroForm containing the fields.

PDFieldTree

back to summary

public PDFieldTree(PDAcroForm acroForm)

Constructor for reading.

Parameters

acroForm:PDAcroForm: the AcroForm containing the fields.

Method Detail

iterator	back to summary
public Iterator<PDField> iterator() Implements java.lang.Iterable.iterator. Returns an iterator which walks all fields in the tree, in order. Returns:Iterator<PDField> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override

iterator

back to summary

public Iterator<PDField> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator which walks all fields in the tree, in order.

Returns:Iterator<PDField>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

org.apache.pdfbox.pdmodel.interactive.form back to summary

private final Class PDFieldTree.FieldIterator

Class Inheritance

extends Object
implements Iterator<PDField>

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.form.PDFieldTree.FieldIterator

All Implemented Interfaces

java.util.Iterator

Iterator which walks all fields in the tree, in order.

Field Summary

Modifier and Type	Field and Description
private final Queue<PDField>	queue
private final Set<COSDictionary>	set

Constructor Summary

Access	Constructor and Description
private	FieldIterator(PDAcroForm form)

Method Summary

Modifier and Type	Method and Description
private void	enqueueKids(PDField node)
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public PDField	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

queue	back to summary
private final Queue<PDField> queue

set	back to summary
private final Set<COSDictionary> set

Constructor Detail

FieldIterator	back to summary
private FieldIterator(PDAcroForm form)

Method Detail

enqueueKids	back to summary
private void enqueueKids(PDField node)

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

back to summary

public PDField next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:PDField

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