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

   1: /* NumberUpDefault.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.attribute.DefaultValueAttribute;
  41: 
  42: import javax.print.attribute.Attribute;
  43: import javax.print.attribute.IntegerSyntax;
  44: import javax.print.attribute.standard.NumberUp;
  45: 
  46: /**
  47:  * NumberUpDefault attribute provides the default value of
  48:  * the numper up attribute.
  49:  *
  50:  * @author Wolfgang Baer (WBaer@gmx.de)
  51:  */
  52: public final class NumberUpDefault extends IntegerSyntax
  53:   implements DefaultValueAttribute
  54: {
  55: 
  56:   /**
  57:    * Creates a <code>NumberUpDefault</code> object.
  58:    *
  59:    * @param value the value
  60:    * @throws IllegalArgumentException if value &lt; 1
  61:    */
  62:   public NumberUpDefault(int value)
  63:   {
  64:     super(value);
  65:   }
  66: 
  67:   /**
  68:    * Tests if the given object is equal to this object.
  69:    *
  70:    * @param obj the object to test
  71:    *
  72:    * @return <code>true</code> if both objects are equal,
  73:    * <code>false</code> otherwise.
  74:    */
  75:   public boolean equals(Object obj)
  76:   {
  77:     if(! (obj instanceof NumberUpDefault))
  78:       return false;
  79: 
  80:     return super.equals(obj);
  81:   }
  82: 
  83:   /**
  84:    * Returns category of this class.
  85:    *
  86:    * @return The class <code>NumberUpDefault</code> itself.
  87:    */
  88:   public Class<? extends Attribute> getCategory()
  89:   {
  90:     return NumberUpDefault.class;
  91:   }
  92: 
  93:   /**
  94:    * Returns name of this class.
  95:    *
  96:    * @return The name "number-up-default".
  97:    */
  98:   public String getName()
  99:   {
 100:     return "number-up-default";
 101:   }
 102: 
 103:   /**
 104:    * Returns the equally enum of the standard attribute class
 105:    * of this DefaultValuesAttribute enum.
 106:    * <p>May return null if no value exists in JPS API.</p>
 107:    *
 108:    * @return The enum of the standard attribute class.
 109:    */
 110:   public Attribute getAssociatedAttribute()
 111:   {
 112:     return new NumberUp(getValue());
 113:   }
 114: }