Source for gnu.javax.print.ipp.attribute.defaults.MultipleDocumentHandlingDefault

   1: /* MultipleDocumentHandlingDefault.java --
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package gnu.javax.print.ipp.attribute.defaults;
  39: 
  40: import gnu.javax.print.ipp.IppUtilities;
  41: import gnu.javax.print.ipp.attribute.DefaultValueAttribute;
  42: 
  43: import javax.print.attribute.Attribute;
  44: import javax.print.attribute.EnumSyntax;
  45: 
  46: 
  47: /**
  48:  * <code>MultipleDocumentHandlingDefault</code> provides the
  49:  * default value for the MultipleDocumentHandling attribute.
  50:  *
  51:  * @author Wolfgang Baer (WBaer@gmx.de)
  52:  */
  53: public final class MultipleDocumentHandlingDefault extends EnumSyntax
  54:   implements DefaultValueAttribute
  55: {
  56: 
  57:   //a keyword based attribute in IPP - int values just starting at 0
  58: 
  59:   /**
  60:    * Supports only multiple documents treated as a single document. This
  61:    * applies to attributes which specify treatment of multiple document jobs.
  62:    */
  63:   public static final MultipleDocumentHandlingDefault SINGLE_DOCUMENT =
  64:     new MultipleDocumentHandlingDefault(0);
  65: 
  66:   /** Supports multiple documents as uncollated copies */
  67:   public static final MultipleDocumentHandlingDefault SEPARATE_DOCUMENTS_UNCOLLATED_COPIES =
  68:     new MultipleDocumentHandlingDefault(1);
  69: 
  70:   /** Supports multiple documents as collated copies */
  71:   public static final MultipleDocumentHandlingDefault SEPARATE_DOCUMENTS_COLLATED_COPIES =
  72:     new MultipleDocumentHandlingDefault(2);
  73: 
  74:   /**
  75:    * Supports multiple documents where every single document starts
  76:    * with a new sheet.
  77:    */
  78:   public static final MultipleDocumentHandlingDefault SINGLE_DOCUMENT_NEW_SHEET =
  79:     new MultipleDocumentHandlingDefault(3);
  80: 
  81:   private static final String[] stringTable = { "single-document",
  82:                                                 "separate-documents-uncollated-copies",
  83:                                                 "separate-documents-collated-copies",
  84:                                                 "single-document-new-sheet" };
  85: 
  86:   private static final MultipleDocumentHandlingDefault[] enumValueTable =
  87:     { SINGLE_DOCUMENT, SEPARATE_DOCUMENTS_UNCOLLATED_COPIES,
  88:       SEPARATE_DOCUMENTS_COLLATED_COPIES, SINGLE_DOCUMENT_NEW_SHEET};
  89: 
  90:   /**
  91:    * Constructs a <code>MultipleDocumentHandlingDefault</code> object.
  92:    *
  93:    * @param value the enum value
  94:    */
  95:   protected MultipleDocumentHandlingDefault(int value)
  96:   {
  97:     super(value);
  98:   }
  99: 
 100:   /**
 101:    * Returns category of this class.
 102:    *
 103:    * @return The class <code>MultipleDocumentHandlingDefault</code> itself.
 104:    */
 105:   public Class<? extends Attribute> getCategory()
 106:   {
 107:     return MultipleDocumentHandlingDefault.class;
 108:   }
 109: 
 110:   /**
 111:    * Returns the name of this attribute.
 112:    *
 113:    * @return The name "multiple-document-handling-default".
 114:    */
 115:   public String getName()
 116:   {
 117:     return "multiple-document-handling-default";
 118:   }
 119: 
 120:   /**
 121:    * Returns a table with the enumeration values represented as strings
 122:    * for this object.
 123:    *
 124:    * @return The enumeration values as strings.
 125:    */
 126:   protected String[] getStringTable()
 127:   {
 128:     return stringTable;
 129:   }
 130: 
 131:   /**
 132:    * Returns a table with the enumeration values for this object.
 133:    *
 134:    * @return The enumeration values.
 135:    */
 136:   protected EnumSyntax[] getEnumValueTable()
 137:   {
 138:     return enumValueTable;
 139:   }
 140: 
 141:   /**
 142:    * Returns the equally enum of the standard attribute class
 143:    * of this DefaultValuesAttribute enum.
 144:    *
 145:    * @return The enum of the standard attribute class.
 146:    */
 147:   public Attribute getAssociatedAttribute()
 148:   {
 149:     return IppUtilities.getEnumAttribute("multiple-document-handling",
 150:                                          new Integer(getValue()));
 151:   }
 152: }