1 /*
   2  * Copyright (c) 2000, 2014, 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 package javax.print.attribute.standard;
  26 
  27 import javax.print.attribute.Attribute;
  28 import javax.print.attribute.EnumSyntax;
  29 import javax.print.attribute.DocAttribute;
  30 
  31 /**
  32  * Class Compression is a printing attribute class, an enumeration, that
  33  * specifies how print data is compressed. Compression is an attribute of the
  34  * print data (the doc), not of the Print Job. If a Compression attribute is not
  35  * specified for a doc, the printer assumes the doc's print data is uncompressed
  36  * (i.e., the default Compression value is always {@link #NONE
  37  * NONE}).
  38  * <P>
  39  * <B>IPP Compatibility:</B> The category name returned by
  40  * {@code getName()} is the IPP attribute name.  The enumeration's
  41  * integer value is the IPP enum value.  The {@code toString()} method
  42  * returns the IPP string representation of the attribute value.
  43  *
  44  * @author  Alan Kaminsky
  45  */
  46 public class Compression extends EnumSyntax implements DocAttribute {
  47 
  48     private static final long serialVersionUID = -5716748913324997674L;
  49 
  50     /**
  51      * No compression is used.
  52      */
  53     public static final Compression NONE = new Compression(0);
  54 
  55     /**
  56      * ZIP public domain inflate/deflate compression technology.
  57      */
  58     public static final Compression DEFLATE = new Compression(1);
  59 
  60     /**
  61      * GNU zip compression technology described in
  62      * <A HREF="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</A>.
  63      */
  64     public static final Compression GZIP = new Compression(2);
  65 
  66     /**
  67      * UNIX compression technology.
  68      */
  69     public static final Compression COMPRESS = new Compression(3);
  70 
  71     /**
  72      * Construct a new compression enumeration value with the given integer
  73      * value.
  74      *
  75      * @param  value  Integer value.
  76      */
  77     protected Compression(int value) {
  78         super(value);
  79     }
  80 
  81 
  82     private static final String[] myStringTable = {"none",
  83                                                    "deflate",
  84                                                    "gzip",
  85                                                    "compress"};
  86 
  87     private static final Compression[] myEnumValueTable = {NONE,
  88                                                            DEFLATE,
  89                                                            GZIP,
  90                                                            COMPRESS};
  91 
  92     /**
  93      * Returns the string table for class Compression.
  94      */
  95     protected String[] getStringTable() {
  96         return myStringTable.clone();
  97     }
  98 
  99     /**
 100      * Returns the enumeration value table for class Compression.
 101      */
 102     protected EnumSyntax[] getEnumValueTable() {
 103         return (EnumSyntax[])myEnumValueTable.clone();
 104     }
 105 
 106     /**
 107      * Get the printing attribute class which is to be used as the "category"
 108      * for this printing attribute value.
 109      * <P>
 110      * For class Compression and any vendor-defined subclasses, the category is
 111      * class Compression itself.
 112      *
 113      * @return  Printing attribute class (category), an instance of class
 114      *          {@link java.lang.Class java.lang.Class}.
 115      */
 116     public final Class<? extends Attribute> getCategory() {
 117         return Compression.class;
 118     }
 119 
 120     /**
 121      * Get the name of the category of which this attribute value is an
 122      * instance.
 123      * <P>
 124      * For class Compression and any vendor-defined subclasses, the category
 125      * name is {@code "compression"}.
 126      *
 127      * @return  Attribute category name.
 128      */
 129     public final String getName() {
 130         return "compression";
 131     }
 132 
 133 }