Class IteratorOptions


  • public final class IteratorOptions
    extends Options
    Options for XMPIterator construction.
    Since:
    24.01.2006
    • 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.
        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
      • INCLUDE_ALIASES

        public static final int INCLUDE_ALIASES
        Deprecated.
        it is commonly preferred to work with the base properties
        Include aliases, default is just actual properties. Note: Not supported.
        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.