tec.units.ri.internal.format.l10n.Attribute Maven / Gradle / Ivy
Show all versions of unit-ri Show documentation
/*
* Units of Measurement Reference Implementation
* Copyright (c) 2005-2015, Jean-Marie Dautelle, Werner Keil, V2COM.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
* and the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package tec.units.ri.internal.format.l10n;
import java.util.Hashtable;
import tec.units.ri.function.Nameable;
/**
* Defines attribute keys that are used to identify text attributes. These keys
* are used in AttributedCharacterIterator and AttributedString.
*
* @see AttributedCharacterIterator
* @see AttributedString
* @see Nameable
*/
class Attribute implements Nameable {
/**
* The name of this Attribute. The name is used primarily by readResolve to
* look up the corresponding predefined instance when deserializing an
* instance.
*
* @serial
*/
private final String name;
// table of all instances in this class, used by readResolve
private static final Hashtable instanceMap = new Hashtable(7);
/**
* Constructs an Attribute with the given name.
*/
protected Attribute(String name) {
this.name = name;
if (this.getClass() == Attribute.class) {
instanceMap.put(name, this);
}
}
/**
* Compares two objects for equality. This version only returns true for
* x.equals(y) if x and y refer to
* the same object, and guarantees this for all subclasses.
*/
public final boolean equals(Object obj) {
return super.equals(obj);
}
/**
* Returns a hash code value for the object. This version is identical to
* the one in Object, but is also final.
*/
public final int hashCode() {
return super.hashCode();
}
/**
* Returns a string representation of the object. This version returns the
* concatenation of class name, "(", a name identifying the attribute and
* ")".
*/
public String toString() {
return getClass().getName() + "(" + name + ")";
}
/**
* Returns the name of the attribute.
*/
public String getName() {
return name;
}
/**
* Attribute key for the language of some text.
*
* Values are instances of Locale.
*
* @see java.util.Locale
*/
public static final Attribute LANGUAGE = new Attribute("language");
/**
* Attribute key for the reading of some text. In languages where the
* written form and the pronunciation of a word are only loosely related
* (such as Japanese), it is often necessary to store the reading
* (pronunciation) along with the written form.
*
* Values are instances of Annotation holding instances of String.
*
* @see Annotation
* @see java.lang.String
*/
public static final Attribute READING = new Attribute("reading");
/**
* Attribute key for input method segments. Input methods often break up
* text into segments, which usually correspond to words.
*
* Values are instances of Annotation holding a null reference.
*
* @see Annotation
*/
public static final Attribute INPUT_METHOD_SEGMENT = new Attribute(
"input_method_segment");
/* Declare serialVersionUID for interoperability */
private static final long serialVersionUID = -9142742483513960612L;
};