Package com.priint.pubserver.metadata.base

Enum Scope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Scope>
    public enum Scope
extends java.lang.Enum<Scope>

    Values for the document.ref XML attribute.

    Values for the document.ref XML attribute. Currently referred in the Document interface only.
    Scope describes the region of the document, which is covered by a XML document. This could be the entire document (DOCUMENT) or a single frame (ELEMENT) or any other of the values defined by this enumeration.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Scope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Scope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • UNDEFINED

        public static final Scope UNDEFINED

        The scope is undefined.

      • DOCUMENT

        public static final Scope DOCUMENT

        entire document

      • SPREAD

        public static final Scope SPREAD

        spread, i.e. one or several pages

      • PAGE

        public static final Scope PAGE

        single page

      • GROUP

        public static final Scope GROUP

        a comet group

      • ELEMENT

        public static final Scope ELEMENT

        an element, i.e. text or graphic frame

      • PLACEHOLDER

        public static final Scope PLACEHOLDER

        a placeholder

    • Method Detail

      • values

        public static Scope[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Scope c : Scope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Scope valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null