Package com.itextpdf.kernel.xmp.impl

Class XMPIteratorImpl

java.lang.Object

com.itextpdf.kernel.xmp.impl.XMPIteratorImpl

All Implemented Interfaces:

XMPIterator, Iterator

       public class XMPIteratorImpl extends Object implements XMPIterator
      

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipSiblings	flag to indicate that skipSiblings() has been called.
protected boolean	skipSubtree	flag to indicate that skipSiblings() has been called.

Constructor Summary

Constructors

Constructor	Description
XMPIteratorImpl(XMPMetaImpl xmp, String schemaNS, String propPath, IteratorOptions options)	Constructor with optionsl initial values.

Method Summary

Modifier and Type	Method	Description
protected String	getBaseNS()
protected IteratorOptions	getOptions()
boolean	hasNext()
Object	next()
void	remove()
protected void	setBaseNS(String baseNS)
void	skipSiblings()	Skip the subtree below and remaining siblings of the current node when next() is called.
void	skipSubtree()	Skip the subtree below the current node when next() 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

skipSiblings

             protected boolean skipSiblings
            

flag to indicate that skipSiblings() has been called.

skipSubtree

             protected boolean skipSubtree
            

flag to indicate that skipSiblings() has been called.

Constructor Details

XMPIteratorImpl

             public XMPIteratorImpl
             (XMPMetaImpl xmp, String schemaNS, String propPath, IteratorOptions options) throws XMPException
            

Constructor with optionsl initial values. If propName 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 the schemaNS

options - advanced iteration options, see IteratorOptions

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 when next() is called.

Specified by:

skipSubtree in interface XMPIterator

See Also:

• XMPIterator.skipSubtree()

skipSiblings

             public void skipSiblings()
            

Description copied from interface: XMPIterator

Skip the subtree below and remaining siblings of the current node when next() is called.

Specified by:

skipSiblings in interface XMPIterator

See Also:

• XMPIterator.skipSiblings()

hasNext

             public boolean hasNext()
            

Specified by:

hasNext in interface Iterator

See Also:

• Iterator.hasNext()

next

             public Object next()
            

Specified by:

next in interface Iterator

See Also:

• Iterator.next()

remove

             public void remove()
            

Specified by:

remove in interface Iterator

See Also:

• Iterator.remove()

getOptions

             protected IteratorOptions getOptions()
            

Returns:

Exposes the options for inner class.

getBaseNS

             protected String getBaseNS()
            

Returns:

Exposes the options for inner class.

setBaseNS

             protected void setBaseNS
             (String baseNS)
            

Parameters:

baseNS - sets the baseNS from the inner class.