com.itextpdf.kernel.xmp.options

Class IteratorOptions

java.lang.Object

com.itextpdf.kernel.xmp.options.Options

com.itextpdf.kernel.xmp.options.IteratorOptions

public final class IteratorOptions
extends Options

Options for XMPIterator construction.

Since:

24.01.2006

Field Summary

Fields

Modifier and Type	Field and Description
static int	JUST_CHILDREN Just do the immediate children of the root, default is subtree.
static int	JUST_LEAFNAME Return just the leaf part of the path, default is the full path.
static int	JUST_LEAFNODES Just do the leaf nodes, default is all nodes in the subtree.
static int	OMIT_QUALIFIERS Omit all qualifiers.

Constructor Summary

Constructors

Constructor and Description
IteratorOptions()

Method Summary

Modifier and Type	Method and Description
protected String	defineOptionName(int option) To be implemeted by inheritants.
protected int	getValidOptions() To be implemeted by inheritants.
boolean	isJustChildren()
boolean	isJustLeafname()
boolean	isJustLeafnodes()
boolean	isOmitQualifiers()
IteratorOptions	setJustChildren(boolean value) Sets the option and returns the instance.
IteratorOptions	setJustLeafname(boolean value) Sets the option and returns the instance.
IteratorOptions	setJustLeafnodes(boolean value) Sets the option and returns the instance.
IteratorOptions	setOmitQualifiers(boolean value) Sets the option and returns the instance.

Methods inherited from class com.itextpdf.kernel.xmp.options.Options

assertConsistency, clear, containsAllOptions, containsOneOf, equals, getOption, getOptions, getOptionsString, hashCode, isExactly, setOption, setOptions, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JUST_CHILDREN

public static final int JUST_CHILDREN

Just do the immediate children of the root, default is subtree.

See Also:

Constant Field Values

JUST_LEAFNODES

public static final int JUST_LEAFNODES

Just do the leaf nodes, default is all nodes in the subtree. Bugfix #2658965: If this option is set the Iterator returns the namespace of the leaf instead of the namespace of the base property.

See Also:

Constant Field Values

JUST_LEAFNAME

public static final int JUST_LEAFNAME

Return just the leaf part of the path, default is the full path.

See Also:

Constant Field Values

OMIT_QUALIFIERS

public static final int OMIT_QUALIFIERS

Omit all qualifiers.

See Also:

Constant Field Values

Constructor Detail

IteratorOptions

public IteratorOptions()

Method Detail

isJustChildren

public boolean isJustChildren()

Returns:

Returns whether the option is set.

isJustLeafname

public boolean isJustLeafname()

Returns:

Returns whether the option is set.

isJustLeafnodes

public boolean isJustLeafnodes()

Returns:

Returns whether the option is set.

isOmitQualifiers

public boolean isOmitQualifiers()

Returns:

Returns whether the option is set.

setJustChildren

public IteratorOptions setJustChildren(boolean value)

Sets the option and returns the instance.

Parameters:

value - the value to set

Returns:

Returns the instance to call more set-methods.

setJustLeafname

public IteratorOptions setJustLeafname(boolean value)

Sets the option and returns the instance.

Parameters:

value - the value to set

Returns:

Returns the instance to call more set-methods.

setJustLeafnodes

public IteratorOptions setJustLeafnodes(boolean value)

Sets the option and returns the instance.

Parameters:

value - the value to set

Returns:

Returns the instance to call more set-methods.

setOmitQualifiers

public IteratorOptions setOmitQualifiers(boolean value)

Sets the option and returns the instance.

Parameters:

value - the value to set

Returns:

Returns the instance to call more set-methods.

defineOptionName

protected String defineOptionName(int option)

Description copied from class: Options

To be implemeted by inheritants.

Specified by:

defineOptionName in class Options

Parameters:

option - a single, valid option bit.

Returns:

Returns a human readable name for an option bit.

See Also:

Options.defineOptionName(int)

getValidOptions

protected int getValidOptions()

Description copied from class: Options

To be implemeted by inheritants.

Specified by:

getValidOptions in class Options

Returns:

Returns a bit mask where all valid option bits are set.

See Also:

Options.getValidOptions()