javax.print.attribute: abstract public class: EnumSyntax

javax.print.attribute
abstract public class: EnumSyntax [javadoc | source]

java.lang.Object
   javax.print.attribute.EnumSyntax

All Implemented Interfaces:
Cloneable, Serializable

Class EnumSyntax is an abstract base class providing the common implementation of all "type safe enumeration" objects. An enumeration class (which extends class EnumSyntax) provides a group of enumeration values (objects) that are singleton instances of the enumeration class; for example:

    public class Bach extends EnumSyntax {
        public static final Bach JOHANN_SEBASTIAN     = new Bach(0);
        public static final Bach WILHELM_FRIEDEMANN   = new Bach(1);
        public static final Bach CARL_PHILIP_EMMANUEL = new Bach(2);
        public static final Bach JOHANN_CHRISTIAN     = new Bach(3);
        public static final Bach P_D_Q                = new Bach(4);

        private static final String[] stringTable = {
            "Johann Sebastian Bach",
             "Wilhelm Friedemann Bach",
             "Carl Philip Emmanuel Bach",
             "Johann Christian Bach",
             "P.D.Q. Bach"
        };

        protected String[] getStringTable() {
            return stringTable;
        }

        private static final Bach[] enumValueTable = {
            JOHANN_SEBASTIAN,
             WILHELM_FRIEDEMANN,
             CARL_PHILIP_EMMANUEL,
             JOHANN_CHRISTIAN,
             P_D_Q
        };

        protected EnumSyntax[] getEnumValueTable() {
            return enumValueTable;
        }
    }

You can then write code that uses the == and != operators to test enumeration values; for example:

    Bach theComposer;
    . . .
    if (theComposer == Bach.JOHANN_SEBASTIAN) {
        System.out.println ("The greatest composer of all time!");
    }

The equals() method for an enumeration class just does a test for identical objects (==).

You can convert an enumeration value to a string by calling toString() . The string is obtained from a table supplied by the enumeration class.

Under the hood, an enumeration value is just an integer, a different integer for each enumeration value within an enumeration class. You can get an enumeration value's integer value by calling getValue() . An enumeration value's integer value is established when it is constructed (see EnumSyntax(int) ). Since the constructor is protected, the only possible enumeration values are the singleton objects declared in the enumeration class; additional enumeration values cannot be created at run time.

You can define a subclass of an enumeration class that extends it with additional enumeration values. The subclass's enumeration values' integer values need not be distinct from the superclass's enumeration values' integer values; the ==, !=, equals(), and toString() methods will still work properly even if the subclass uses some of the same integer values as the superclass. However, the application in which the enumeration class and subclass are used may need to have distinct integer values in the superclass and subclass.

author: David - Mendenhall

author: Alan - Kaminsky

Constructor:

Constructor:
protected EnumSyntax(int value) { this.value = value; } Construct a new enumeration value with the given integer value. Parameters: `value` - Integer value.

 protected EnumSyntax(int value) {
        this.value = value;
}

Construct a new enumeration value with the given integer value.

Parameters:

value - Integer value.

