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 javax.print.attribute.Attribute;
028 import javax.print.attribute.EnumSyntax;
029 import javax.print.attribute.DocAttribute;
030
031 /**
032 * Class Compression is a printing attribute class, an enumeration, that
033 * specifies how print data is compressed. Compression is an attribute of the
034 * print data (the doc), not of the Print Job. If a Compression attribute is not
035 * specified for a doc, the printer assumes the doc's print data is uncompressed
036 * (i.e., the default Compression value is always {@link #NONE
037 * <CODE>NONE</CODE>}).
038 * <P>
039 * <B>IPP Compatibility:</B> The category name returned by
040 * <CODE>getName()</CODE> is the IPP attribute name. The enumeration's
041 * integer value is the IPP enum value. The <code>toString()</code> method
042 * returns the IPP string representation of the attribute value.
043 * <P>
044 *
045 * @author Alan Kaminsky
046 */
047 public class Compression extends EnumSyntax implements DocAttribute {
048
049 private static final long serialVersionUID = -5716748913324997674L;
050
051 /**
052 * No compression is used.
053 */
054 public static final Compression NONE = new Compression(0);
055
056 /**
057 * ZIP public domain inflate/deflate compression technology.
058 */
059 public static final Compression DEFLATE = new Compression(1);
060
061 /**
062 * GNU zip compression technology described in
063 * <A HREF="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</A>.
064 */
065 public static final Compression GZIP = new Compression(2);
066
067 /**
068 * UNIX compression technology.
069 */
070 public static final Compression COMPRESS = new Compression(3);
071
072 /**
073 * Construct a new compression enumeration value with the given integer
074 * value.
075 *
076 * @param value Integer value.
077 */
078 protected Compression(int value) {
079 super (value);
080 }
081
082 private static final String[] myStringTable = { "none", "deflate",
083 "gzip", "compress" };
084
085 private static final Compression[] myEnumValueTable = { NONE,
086 DEFLATE, GZIP, COMPRESS };
087
088 /**
089 * Returns the string table for class Compression.
090 */
091 protected String[] getStringTable() {
092 return (String[]) myStringTable.clone();
093 }
094
095 /**
096 * Returns the enumeration value table for class Compression.
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 Compression and any vendor-defined subclasses, the category is
107 * class Compression 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 Compression.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 Compression and any vendor-defined subclasses, the category
121 * name is <CODE>"compression"</CODE>.
122 *
123 * @return Attribute category name.
124 */
125 public final String getName() {
126 return "compression";
127 }
128
129 }
|