Source for gnu.javax.print.ipp.attribute.supported.MultipleDocumentHandlingSupported

   1: /* MultipleDocumentHandlingSupported.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.supported;
  39: 
  40: import gnu.javax.print.ipp.IppUtilities;
  41: 
  42: import java.util.Iterator;
  43: import java.util.Set;
  44: 
  45: import javax.print.attribute.EnumSyntax;
  46: import javax.print.attribute.SupportedValuesAttribute;
  47: import javax.print.attribute.standard.MultipleDocumentHandling;
  48: 
  49: 
  50: /**
  51:  * <code>MultipleDocumentHandlingSupported</code> provides the
  52:  * supported values for the MultipleDocumentHandling attribute.
  53:  *  
  54:  * @author Wolfgang Baer (WBaer@gmx.de)
  55:  */
  56: public final class MultipleDocumentHandlingSupported extends EnumSyntax
  57:   implements SupportedValuesAttribute
  58: {
  59:   
  60:   //a keyword based attribute in IPP - int values just starting at 0
  61:   
  62:   /** 
  63:    * Supports only multiple documents treated as a single document. This 
  64:    * applies to attributes which specify treatment of multiple document jobs.
  65:    */
  66:   public static final MultipleDocumentHandlingSupported SINGLE_DOCUMENT =
  67:     new MultipleDocumentHandlingSupported(0);
  68:   
  69:   /** Supports multiple documents as uncollated copies */
  70:   public static final MultipleDocumentHandlingSupported SEPARATE_DOCUMENTS_UNCOLLATED_COPIES =
  71:     new MultipleDocumentHandlingSupported(1);
  72:   
  73:   /** Supports multiple documents as collated copies */
  74:   public static final MultipleDocumentHandlingSupported SEPARATE_DOCUMENTS_COLLATED_COPIES =
  75:     new MultipleDocumentHandlingSupported(2);
  76:   
  77:   /** 
  78:    * Supports multiple documents where every single document starts
  79:    * with a new sheet. 
  80:    */
  81:   public static final MultipleDocumentHandlingSupported SINGLE_DOCUMENT_NEW_SHEET =
  82:     new MultipleDocumentHandlingSupported(3);
  83: 
  84:   private static final String[] stringTable = { "single-document", 
  85:                                                 "separate-documents-uncollated-copies",
  86:                                                 "separate-documents-collated-copies",
  87:                                                 "single-document-new-sheet" };
  88:   
  89:   private static final MultipleDocumentHandlingSupported[] enumValueTable = 
  90:     { SINGLE_DOCUMENT, SEPARATE_DOCUMENTS_UNCOLLATED_COPIES,
  91:       SEPARATE_DOCUMENTS_COLLATED_COPIES, SINGLE_DOCUMENT_NEW_SHEET};
  92:   
  93:   /**
  94:    * Constructs a <code>MultipleDocumentHandlingSupported</code> object.
  95:    * 
  96:    * @param value the enum value
  97:    */
  98:   protected MultipleDocumentHandlingSupported(int value)
  99:   {
 100:     super(value);
 101:   }
 102: 
 103:   /**
 104:    * Returns category of this class.
 105:    *
 106:    * @return The class <code>MultipleDocumentHandlingSupported</code> itself.
 107:    */
 108:   public Class getCategory()
 109:   {
 110:     return MultipleDocumentHandlingSupported.class;
 111:   }
 112: 
 113:   /**
 114:    * Returns the name of this attribute.
 115:    *
 116:    * @return The name "multiple-document-handling-supported".
 117:    */
 118:   public String getName()
 119:   {
 120:     return "multiple-document-handling-supported";
 121:   }
 122:   
 123:   /**
 124:    * Returns a table with the enumeration values represented as strings
 125:    * for this object.
 126:    *
 127:    * @return The enumeration values as strings.
 128:    */
 129:   protected String[] getStringTable()
 130:   {
 131:     return stringTable;
 132:   }
 133: 
 134:   /**
 135:    * Returns a table with the enumeration values for this object.
 136:    *
 137:    * @return The enumeration values.
 138:    */
 139:   protected EnumSyntax[] getEnumValueTable()
 140:   {
 141:     return enumValueTable;
 142:   }
 143:   
 144:   /**
 145:    * Returns the equally enum of the standard attribute class
 146:    * of this SupportedValuesAttribute enum.
 147:    * 
 148:    * @return The enum of the standard attribute class.
 149:    */
 150:   public MultipleDocumentHandling getAssociatedAttribute() 
 151:   {
 152:     return (MultipleDocumentHandling) IppUtilities.getEnumAttribute(
 153:             "multiple-document-handling", new Integer(getValue()));
 154:   }
 155:   
 156:   /**
 157:    * Constructs an array from a set of -supported attributes.
 158:    * @param set set to process
 159:    * @return The constructed array.
 160:    * 
 161:    * @see #getAssociatedAttribute()
 162:    */
 163:   public static MultipleDocumentHandling[] getAssociatedAttributeArray(Set set)
 164:   {
 165:     MultipleDocumentHandlingSupported tmp;
 166:     MultipleDocumentHandling[] result = new MultipleDocumentHandling[set.size()];      
 167:     Iterator it = set.iterator();
 168:     int j = 0;
 169:     while (it.hasNext())
 170:       {
 171:         tmp = (MultipleDocumentHandlingSupported) it.next();
 172:         result[j] = tmp.getAssociatedAttribute();
 173:         j++;
 174:       }            
 175:     return result;
 176:   }
 177: }