Method from javax.print.attribute.EnumSyntax Summary:
clone, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.EnumSyntax Detail:
public Object clone() { return this; } Returns a clone of this enumeration value, which to preserve the semantics of enumeration values is the same object as this enumeration value.
protected EnumSyntax[] getEnumValueTable() { return null; } Returns the enumeration value table for this enumeration value's enumeration class. The enumeration class's integer values are assumed to lie in the range L..L+N-1, where L is the value returned by `getOffset()` and N is the length of the enumeration value table. The element in the enumeration value table at index i-L is the enumeration value object whose integer value is i; the `readResolve()` method needs this to preserve singleton semantics during deserialization of an enumeration instance. If an integer within the above range is not used by any enumeration value, leave the corresponding table element null. The default implementation returns null. If the enumeration class (a subclass of class EnumSyntax) does not override this method to return a non-null enumeration value table, and the subclass does not override the `readResolve()` method, the base class `readResolve()` method will throw an exception whenever an enumeration instance is deserialized from an object input stream.
protected int getOffset() { return 0; } Returns the lowest integer value used by this enumeration value's enumeration class. The default implementation returns 0. If the enumeration class (a subclass of class EnumSyntax) uses integer values starting at other than 0, override this method in the subclass.
protected String[] getStringTable() { return null; } Returns the string table for this enumeration value's enumeration class. The enumeration class's integer values are assumed to lie in the range L..L+N-1, where L is the value returned by `getOffset()` and N is the length of the string table. The element in the string table at index i-L is the value returned by `toString()` for the enumeration value whose integer value is i. If an integer within the above range is not used by any enumeration value, leave the corresponding table element null. The default implementation returns null. If the enumeration class (a subclass of class EnumSyntax) does not override this method to return a non-null string table, and the subclass does not override the `toString()` method, the base class `toString()` method will return just a string representation of this enumeration value's integer value.
public int getValue() { return value; } Returns this enumeration value's integer value.
public int hashCode() { return value; } Returns a hash code value for this enumeration value. The hash code is just this enumeration value's integer value.
protected Object readResolve() throws ObjectStreamException { EnumSyntax[] theTable = getEnumValueTable(); if (theTable == null) { throw new InvalidObjectException( "Null enumeration value table for class " + getClass()); } int theOffset = getOffset(); int theIndex = value - theOffset; if (0 > theIndex \|\| theIndex >= theTable.length) { throw new InvalidObjectException ("Integer value = " + value + " not in valid range " + theOffset + ".." + (theOffset + theTable.length - 1) + "for class " + getClass()); } EnumSyntax result = theTable[theIndex]; if (result == null) { throw new InvalidObjectException ("No enumeration value for integer value = " + value + "for class " + getClass()); } return result; } During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.
public String toString() { String[] theTable = getStringTable(); int theIndex = value - getOffset(); return theTable != null && theIndex >= 0 && theIndex < theTable.length ? theTable[theIndex] : Integer.toString (value); } Returns a string value corresponding to this enumeration value.

Method from javax.print.attribute.EnumSyntax Detail:

 public Object clone() {
        return this;
}

Returns a clone of this enumeration value, which to preserve the semantics of enumeration values is the same object as this enumeration value.

 protected EnumSyntax[] getEnumValueTable() {
        return null;
}

getOffset()

readResolve()

The default implementation returns null. If the enumeration class (a subclass of class EnumSyntax) does not override this method to return a non-null enumeration value table, and the subclass does not override the readResolve() method, the base class readResolve() method will throw an exception whenever an enumeration instance is deserialized from an object input stream.

 protected int getOffset() {
        return 0;
}

The default implementation returns 0. If the enumeration class (a subclass of class EnumSyntax) uses integer values starting at other than 0, override this method in the subclass.

 protected String[] getStringTable() {
        return null;
}

getOffset()

toString()

The default implementation returns null. If the enumeration class (a subclass of class EnumSyntax) does not override this method to return a non-null string table, and the subclass does not override the toString() method, the base class toString() method will return just a string representation of this enumeration value's integer value.

 public int getValue() {
        return value;
}

Returns this enumeration value's integer value.

 public int hashCode() {
        return value;
}

Returns a hash code value for this enumeration value. The hash code is just this enumeration value's integer value.

 protected Object readResolve() throws ObjectStreamException {
        EnumSyntax[] theTable = getEnumValueTable();
        if (theTable == null) {
            throw new InvalidObjectException(
                                "Null enumeration value table for class " +
                                getClass());
        }
        int theOffset = getOffset();
        int theIndex = value - theOffset;
        if (0  > theIndex || theIndex  >= theTable.length) {
            throw new InvalidObjectException
                ("Integer value = " +  value + " not in valid range " +
                 theOffset + ".." + (theOffset + theTable.length - 1) +
                 "for class " + getClass());
        }
        EnumSyntax result = theTable[theIndex];
        if (result == null) {
            throw new InvalidObjectException
                ("No enumeration value for integer value = " +
                 value + "for class " + getClass());
        }
        return result;
}

During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.

 public String toString() {
        String[] theTable = getStringTable();
        int theIndex = value - getOffset();
        return
            theTable != null && theIndex  >= 0 && theIndex <  theTable.length ?
            theTable[theIndex] :
            Integer.toString (value);
}

Returns a string value corresponding to this enumeration value.