javax.print.attribute
Class EnumSyntax

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.EnumSyntax
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable
Direct Known Subclasses:
Chromaticity sample code for javax.print.attribute.standard.Chromaticity definition code for javax.print.attribute.standard.Chromaticity , ColorSupported sample code for javax.print.attribute.standard.ColorSupported definition code for javax.print.attribute.standard.ColorSupported , Compression sample code for javax.print.attribute.standard.Compression definition code for javax.print.attribute.standard.Compression , Fidelity sample code for javax.print.attribute.standard.Fidelity definition code for javax.print.attribute.standard.Fidelity , Finishings sample code for javax.print.attribute.standard.Finishings definition code for javax.print.attribute.standard.Finishings , JobSheets sample code for javax.print.attribute.standard.JobSheets definition code for javax.print.attribute.standard.JobSheets , JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState , JobStateReason sample code for javax.print.attribute.standard.JobStateReason definition code for javax.print.attribute.standard.JobStateReason , Media sample code for javax.print.attribute.standard.Media definition code for javax.print.attribute.standard.Media , MultipleDocumentHandling sample code for javax.print.attribute.standard.MultipleDocumentHandling definition code for javax.print.attribute.standard.MultipleDocumentHandling , OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested , PDLOverrideSupported sample code for javax.print.attribute.standard.PDLOverrideSupported definition code for javax.print.attribute.standard.PDLOverrideSupported , PresentationDirection sample code for javax.print.attribute.standard.PresentationDirection definition code for javax.print.attribute.standard.PresentationDirection , PrinterIsAcceptingJobs sample code for javax.print.attribute.standard.PrinterIsAcceptingJobs definition code for javax.print.attribute.standard.PrinterIsAcceptingJobs , PrinterState sample code for javax.print.attribute.standard.PrinterState definition code for javax.print.attribute.standard.PrinterState , PrinterStateReason sample code for javax.print.attribute.standard.PrinterStateReason definition code for javax.print.attribute.standard.PrinterStateReason , PrintQuality sample code for javax.print.attribute.standard.PrintQuality definition code for javax.print.attribute.standard.PrintQuality , ReferenceUriSchemesSupported sample code for javax.print.attribute.standard.ReferenceUriSchemesSupported definition code for javax.print.attribute.standard.ReferenceUriSchemesSupported , Severity sample code for javax.print.attribute.standard.Severity definition code for javax.print.attribute.standard.Severity , SheetCollate sample code for javax.print.attribute.standard.SheetCollate definition code for javax.print.attribute.standard.SheetCollate , Sides sample code for javax.print.attribute.standard.Sides definition code for javax.print.attribute.standard.Sides

public abstract class EnumSyntax
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

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() sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.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() sample code for javax.print.attribute.EnumSyntax.getValue() definition code for javax.print.attribute.EnumSyntax.getValue() . An enumeration value's integer value is established when it is constructed (see EnumSyntax(int) sample code for javax.print.attribute.EnumSyntax.EnumSyntax(int) definition code for javax.print.attribute.EnumSyntax.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.

See Also:
Serialized Form

Constructor Summary
protected EnumSyntax sample code for javax.print.attribute.EnumSyntax.EnumSyntax(int) definition code for javax.print.attribute.EnumSyntax.EnumSyntax(int) (int value)
          Construct a new enumeration value with the given integer value.
 
Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for javax.print.attribute.EnumSyntax.clone() definition code for javax.print.attribute.EnumSyntax.clone() ()
          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 sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable sample code for javax.print.attribute.EnumSyntax.getEnumValueTable() definition code for javax.print.attribute.EnumSyntax.getEnumValueTable() ()
          Returns the enumeration value table for this enumeration value's enumeration class.
protected  int getOffset sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.getOffset() ()
          Returns the lowest integer value used by this enumeration value's enumeration class.
protected  String sample code for java.lang.String definition code for java.lang.String [] getStringTable sample code for javax.print.attribute.EnumSyntax.getStringTable() definition code for javax.print.attribute.EnumSyntax.getStringTable() ()
          Returns the string table for this enumeration value's enumeration class.
 int getValue sample code for javax.print.attribute.EnumSyntax.getValue() definition code for javax.print.attribute.EnumSyntax.getValue() ()
          Returns this enumeration value's integer value.
 int hashCode sample code for javax.print.attribute.EnumSyntax.hashCode() definition code for javax.print.attribute.EnumSyntax.hashCode() ()
          Returns a hash code value for this enumeration value.
protected  Object sample code for java.lang.Object definition code for java.lang.Object readResolve sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve() ()
          During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString() ()
          Returns a string value corresponding to this enumeration value.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

EnumSyntax sample code for javax.print.attribute.EnumSyntax(int) definition code for javax.print.attribute.EnumSyntax(int)

protected EnumSyntax(int value)
Construct a new enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getValue sample code for javax.print.attribute.EnumSyntax.getValue() definition code for javax.print.attribute.EnumSyntax.getValue()

public int getValue()
Returns this enumeration value's integer value.

Returns:
the value

clone sample code for javax.print.attribute.EnumSyntax.clone() definition code for javax.print.attribute.EnumSyntax.clone()

public Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Returns a clone of this enumeration value, which to preserve the semantics of enumeration values is the same object as this enumeration value.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a clone of this instance.
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

hashCode sample code for javax.print.attribute.EnumSyntax.hashCode() definition code for javax.print.attribute.EnumSyntax.hashCode()

public int hashCode()
Returns a hash code value for this enumeration value. The hash code is just this enumeration value's integer value.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string value corresponding to this enumeration value.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of the object.

readResolve sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve()

protected Object sample code for java.lang.Object definition code for java.lang.Object  readResolve()
                      throws ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException 
During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.

Returns:
The enumeration singleton value stored at index i-L in the enumeration value table returned by getEnumValueTable() sample code for javax.print.attribute.EnumSyntax.getEnumValueTable() definition code for javax.print.attribute.EnumSyntax.getEnumValueTable() , where i is this enumeration value's integer value and L is the value returned by getOffset() sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.getOffset() .
Throws:
ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException - if the stream can't be deserialised
InvalidObjectException sample code for java.io.InvalidObjectException definition code for java.io.InvalidObjectException - Thrown if the enumeration value table is null, this enumeration value's integer value does not correspond to an element in the enumeration value table, or the corresponding element in the enumeration value table is null. (Note: InvalidObjectException sample code for java.io.InvalidObjectException definition code for java.io.InvalidObjectException is a subclass of ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException , which readResolve() is declared to throw.)

getStringTable sample code for javax.print.attribute.EnumSyntax.getStringTable() definition code for javax.print.attribute.EnumSyntax.getStringTable()

protected String sample code for java.lang.String definition code for java.lang.String [] getStringTable()
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() sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.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() sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.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() sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString() method, the base class toString() sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString() method will return just a string representation of this enumeration value's integer value.

Returns:
the string table

getEnumValueTable sample code for javax.print.attribute.EnumSyntax.getEnumValueTable() definition code for javax.print.attribute.EnumSyntax.getEnumValueTable()

protected EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable()
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() sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.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() sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.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() sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve() method, the base class readResolve() sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve() method will throw an exception whenever an enumeration instance is deserialized from an object input stream.

Returns:
the value table

getOffset sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.getOffset()

protected int getOffset()
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.

Returns:
the offset of the lowest enumeration value.