1 /*
2 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
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.DocAttribute;
30 import javax.print.attribute.EnumSyntax;
31
32 /**
33 * Class {@code Compression} is a printing attribute class, an enumeration, that
34 * specifies how print data is compressed. {@code Compression} is an attribute
35 * of the print data (the doc), not of the Print Job. If a {@code Compression}
36 * attribute is not specified for a doc, the printer assumes the doc's print
37 * data is uncompressed (i.e., the default Compression value is always
38 * {@link #NONE NONE}).
39 * <p>
40 * <b>IPP Compatibility:</b> The category name returned by {@code getName()} is
41 * the IPP attribute name. The enumeration's integer value is the IPP enum
42 * value. The {@code toString()} method returns the IPP string representation of
43 * the attribute value.
44 *
45 * @author Alan Kaminsky
46 */
47 public class Compression extends EnumSyntax implements DocAttribute {
48
49 /**
50 * Use serialVersionUID from JDK 1.4 for interoperability.
51 */
52 private static final long serialVersionUID = -5716748913324997674L;
53
54 /**
55 * No compression is used.
56 */
57 public static final Compression NONE = new Compression(0);
58
59 /**
60 * ZIP public domain inflate/deflate compression technology.
61 */
62 public static final Compression DEFLATE = new Compression(1);
63
64 /**
65 * GNU zip compression technology described in
66 * <a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>.
67 */
68 public static final Compression GZIP = new Compression(2);
69
70 /**
71 * UNIX compression technology.
72 */
73 public static final Compression COMPRESS = new Compression(3);
74
75 /**
76 * Construct a new compression enumeration value with the given integer
77 * value.
78 *
79 * @param value Integer value
80 */
81 protected Compression(int value) {
82 super(value);
83 }
84
85 /**
86 * The string table for class {@code Compression}.
87 */
88 private static final String[] myStringTable = {"none",
89 "deflate",
90 "gzip",
91 "compress"};
92
93 /**
94 * The enumeration value table for class {@code Compression}.
95 */
96 private static final Compression[] myEnumValueTable = {NONE,
97 DEFLATE,
98 GZIP,
99 COMPRESS};
100
101 /**
102 * Returns the string table for class {@code Compression}.
103 */
104 protected String[] getStringTable() {
105 return myStringTable.clone();
106 }
107
108 /**
109 * Returns the enumeration value table for class {@code Compression}.
110 */
111 protected EnumSyntax[] getEnumValueTable() {
112 return (EnumSyntax[])myEnumValueTable.clone();
113 }
114
115 /**
116 * Get the printing attribute class which is to be used as the "category"
117 * for this printing attribute value.
118 * <p>
119 * For class {@code Compression} and any vendor-defined subclasses, the
120 * category is class {@code Compression} itself.
121 *
122 * @return printing attribute class (category), an instance of class
123 * {@link Class java.lang.Class}
124 */
125 public final Class<? extends Attribute> getCategory() {
126 return Compression.class;
127 }
128
129 /**
130 * Get the name of the category of which this attribute value is an
131 * instance.
132 * <p>
133 * For class {@code Compression} and any vendor-defined subclasses, the
134 * category name is {@code "compression"}.
135 *
136 * @return attribute category name
137 */
138 public final String getName() {
139 return "compression";
140 }
141 }