Source for javax.print.attribute.TextSyntax

   1: /* TextSyntax.java -- 
   2:    Copyright (C) 2003, 2004 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;
  39: 
  40: import java.io.Serializable;
  41: import java.util.Locale;
  42: 
  43: /**
  44:  * @author Michael Koch
  45:  */
  46: public abstract class TextSyntax implements Cloneable, Serializable
  47: {
  48:   private static final long serialVersionUID = -8130648736378144102L;
  49:   
  50:   private String value;
  51:   private Locale locale;
  52: 
  53:   /**
  54:    * Creates a <code>TextSyntax</code> object with the given value
  55:    * and locale.
  56:    *
  57:    * @param value the value for this syntax
  58:    * @param locale the locale to use
  59:    *
  60:    * @exception NullPointerException if value and/or locale is null
  61:    */
  62:   protected TextSyntax(String value, Locale locale)
  63:   {
  64:     if (value == null || locale == null)
  65:       throw new NullPointerException("value and/or locale may not be null");
  66: 
  67:     this.value = value;
  68:     this.locale = locale;
  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 locale of this syntax object.
  83:    *
  84:    * @return the locale
  85:    */
  86:   public Locale getLocale()
  87:   {
  88:     return locale;
  89:   }
  90: 
  91:   /**
  92:    * Returns the hashcode for this object.
  93:    *
  94:    * @return the hashcode
  95:    */
  96:   public int hashCode()
  97:   {
  98:     return value.hashCode() ^ locale.hashCode();
  99:   }
 100: 
 101:   /**
 102:    * Tests of obj is equal to this object.
 103:    *
 104:    * @param obj the object to test
 105:    *
 106:    * @return true if both objects are equal, false otherwise.
 107:    */
 108:   public boolean equals(Object obj)
 109:   {
 110:     if (! (obj instanceof TextSyntax))
 111:       return false;
 112: 
 113:     TextSyntax tmp = (TextSyntax) obj;
 114:     
 115:     return (value.equals(tmp.getValue())
 116:             && locale.equals(tmp.getLocale()));
 117:   }
 118: 
 119:   /**
 120:    * Returns a string representing the object.
 121:    */
 122:   public String toString()
 123:   {
 124:     return getValue();
 125:   }
 126: }