AttributedCharacterIterator.Attribute (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.text.AttributedCharacterIterator.Attribute

• All Implemented Interfaces:
  Serializable
  Direct Known Subclasses:
  Format.Field, TextAttribute
  Enclosing interface:
  AttributedCharacterIterator

public static class AttributedCharacterIterator.Attribute
extends Object
implements Serializable
Defines attribute keys that are used to identify text attributes. These keys are used in AttributedCharacterIterator and AttributedString.
Since:
1.2
See Also:
AttributedCharacterIterator, AttributedString, Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static AttributedCharacterIterator.Attribute	INPUT_METHOD_SEGMENT	Attribute key for input method segments.
  static AttributedCharacterIterator.Attribute	LANGUAGE	Attribute key for the language of some text.
  static AttributedCharacterIterator.Attribute	READING	Attribute key for the reading of some text.

  • Constructor Summary

  Constructors

  Modifier	Constructor	Description
  protected	Attribute(String name)	Constructs an Attribute with the given name.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	equals(Object obj)	Compares two objects for equality.
  protected String	getName()	Returns the name of the attribute.
  int	hashCode()	Returns a hash code value for the object.
  protected Object	readResolve()	Resolves instances being deserialized to the predefined constants.
  String	toString()	Returns a string representation of the object.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### LANGUAGE  
     public static final [AttributedCharacterIterator.Attribute](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text") LANGUAGE  
     Attribute key for the language of some text.  
      Values are instances of [Locale](../../java/util/Locale.html "class in java.util").  
     See Also:  
     [Locale](../../java/util/Locale.html "class in java.util")  
     * #### READING  
     public static final [AttributedCharacterIterator.Attribute](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text") READING  
     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](../../java/text/Annotation.html "class in java.text") holding instances of [String](../../java/lang/String.html "class in java.lang").  
     See Also:  
     [Annotation](../../java/text/Annotation.html "class in java.text"), [String](../../java/lang/String.html "class in java.lang")  
     * #### INPUT\_METHOD\_SEGMENT  
     public static final [AttributedCharacterIterator.Attribute](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text") INPUT_METHOD_SEGMENT  
     Attribute key for input method segments. Input methods often break up text into segments, which usually correspond to words.  
     Values are instances of [Annotation](../../java/text/Annotation.html "class in java.text") holding a `null` reference.  
     See Also:  
     [Annotation](../../java/text/Annotation.html "class in java.text")  

  • Constructor Detail

    * #### Attribute  
    protected Attribute([String](../../java/lang/String.html "class in java.lang") name)  
    Constructs an `Attribute` with the given name.  
    Parameters:  
    `name` \- the name of `Attribute`  

  • Method Detail

    * #### equals  
    public final boolean equals([Object](../../java/lang/Object.html "class in java.lang") obj)  
    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.  
    Overrides:  
    `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Parameters:  
    `obj` \- the reference object with which to compare.  
    Returns:  
    `true` if this object is the same as the obj argument; `false` otherwise.  
    See Also:  
    [Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
    * #### hashCode  
    public final int hashCode()  
    Returns a hash code value for the object. This version is identical to the one in `Object`, but is also final.  
    Overrides:  
    `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a hash code value for this object.  
    See Also:  
    [Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString()  
    Returns a string representation of the object. This version returns the concatenation of class name, `"("`, a name identifying the attribute and `")"`.  
    Overrides:  
    `[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a string representation of the object.  
    * #### getName  
    protected [String](../../java/lang/String.html "class in java.lang") getName()  
    Returns the name of the attribute.  
    Returns:  
    the name of `Attribute`  
    * #### readResolve  
    protected [Object](../../java/lang/Object.html "class in java.lang") readResolve()  
                          throws [InvalidObjectException](../../java/io/InvalidObjectException.html "class in java.io")  
    Resolves instances being deserialized to the predefined constants.  
    Returns:  
    the resolved `Attribute` object  
    Throws:  
    `[InvalidObjectException](../../java/io/InvalidObjectException.html "class in java.io")` \- if the object to resolve is not an instance of `Attribute`

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.