Source for gnu.javax.print.ipp.attribute.NaturalLanguageSyntax

   1: /* NaturalLanguageSyntax.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;
  40: 
  41: import java.io.Serializable;
  42: 
  43: /**
  44:  * <code>NaturalLanguageSyntax</code> is the abstract base class of all
  45:  * attribute classes which provide a natural language (US-ASCII)
  46:  * string as value.
  47:  *
  48:  * @author Wolfgang Baer (WBaer@gmx.de)
  49:  */
  50: public abstract class NaturalLanguageSyntax
  51:   implements Cloneable, Serializable
  52: {
  53:   private final String value;
  54: 
  55:   /**
  56:    * Creates a <code>NaturalLanguageSyntax</code> object with the given value
  57:    * and locale.
  58:    *
  59:    * @param value the value for this syntax
  60:    *
  61:    * @exception NullPointerException if value is null
  62:    */
  63:   protected NaturalLanguageSyntax(String value)
  64:   {
  65:     if (value == null)
  66:       throw new NullPointerException("value may not be null");
  67: 
  68:     this.value = value;
  69:   }
  70: 
  71:   /**
  72:    * Returns the value of this syntax object.
  73:    *
  74:    * @return The value.
  75:    */
  76:   public String getValue()
  77:   {
  78:     return value;
  79:   }
  80: 
  81:   /**
  82:    * Returns the hashcode for this object.
  83:    *
  84:    * @return The hashcode.
  85:    */
  86:   public int hashCode()
  87:   {
  88:     return value.hashCode();
  89:   }
  90: 
  91:   /**
  92:    * Tests if the given object is equal to this object.
  93:    *
  94:    * @param obj the object to test
  95:    *
  96:    * @return true if both objects are equal, false otherwise.
  97:    */
  98:   public boolean equals(Object obj)
  99:   {
 100:     if (! (obj instanceof NaturalLanguageSyntax))
 101:       return false;
 102: 
 103:     NaturalLanguageSyntax tmp = (NaturalLanguageSyntax) obj;
 104:     return value.equals(tmp.getValue());
 105:   }
 106: 
 107:   /**
 108:    * Returns a string representing the object. The returned
 109:    * string is the underlying text value of this object.
 110:    *
 111:    * @return The string representation.
 112:    */
 113:   public String toString()
 114:   {
 115:     return getValue();
 116:   }
 117: }