001/* AccessibleBundle.java -- base class for accessibility "enumerations"
002   Copyright (C) 2002, 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.accessibility;
039
040import java.util.Locale;
041
042/**
043 * This serves as a base class for accessibility "enumerations".  These
044 * objects are strongly typed; to make up for the lack of true enums in Java.
045 * Display should be locale dependent.
046 *
047 * @author Eric Blake (ebb9@email.byu.edu)
048 * @see AccessibleRole
049 * @see AccessibleState
050 * @since 1.2
051 * @status updated to 1.4, but missing Locale support
052 */
053public abstract class AccessibleBundle
054{
055  /**
056   * The locale independent name of the object. This is for the computer, not
057   * necessarily for humans; changing it in subclasses is frowned upon.
058   *
059   * @see #toDisplayString(String, Locale)
060   */
061  protected String key;
062
063  /**
064   * Default constructor.
065   */
066  public AccessibleBundle()
067  {
068  }
069
070  /**
071   * Obtains the key as a localized string, falling back to the
072   * locale-independent version if necessary.
073   *
074   * @param resourceBundle the resource to use for lookup
075   * @param locale the locale to translate to
076   * @return the translated name
077   * @throws NullPointerException if resourceBundle or locale is null
078   * @XXX For now, no transformation is done.
079   */
080  protected String toDisplayString(String resourceBundle, Locale locale)
081  {
082    return key;
083  }
084
085  /**
086   * Obtains the key as a localized string, falling back to the
087   * locale-independent version if necessary.
088   *
089   * @param locale the locale to translate to
090   * @return the translated name
091   * @throws NullPointerException if locale is null
092   * @XXX For now, no transformation is done.
093   */
094  public String toDisplayString(Locale locale)
095  {
096    return key;
097  }
098
099  /**
100   * Obtains the key as a localized string, using the default locale.
101   *
102   * @return the translated name
103   * @XXX For now, no transformation is done.
104   */
105  public String toDisplayString()
106  {
107    return toDisplayString(Locale.getDefault());
108  }
109
110  /**
111   * Obtains the key as a localized string, using the default locale.
112   *
113   * @return the translated name
114   * @XXX For now, no transformation is done.
115   */
116  public String toString()
117  {
118    return toDisplayString(Locale.getDefault());
119  }
120} // class AccessibleBundle