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

   1: /* JobSheetsSupported.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: 
  39: package gnu.javax.print.ipp.attribute.supported;
  40: 
  41: import gnu.javax.print.ipp.attribute.defaults.JobSheetsDefault;
  42: 
  43: import java.util.ArrayList;
  44: import java.util.Iterator;
  45: import java.util.Locale;
  46: import java.util.Set;
  47: 
  48: import javax.print.attribute.Attribute;
  49: import javax.print.attribute.SupportedValuesAttribute;
  50: import javax.print.attribute.TextSyntax;
  51: import javax.print.attribute.standard.JobSheets;
  52: 
  53: /**
  54:  * JobSheetsSupported attribute provides the supported values
  55:  * of the job-sheets attribute.
  56:  *
  57:  * @author Wolfgang Baer (WBaer@gmx.de)
  58:  */
  59: public final class JobSheetsSupported extends TextSyntax
  60:     implements SupportedValuesAttribute
  61: {
  62:   //a keyword/name based attribute in IPP
  63:   // can be extended by administrators
  64:   // standard values are predefined
  65: 
  66:   /** No job sheet is the default */
  67:   public static final JobSheetsDefault NONE =
  68:     new JobSheetsDefault("none", Locale.getDefault());
  69: 
  70:   /** A job sheet is the default */
  71:   public static final JobSheetsDefault STANDARD =
  72:     new JobSheetsDefault("standard", Locale.getDefault());
  73: 
  74:   /**
  75:    * Creates a <code>JobSheetsSupported</code> object with the
  76:    * given value and locale.
  77:    *
  78:    * @param value the value for this syntax
  79:    * @param locale the locale to use, if <code>null</code> the default
  80:    * locale is used.
  81:    *
  82:    * @throws NullPointerException if value is null
  83:    */
  84:   public JobSheetsSupported(String value, Locale locale)
  85:   {
  86:     super(value, locale);
  87:   }
  88: 
  89:   /**
  90:    * Returns category of this class.
  91:    *
  92:    * @return The class <code>JobSheetsSupported</code> itself.
  93:    */
  94:   public Class<? extends Attribute> getCategory()
  95:   {
  96:     return JobSheetsSupported.class;
  97:   }
  98: 
  99:   /**
 100:    * Returns the name of this attribute.
 101:    *
 102:    * @return The name "job-sheets-supported".
 103:    */
 104:   public String getName()
 105:   {
 106:     return "job-sheets-supported";
 107:   }
 108: 
 109:   /**
 110:    * Returns the equally enum of the standard attribute class
 111:    * of this SupportedValuesAttribute enum.
 112:    * <p>May return null if no value exists in JPS API.</p>
 113:    *
 114:    * @return The enum of the standard attribute class.
 115:    */
 116:   public JobSheets getAssociatedAttribute()
 117:   {
 118:     if (this.equals(JobSheetsDefault.NONE))
 119:       return JobSheets.NONE;
 120:     if (this.equals(JobSheetsDefault.STANDARD))
 121:       return JobSheets.STANDARD;
 122: 
 123:     return null;
 124:   }
 125: 
 126:   /**
 127:    * Constructs an array from a set of -supported attributes.
 128:    * @param set set to process
 129:    * @return The constructed array.
 130:    *
 131:    * @see #getAssociatedAttribute()
 132:    */
 133:   public static JobSheets[]
 134:     getAssociatedAttributeArray(Set<Attribute> set)
 135:   {
 136:     ArrayList<JobSheets> result = new ArrayList<JobSheets>();
 137:     int j = 0;
 138:     for (Attribute tmp : set)
 139:       {
 140:         JobSheets att = ((JobSheetsSupported) tmp).getAssociatedAttribute();
 141:         if (att != null)
 142:           result.add(att);
 143:         j++;
 144:       }
 145:     return result.toArray(new JobSheets[result.size()]);
 146:   }
 147: 
 148: }