< prev index next >

src/java.desktop/share/classes/javax/print/attribute/standard/JobState.java

Print this page




  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.EnumSyntax;
  30 import javax.print.attribute.PrintJobAttribute;
  31 
  32 /**
  33  * JobState is a printing attribute class, an enumeration, that identifies
  34  * the current state of a print job. Class JobState defines standard job state
  35  * values. A  Print Service implementation only needs to report those job
  36  * states which are appropriate for the particular implementation; it does not
  37  * have to report every defined job state. The {@link JobStateReasons
  38  * JobStateReasons} attribute augments the JobState attribute to give more
  39  * detailed information about the job in the given job state.
  40  * <P>
  41  * <B>IPP Compatibility:</B> The category name returned by
  42  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's
  43  * integer value is the IPP enum value.  The <code>toString()</code> method
  44  * returns the IPP string representation of the attribute value.
  45  *
  46  * @author  Alan Kaminsky
  47  */
  48 
  49 public class JobState extends EnumSyntax implements PrintJobAttribute {
  50 
  51     private static final long serialVersionUID = 400465010094018920L;
  52 
  53     /**
  54      * The job state is unknown.
  55      */
  56     public static final JobState UNKNOWN = new JobState(0);
  57 
  58     /**
  59      * The job is a candidate to start processing, but is not yet processing.
  60      */
  61     public static final JobState PENDING = new JobState(3);
  62 
  63     /**


 208 
 209     /**
 210      * Get the printing attribute class which is to be used as the "category"
 211      * for this printing attribute value.
 212      * <P>
 213      * For class JobState and any vendor-defined subclasses, the category is
 214      * class JobState itself.
 215      *
 216      * @return  Printing attribute class (category), an instance of class
 217      *          {@link java.lang.Class java.lang.Class}.
 218      */
 219     public final Class<? extends Attribute> getCategory() {
 220         return JobState.class;
 221     }
 222 
 223     /**
 224      * Get the name of the category of which this attribute value is an
 225      * instance.
 226      * <P>
 227      * For class JobState and any vendor-defined subclasses, the category
 228      * name is <CODE>"job-state"</CODE>.
 229      *
 230      * @return  Attribute category name.
 231      */
 232     public final String getName() {
 233         return "job-state";
 234     }
 235 
 236 }


  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.EnumSyntax;
  30 import javax.print.attribute.PrintJobAttribute;
  31 
  32 /**
  33  * JobState is a printing attribute class, an enumeration, that identifies
  34  * the current state of a print job. Class JobState defines standard job state
  35  * values. A  Print Service implementation only needs to report those job
  36  * states which are appropriate for the particular implementation; it does not
  37  * have to report every defined job state. The {@link JobStateReasons
  38  * JobStateReasons} attribute augments the JobState attribute to give more
  39  * detailed information about the job in the given job state.
  40  * <P>
  41  * <B>IPP Compatibility:</B> The category name returned by
  42  * {@code getName()} is the IPP attribute name.  The enumeration's
  43  * integer value is the IPP enum value.  The {@code toString()} method
  44  * returns the IPP string representation of the attribute value.
  45  *
  46  * @author  Alan Kaminsky
  47  */
  48 
  49 public class JobState extends EnumSyntax implements PrintJobAttribute {
  50 
  51     private static final long serialVersionUID = 400465010094018920L;
  52 
  53     /**
  54      * The job state is unknown.
  55      */
  56     public static final JobState UNKNOWN = new JobState(0);
  57 
  58     /**
  59      * The job is a candidate to start processing, but is not yet processing.
  60      */
  61     public static final JobState PENDING = new JobState(3);
  62 
  63     /**


 208 
 209     /**
 210      * Get the printing attribute class which is to be used as the "category"
 211      * for this printing attribute value.
 212      * <P>
 213      * For class JobState and any vendor-defined subclasses, the category is
 214      * class JobState itself.
 215      *
 216      * @return  Printing attribute class (category), an instance of class
 217      *          {@link java.lang.Class java.lang.Class}.
 218      */
 219     public final Class<? extends Attribute> getCategory() {
 220         return JobState.class;
 221     }
 222 
 223     /**
 224      * Get the name of the category of which this attribute value is an
 225      * instance.
 226      * <P>
 227      * For class JobState and any vendor-defined subclasses, the category
 228      * name is {@code "job-state"}.
 229      *
 230      * @return  Attribute category name.
 231      */
 232     public final String getName() {
 233         return "job-state";
 234     }
 235 
 236 }
< prev index next >