Source for javax.print.attribute.standard.JobPrioritySupported

   1: /* JobPrioritySupported.java -- 
   2:    Copyright (C) 2003, 2004, 2005  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 javax.print.attribute.standard;
  39: 
  40: import javax.print.attribute.Attribute;
  41: import javax.print.attribute.IntegerSyntax;
  42: import javax.print.attribute.SupportedValuesAttribute;
  43: 
  44: 
  45: /**
  46:  * The <code>JobPrioritySupported</code> printing attribute provides
  47:  * the supported values for the <code>JobPriority</code> attribute.
  48:  * <p>
  49:  * A client may specify any JobPriority value between 1 and 100. If a
  50:  * print service supports fewer priority levels it indicates the maximum
  51:  * levels through this attribute. The print service then automatically 
  52:  * maps the job priority value provided by the client in an even distribution
  53:  * over the whole range of 1 to 100.
  54:  * </p>
  55:  * <p>
  56:  * <b>IPP Compatibility:</b> JobPrioritySupported is an IPP 1.1 attribute.
  57:  * </p>
  58:  * @see javax.print.attribute.standard.JobPriority
  59:  * 
  60:  * @author Michael Koch (konqueror@gmx.de)
  61:  */
  62: public final class JobPrioritySupported extends IntegerSyntax
  63:   implements SupportedValuesAttribute
  64: {
  65:   private static final long serialVersionUID = 2564840378013555894L;
  66: 
  67:   /**
  68:    * Creates a <code>JobPrioritySupported</code> object.
  69:    *
  70:    * @param value the priority
  71:    *
  72:    * @exception IllegalArgumentException if value &lt; 1 or value &gt; 100
  73:    */
  74:   public JobPrioritySupported(int value)
  75:   {
  76:     super(value);
  77: 
  78:     if (value < 1 || value > 100)
  79:       throw new IllegalArgumentException("value out of range");
  80:   }
  81: 
  82:   /**
  83:    * Tests if the given object is equal to this object.
  84:    *
  85:    * @param obj the object to test
  86:    *
  87:    * @return <code>true</code> if both objects are equal, 
  88:    * <code>false</code> otherwise.
  89:    */
  90:   public boolean equals(Object obj)
  91:   {
  92:     if(! (obj instanceof JobPrioritySupported))
  93:       return false;
  94: 
  95:     return super.equals(obj);
  96:   }
  97: 
  98:   /**
  99:    * Returns category of this class.
 100:    *
 101:    * @return The class <code>JobPrioritySupported</code> itself.
 102:    */
 103:   public Class< ? extends Attribute> getCategory()
 104:   {
 105:     return JobPrioritySupported.class;
 106:   }
 107: 
 108:   /**
 109:    * Returns the name of this attribute.
 110:    *
 111:    * @return The name "job-priority-supported".
 112:    */
 113:   public String getName()
 114:   {
 115:     return "job-priority-supported";
 116:   }
 117: }