javax.print.attribute

Class EnumSyntax

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
Chromaticity, ColorSupported, Compression, Fidelity, Finishings, JobSheets, JobState, JobStateReason, Media, MultipleDocumentHandling, OrientationRequested, PDLOverrideSupported, PresentationDirection, PrinterIsAcceptingJobs, PrinterState, PrinterStateReason, PrintQuality, ReferenceUriSchemesSupported, Severity, SheetCollate, Sides

public abstract class EnumSyntax
extends Object
implements Cloneable, Serializable

EnumSyntax is the abstract base class of all enumeration classes in the Java Print Service API.

Every enumeration class which extends from EnumSyntax provides several enumeration objects as singletons of its class.

Notes for implementing subclasses:

Example:
 public class PrinterState extends EnumSyntax
 {
   public static final PrinterState IDLE = new PrinterState(1);
   public static final PrinterState PROCESSING = new PrinterState(2);
   public static final PrinterState STOPPED = new PrinterState(3);

   protected PrinterState(int value)
   {
     super(value);
   }

   // Overridden because values start not at zero !
   protected int getOffset()
   {
     return 1;
   }

   private static final String[] stringTable = { "idle", "processing",
                                                 "stopped" };

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

   private static final PrinterState[] enumValueTable = { IDLE,
                                             PROCESSING, STOPPED};

   protected EnumSyntax[] getEnumValueTable()
   {
     return enumValueTable;
   }
 }
 
See Also:
Serialized Form

Constructor Summary

EnumSyntax(int value)
Creates a EnumSyntax object.

Method Summary

Object
clone()
Clones this object.
protected EnumSyntax[]
getEnumValueTable()
Returns a table with the enumeration values for this object.
protected int
getOffset()
Returns the lowest used value by the enumerations of this class.
protected String[]
getStringTable()
Returns a table with the enumeration values represented as strings for this object.
int
getValue()
Returns the value of this enumeration object.
int
hashCode()
Returns the hashcode for this object.
protected Object
readResolve()
Needed for singelton semantics during deserialisation.
String
toString()
Returns the string representation for this object.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnumSyntax

protected EnumSyntax(int value)
Creates a EnumSyntax object.
Parameters:
value - the value to set.

Method Details

clone

public Object clone()
Clones this object.
Overrides:
clone in interface Object
Returns:
A clone of this object.

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns a table with the enumeration values for this object. The default implementation just returns null. Subclasses have to to override this method for serialization.
Returns:
The enumeration values.

getOffset

protected int getOffset()
Returns the lowest used value by the enumerations of this class. The default implementation returns 0. This is enough if enumerations start with a zero value. Otherwise subclasses need to override this method for serialization and return the lowest value they use. .
Returns:
The lowest used value used.

getStringTable

protected String[] getStringTable()
Returns a table with the enumeration values represented as strings for this object. The default implementation just returns null. Subclasses should override this method.
Returns:
The enumeration values as strings.

getValue

public int getValue()
Returns the value of this enumeration object.
Returns:
The value.

hashCode

public int hashCode()
Returns the hashcode for this object. The hashcode is the value of this enumeration object.
Overrides:
hashCode in interface Object
Returns:
The hashcode.

readResolve

protected Object readResolve()
            throws ObjectStreamException
Needed for singelton semantics during deserialisation. Subclasses must not override this class. Subclasses have to override getEnumValueTable() and should override getStringTable() for correct serialization.
Returns:
The Object at index value - getOffset() in getEnumValueTable.
Throws:
ObjectStreamException - if getEnumValueTable() returns null.

toString

public String toString()
Returns the string representation for this object. The string value from getStringTable() method is returned if subclasses override this method. Otherwise the value of this object as a string is returned.
Overrides:
toString in interface Object
Returns:
The string representation.

EnumSyntax.java -- Copyright (C) 2003, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.