From 6d98f7a8d0c7adb17408c7e54c408b166a0a8cd1 Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Wed, 15 Oct 2003 13:57:00 +0000 Subject: [PATCH] AttributedCharacterIterator.java, [...]: Reformated. 2003-10-15 Michael Koch * java/text/AttributedCharacterIterator.java, java/text/CharacterIterator.java: Reformated. From-SVN: r72518 --- libjava/ChangeLog | 5 + .../text/AttributedCharacterIterator.java | 477 ++++++++---------- libjava/java/text/CharacterIterator.java | 3 +- 3 files changed, 225 insertions(+), 260 deletions(-) diff --git a/libjava/ChangeLog b/libjava/ChangeLog index 17ee58263c6..5ad23895a70 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,3 +1,8 @@ +2003-10-15 Michael Koch + + * java/text/AttributedCharacterIterator.java, + java/text/CharacterIterator.java: Reformated. + 2003-10-15 Michael Koch * javax/swing/UIDefaults.java (putDefaults): diff --git a/libjava/java/text/AttributedCharacterIterator.java b/libjava/java/text/AttributedCharacterIterator.java index 85f644c3251..bcb2885e460 100644 --- a/libjava/java/text/AttributedCharacterIterator.java +++ b/libjava/java/text/AttributedCharacterIterator.java @@ -44,266 +44,225 @@ import java.util.Set; import java.util.Map; /** - * This interface extends the CharacterIterator interface - * in order to support iteration over character attributes as well as - * over the characters themselves. - *

- * In addition to attributes of specific characters, this interface - * supports the concept of the "attribute run", which is an attribute - * that is defined for a particular value across an entire range of - * characters or which is undefined over a range of characters. - * - * @version 0.0 - * - * @author Aaron M. Renn (arenn@urbanophile.com) - */ -public interface AttributedCharacterIterator extends CharacterIterator -{ -/** - * This class defines attribute keys that are used as text attributes. - */ -public static class Attribute implements Serializable -{ - - private static final long serialVersionUID = -9142742483513960612L; - -/*************************************************************************/ - -/* - * Static Variables - */ - -/** - * This is the attribute for the language of the text. The value of - * attributes of this key type are instances of Locale. - */ -public static final Attribute LANGUAGE = new Attribute("LANGUAGE"); - -/** - * This is the attribute for the reading form of text. This is used - * for storing pronunciation along with the written text for languages - * which need it. The value of attributes of this key type are - * instances of Annotation which wrappers a String. - */ -public static final Attribute READING = new Attribute("READING"); - -/** - * This is the attribute for input method segments. The value of attributes - * of this key type are instances of Annotation which wrapper - * a String. - */ -public static final Attribute INPUT_METHOD_SEGMENT = - new Attribute("INPUT_METHOD_SEGMENT"); - -/*************************************************************************/ - -/* - * Instance Variables + * This interface extends the CharacterIterator interface + * in order to support iteration over character attributes as well as + * over the characters themselves. + *

+ * In addition to attributes of specific characters, this interface + * supports the concept of the "attribute run", which is an attribute + * that is defined for a particular value across an entire range of + * characters or which is undefined over a range of characters. + * + * @author Aaron M. Renn (arenn@urbanophile.com) */ - -/** - * This is the name of the attribute key - * @serial - */ -private String name; - -/*************************************************************************/ - -/* - * Constructors - */ - -/** - * This method initializes a new instance of this class with the specified - * name. - * - * @param name The name of this attribute key. - */ -protected -Attribute(String name) -{ - this.name = name; -} - -/*************************************************************************/ - -/* - * Instance Methods - */ - -/** - * This method returns the name of this attribute. - * - * @return The attribute name - */ -protected String -getName() -{ - return(name); -} - -/*************************************************************************/ - -/** - * This method resolves an instance of AttributedCharacterIterator.Attribute - * that is being deserialized to one of the three pre-defined attribute - * constants. It does this by comparing the names of the attributes. The - * constant that the deserialized object resolves to is returned. - * - * @return The resolved contant value - * - * @exception InvalidObjectException If the object being deserialized cannot be resolved. - */ -protected Object -readResolve() throws InvalidObjectException -{ - if (this.equals(READING)) - return(READING); - - if (this.equals(LANGUAGE)) - return(LANGUAGE); - - if (this.equals(INPUT_METHOD_SEGMENT)) - return(INPUT_METHOD_SEGMENT); - - throw new InvalidObjectException("Can't resolve Attribute: " + getName()); -} - -/*************************************************************************/ - -/** - * This method tests this object for equality against the specified object. - * The two objects will be considered equal if and only if: - *

    - *
  • The specified object is not null. - *
  • The specified object is an instance of AttributedCharacterIterator.Attribute. - *
  • The specified object has the same attribute name as this object. - *
- * - * @param The Object to test for equality against this object. - * - * @return true if the specified object is equal to this one, false otherwise. - */ -public final boolean -equals(Object obj) -{ - if (obj == this) - return(true); - else - return(false); -} - -/*************************************************************************/ - -/** - * This method returns a hash value for this object. - * - * @return A hash value for this object. - */ -public final int -hashCode() -{ - return(super.hashCode()); -} - -/*************************************************************************/ - -/** - * This method returns a String representation of this object. - * - * @return A String representation of this object. - */ -public String toString() +public interface AttributedCharacterIterator extends CharacterIterator { - return(getClass().getName() + "(" + getName() + ")"); -} - -} // Inner class Attribute - -/** - * This method returns a list of all keys that are defined for the - * text range. This can be an empty list if no attributes are defined. - * - * @return A list of keys - */ -Set getAllAttributeKeys(); - -/** - * This method returns a Map of the attributed defined for - * the current character. - * - * @return A Map of the attributes for the current character. - */ -Map getAttributes(); - -/** - * This method returns the value of the specified attribute for the - * current character. If the attribute is not defined for the current - * character, null is returned. - * - * @param attrib The attribute to retrieve the value of. - * - * @return The value of the specified attribute - */ -Object getAttribute (AttributedCharacterIterator.Attribute attrib); - -/** - * This method returns the index of the first character in the run that - * contains all attributes defined for the current character. - * - * @return The start index of the run - */ -int getRunStart(); - -/** - * This method returns the index of the first character in the run that - * contains all attributes in the specified Set defined for - * the current character. - * - * @param attribs The Set of attributes. - * - * @return The start index of the run. - */ -int getRunStart (Set attribs); - -/** - * This method returns the index of the first character in the run that - * contains the specified attribute defined for the current character. - * - * @param attrib The attribute. - * - * @return The start index of the run. - */ -int getRunStart (AttributedCharacterIterator.Attribute attrib); - -/** - * This method returns the index of the character after the end of the run - * that contains all attributed defined for the current character. - * - * @return The end index of the run. - */ -int getRunLimit(); - -/** - * This method returns the index of the character after the end of the run - * that contains all attributes in the specified Set defined - * for the current character. - * - * @param attribs The Set of attributes. - * - * @return The end index of the run. - */ -int getRunLimit (Set attribs); - -/** - * This methods returns the index of the character after the end of the run - * that contains the specified attribute defined for the current character. - * - * @param attrib The attribute. - * - * @return The end index of the run. - */ -int getRunLimit (AttributedCharacterIterator.Attribute attrib); + /** + * This class defines attribute keys that are used as text attributes. + */ + public static class Attribute implements Serializable + { + private static final long serialVersionUID = -9142742483513960612L; + + /** + * This is the attribute for the language of the text. The value of + * attributes of this key type are instances of Locale. + */ + public static final Attribute LANGUAGE = new Attribute ("LANGUAGE"); + + /** + * This is the attribute for the reading form of text. This is used + * for storing pronunciation along with the written text for languages + * which need it. The value of attributes of this key type are + * instances of Annotation which wrappers a String. + */ + public static final Attribute READING = new Attribute ("READING"); + + /** + * This is the attribute for input method segments. The value of attributes + * of this key type are instances of Annotation which wrapper + * a String. + */ + public static final Attribute INPUT_METHOD_SEGMENT = + new Attribute ("INPUT_METHOD_SEGMENT"); + + /** + * This is the name of the attribute key + * @serial + */ + private String name; + + /** + * This method initializes a new instance of this class with the specified + * name. + * + * @param name The name of this attribute key. + */ + protected Attribute (String name) + { + this.name = name; + } + + /** + * This method returns the name of this attribute. + * + * @return The attribute name + */ + protected String getName() + { + return name; + } + + /** + * This method resolves an instance of AttributedCharacterIterator.Attribute + * that is being deserialized to one of the three pre-defined attribute + * constants. It does this by comparing the names of the attributes. The + * constant that the deserialized object resolves to is returned. + * + * @return The resolved contant value + * + * @exception InvalidObjectException If the object being deserialized cannot be resolved. + */ + protected Object readResolve() throws InvalidObjectException + { + if (this.equals (READING)) + return READING; + + if (this.equals (LANGUAGE)) + return LANGUAGE; + + if (this.equals (INPUT_METHOD_SEGMENT)) + return INPUT_METHOD_SEGMENT; + + throw new InvalidObjectException ("Can't resolve Attribute: " + getName()); + } + + /** + * This method tests this object for equality against the specified object. + * The two objects will be considered equal if and only if: + *
    + *
  • The specified object is not null. + *
  • The specified object is an instance of AttributedCharacterIterator.Attribute. + *
  • The specified object has the same attribute name as this object. + *
+ * + * @param The Object to test for equality against this object. + * + * @return true if the specified object is equal to this one, false otherwise. + */ + public final boolean equals (Object obj) + { + if (obj == this) + return true; + else + return false; + } + + /** + * This method returns a hash value for this object. + * + * @return A hash value for this object. + */ + public final int hashCode() + { + return super.hashCode(); + } + + /** + * This method returns a String representation of this object. + * + * @return A String representation of this object. + */ + public String toString() + { + return getClass().getName() + "(" + getName() + ")"; + } + + } // Inner class Attribute + + /** + * This method returns a list of all keys that are defined for the + * text range. This can be an empty list if no attributes are defined. + * + * @return A list of keys + */ + Set getAllAttributeKeys(); + + /** + * This method returns a Map of the attributed defined for + * the current character. + * + * @return A Map of the attributes for the current character. + */ + Map getAttributes(); + + /** + * This method returns the value of the specified attribute for the + * current character. If the attribute is not defined for the current + * character, null is returned. + * + * @param attrib The attribute to retrieve the value of. + * + * @return The value of the specified attribute + */ + Object getAttribute (AttributedCharacterIterator.Attribute attrib); + + /** + * This method returns the index of the first character in the run that + * contains all attributes defined for the current character. + * + * @return The start index of the run + */ + int getRunStart(); + + /** + * This method returns the index of the first character in the run that + * contains all attributes in the specified Set defined for + * the current character. + * + * @param attribs The Set of attributes. + * + * @return The start index of the run. + */ + int getRunStart (Set attribs); + + /** + * This method returns the index of the first character in the run that + * contains the specified attribute defined for the current character. + * + * @param attrib The attribute. + * + * @return The start index of the run. + */ + int getRunStart (AttributedCharacterIterator.Attribute attrib); + + /** + * This method returns the index of the character after the end of the run + * that contains all attributed defined for the current character. + * + * @return The end index of the run. + */ + int getRunLimit(); + + /** + * This method returns the index of the character after the end of the run + * that contains all attributes in the specified Set defined + * for the current character. + * + * @param attribs The Set of attributes. + * + * @return The end index of the run. + */ + int getRunLimit (Set attribs); + + /** + * This methods returns the index of the character after the end of the run + * that contains the specified attribute defined for the current character. + * + * @param attrib The attribute. + * + * @return The end index of the run. + */ + int getRunLimit (AttributedCharacterIterator.Attribute attrib); } // interface AttributedCharacterIterator - diff --git a/libjava/java/text/CharacterIterator.java b/libjava/java/text/CharacterIterator.java index bcf100d7435..7b774f7a299 100644 --- a/libjava/java/text/CharacterIterator.java +++ b/libjava/java/text/CharacterIterator.java @@ -140,4 +140,5 @@ public interface CharacterIterator extends Cloneable * @return A copy of this CharacterIterator. */ Object clone(); -} + +} // interface CharacterIterator -- 2.30.2