001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import java.util.Locale;
028
029 import javax.print.attribute.Attribute;
030 import javax.print.attribute.EnumSyntax;
031 import javax.print.attribute.PrintRequestAttribute;
032 import javax.print.attribute.PrintJobAttribute;
033
034 /**
035 * Class JobSheets is a printing attribute class, an enumeration, that
036 * determines which job start and end sheets, if any, must be printed with a
037 * job. Class JobSheets declares keywords for standard job sheets values.
038 * Implementation- or site-defined names for a job sheets attribute may also be
039 * created by defining a subclass of class JobSheets.
040 * <P>
041 * The effect of a JobSheets attribute on multidoc print jobs (jobs with
042 * multiple documents) may be affected by the {@link MultipleDocumentHandling
043 * MultipleDocumentHandling} job attribute, depending on the meaning of the
044 * particular JobSheets value.
045 * <P>
046 * <B>IPP Compatibility:</B> The category name returned by
047 * <CODE>getName()</CODE> is the IPP attribute name. The
048 * enumeration's integer value is the IPP enum value. The
049 * <code>toString()</code> method returns the IPP string representation of
050 * the attribute value. For a subclass, the attribute value must be
051 * localized to give the IPP name and natural language values.
052 * <P>
053 *
054 * @author Alan Kaminsky
055 */
056 public class JobSheets extends EnumSyntax implements
057 PrintRequestAttribute, PrintJobAttribute {
058
059 private static final long serialVersionUID = -4735258056132519759L;
060
061 /**
062 * No job sheets are printed.
063 */
064 public static final JobSheets NONE = new JobSheets(0);
065
066 /**
067 * One or more site specific standard job sheets are printed. e.g. a
068 * single start sheet is printed, or both start and end sheets are
069 * printed.
070 */
071 public static final JobSheets STANDARD = new JobSheets(1);
072
073 /**
074 * Construct a new job sheets enumeration value with the given integer
075 * value.
076 *
077 * @param value Integer value.
078 */
079 protected JobSheets(int value) {
080 super (value);
081 }
082
083 private static final String[] myStringTable = { "none", "standard" };
084
085 private static final JobSheets[] myEnumValueTable = { NONE,
086 STANDARD };
087
088 /**
089 * Returns the string table for class JobSheets.
090 */
091 protected String[] getStringTable() {
092 return (String[]) myStringTable.clone();
093 }
094
095 /**
096 * Returns the enumeration value table for class JobSheets.
097 */
098 protected EnumSyntax[] getEnumValueTable() {
099 return (EnumSyntax[]) myEnumValueTable.clone();
100 }
101
102 /**
103 * Get the printing attribute class which is to be used as the "category"
104 * for this printing attribute value.
105 * <P>
106 * For class JobSheets and any vendor-defined subclasses, the category is
107 * class JobSheets itself.
108 *
109 * @return Printing attribute class (category), an instance of class
110 * {@link java.lang.Class java.lang.Class}.
111 */
112 public final Class<? extends Attribute> getCategory() {
113 return JobSheets.class;
114 }
115
116 /**
117 * Get the name of the category of which this attribute value is an
118 * instance.
119 * <P>
120 * For class JobSheets and any vendor-defined subclasses, the category
121 * name is <CODE>"job-sheets"</CODE>.
122 *
123 * @return Attribute category name.
124 */
125 public final String getName() {
126 return "job-sheets";
127 }
128
129 }
|