Package com.itextpdf.kernel.xmp.impl
Class XMPIteratorImpl
java.lang.Object
com.itextpdf.kernel.xmp.impl.XMPIteratorImpl
- All Implemented Interfaces:
XMPIterator
,Iterator
The
XMPIterator
implementation.
Iterates the XMP Tree according to a set of options.
During the iteration the XMPMeta-object must not be changed.
Calls to skipSubtree()
/ skipSiblings()
will affect the iteration.- Since:
- 29.06.2006
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
TheXMPIterator
implementation.private class
This iterator is derived from the defaultNodeIterator
, and is only used for the optionIteratorOptions.JUST_CHILDREN
. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
the base namespace of the property path, will be changed during the iterationprivate Iterator
the node iterator doing the workprivate IteratorOptions
stores the iterator optionsprotected boolean
flag to indicate that skipSiblings() has been called.protected boolean
flag to indicate that skipSiblings() has been called. -
Constructor Summary
ConstructorsConstructorDescriptionXMPIteratorImpl
(XMPMetaImpl xmp, String schemaNS, String propPath, IteratorOptions options) Constructor with optionsl initial values. -
Method Summary
Modifier and TypeMethodDescriptionprotected String
protected IteratorOptions
boolean
hasNext()
next()
void
remove()
protected void
void
Skip the subtree below and remaining siblings of the current node whennext()
is called.void
Skip the subtree below the current node whennext()
is called.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
options
stores the iterator options -
baseNS
the base namespace of the property path, will be changed during the iteration -
skipSiblings
protected boolean skipSiblingsflag to indicate that skipSiblings() has been called. -
skipSubtree
protected boolean skipSubtreeflag to indicate that skipSiblings() has been called. -
nodeIterator
the node iterator doing the work
-
-
Constructor Details
-
XMPIteratorImpl
public XMPIteratorImpl(XMPMetaImpl xmp, String schemaNS, String propPath, IteratorOptions options) throws XMPException Constructor with optionsl initial values. IfpropName
is provided,schemaNS
has also be provided.- Parameters:
xmp
- the iterated metadata object.schemaNS
- the iteration is reduced to this schema (optional)propPath
- the iteration is redurce to this property within theschemaNS
options
- advanced iteration options, seeIteratorOptions
- Throws:
XMPException
- If the node defined by the paramters is not existing.
-
-
Method Details
-
skipSubtree
public void skipSubtree()Description copied from interface:XMPIterator
Skip the subtree below the current node whennext()
is called.- Specified by:
skipSubtree
in interfaceXMPIterator
- See Also:
-
skipSiblings
public void skipSiblings()Description copied from interface:XMPIterator
Skip the subtree below and remaining siblings of the current node whennext()
is called.- Specified by:
skipSiblings
in interfaceXMPIterator
- See Also:
-
hasNext
public boolean hasNext() -
next
-
remove
public void remove() -
getOptions
- Returns:
- Exposes the options for inner class.
-
getBaseNS
- Returns:
- Exposes the options for inner class.
-
setBaseNS
- Parameters:
baseNS
- sets the baseNS from the inner class.
-