001/* TextSyntax.java -- 
002   Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.attribute;
039
040import java.io.Serializable;
041import java.util.Locale;
042
043/**
044 * <code>TextSyntax</code> is the abstract base class of all attribute 
045 * classes which provide a string as value (e.g. the location of the printer).
046 * <p>
047 * A <code>TextSyntax</code> instance consists of a string value and a
048 * locale which indicates the language of the locale of the string.
049 * </p>
050 *
051 * @author Michael Koch (konqueror@gmx.de)
052 */
053public abstract class TextSyntax implements Cloneable, Serializable
054{
055  private static final long serialVersionUID = -8130648736378144102L;
056  
057  private String value;
058  private Locale locale;
059
060  /**
061   * Creates a <code>TextSyntax</code> object with the given value
062   * and locale.
063   *
064   * @param value the value for this syntax
065   * @param locale the locale to use, if <code>null</code> the default
066   * locale is used.
067   *
068   * @exception NullPointerException if value is null
069   */
070  protected TextSyntax(String value, Locale locale)
071  {
072    if (value == null)
073      throw new NullPointerException("value may not be null");
074    
075    this.value = value;
076    this.locale = (locale == null ? Locale.getDefault() : locale);
077  }
078
079  /**
080   * Returns the value of this syntax object.
081   *
082   * @return The value.
083   */
084  public String getValue()
085  {
086    return value;
087  }
088
089  /**
090   * Returns the locale of this syntax object.
091   *
092   * @return The locale.
093   */
094  public Locale getLocale()
095  {
096    return locale;
097  }
098
099  /**
100   * Returns the hashcode for this object.
101   *
102   * @return The hashcode.
103   */
104  public int hashCode()
105  {
106    return value.hashCode() ^ locale.hashCode();
107  }
108
109  /**
110   * Tests if the given object is equal to this object.
111   *
112   * @param obj the object to test
113   *
114   * @return true if both objects are equal, false otherwise.
115   */
116  public boolean equals(Object obj)
117  {
118    if (! (obj instanceof TextSyntax))
119      return false;
120
121    TextSyntax tmp = (TextSyntax) obj;
122    
123    return (value.equals(tmp.getValue())
124            && locale.equals(tmp.getLocale()));
125  }
126
127  /**
128   * Returns a string representing the object. The returned
129   * string is the underlying text value of this object.
130   * 
131   * @return The string representation.
132   */
133  public String toString()
134  {
135    return getValue();
136  }
137}