Commit 6d98f7a8 by Michael Koch Committed by Michael Koch

AttributedCharacterIterator.java, [...]: Reformated.

2003-10-15  Michael Koch  <konqueror@gmx.de>

	* java/text/AttributedCharacterIterator.java,
	java/text/CharacterIterator.java: Reformated.

From-SVN: r72518
parent c191caf2
2003-10-15 Michael Koch <konqueror@gmx.de> 2003-10-15 Michael Koch <konqueror@gmx.de>
* java/text/AttributedCharacterIterator.java,
java/text/CharacterIterator.java: Reformated.
2003-10-15 Michael Koch <konqueror@gmx.de>
* javax/swing/UIDefaults.java (putDefaults): * javax/swing/UIDefaults.java (putDefaults):
Readded accidently removed "public" modifier. Readded accidently removed "public" modifier.
......
...@@ -44,266 +44,225 @@ import java.util.Set; ...@@ -44,266 +44,225 @@ import java.util.Set;
import java.util.Map; import java.util.Map;
/** /**
* This interface extends the <code>CharacterIterator</code> interface * This interface extends the <code>CharacterIterator</code> interface
* in order to support iteration over character attributes as well as * in order to support iteration over character attributes as well as
* over the characters themselves. * over the characters themselves.
* <p> * <p>
* In addition to attributes of specific characters, this interface * In addition to attributes of specific characters, this interface
* supports the concept of the "attribute run", which is an attribute * supports the concept of the "attribute run", which is an attribute
* that is defined for a particular value across an entire range of * that is defined for a particular value across an entire range of
* characters or which is undefined over a range of characters. * characters or which is undefined over a range of characters.
* *
* @version 0.0 * @author Aaron M. Renn (arenn@urbanophile.com)
*
* @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 <code>Locale</code>.
*/
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 <code>Annotation</code> which wrappers a <code>String</code>.
*/
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 <code>Annotation</code> which wrapper
* a <code>String</code>.
*/
public static final Attribute INPUT_METHOD_SEGMENT =
new Attribute("INPUT_METHOD_SEGMENT");
/*************************************************************************/
/*
* Instance Variables
*/ */
public interface AttributedCharacterIterator extends CharacterIterator
/**
* 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 <code>AttributedCharacterIterator.Attribute</code>
* 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:
* <ul>
* <li>The specified object is not <code>null</code>.
* <li>The specified object is an instance of <code>AttributedCharacterIterator.Attribute</code>.
* <li>The specified object has the same attribute name as this object.
* </ul>
*
* @param The <code>Object</code> to test for equality against this object.
*
* @return <code>true</code> if the specified object is equal to this one, <code>false</code> 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 <code>String</code> representation of this object.
*
* @return A <code>String</code> representation of this object.
*/
public String toString()
{ {
return(getClass().getName() + "(" + getName() + ")"); /**
} * This class defines attribute keys that are used as text attributes.
*/
} // Inner class Attribute public static class Attribute implements Serializable
{
/** private static final long serialVersionUID = -9142742483513960612L;
* 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. /**
* * This is the attribute for the language of the text. The value of
* @return A list of keys * attributes of this key type are instances of <code>Locale</code>.
*/ */
Set getAllAttributeKeys(); public static final Attribute LANGUAGE = new Attribute ("LANGUAGE");
/** /**
* This method returns a <code>Map</code> of the attributed defined for * This is the attribute for the reading form of text. This is used
* the current character. * for storing pronunciation along with the written text for languages
* * which need it. The value of attributes of this key type are
* @return A <code>Map</code> of the attributes for the current character. * instances of <code>Annotation</code> which wrappers a <code>String</code>.
*/ */
Map getAttributes(); public static final Attribute READING = new Attribute ("READING");
/** /**
* This method returns the value of the specified attribute for the * This is the attribute for input method segments. The value of attributes
* current character. If the attribute is not defined for the current * of this key type are instances of <code>Annotation</code> which wrapper
* character, <code>null</code> is returned. * a <code>String</code>.
* */
* @param attrib The attribute to retrieve the value of. public static final Attribute INPUT_METHOD_SEGMENT =
* new Attribute ("INPUT_METHOD_SEGMENT");
* @return The value of the specified attribute
*/ /**
Object getAttribute (AttributedCharacterIterator.Attribute attrib); * This is the name of the attribute key
* @serial
/** */
* This method returns the index of the first character in the run that private String name;
* contains all attributes defined for the current character.
* /**
* @return The start index of the run * This method initializes a new instance of this class with the specified
*/ * name.
int getRunStart(); *
* @param name The name of this attribute key.
/** */
* This method returns the index of the first character in the run that protected Attribute (String name)
* contains all attributes in the specified <code>Set</code> defined for {
* the current character. this.name = name;
* }
* @param attribs The <code>Set</code> of attributes.
* /**
* @return The start index of the run. * This method returns the name of this attribute.
*/ *
int getRunStart (Set attribs); * @return The attribute name
*/
/** protected String getName()
* This method returns the index of the first character in the run that {
* contains the specified attribute defined for the current character. return name;
* }
* @param attrib The attribute.
* /**
* @return The start index of the run. * This method resolves an instance of <code>AttributedCharacterIterator.Attribute</code>
*/ * that is being deserialized to one of the three pre-defined attribute
int getRunStart (AttributedCharacterIterator.Attribute attrib); * constants. It does this by comparing the names of the attributes. The
* constant that the deserialized object resolves to is returned.
/** *
* This method returns the index of the character after the end of the run * @return The resolved contant value
* that contains all attributed defined for the current character. *
* * @exception InvalidObjectException If the object being deserialized cannot be resolved.
* @return The end index of the run. */
*/ protected Object readResolve() throws InvalidObjectException
int getRunLimit(); {
if (this.equals (READING))
/** return READING;
* This method returns the index of the character after the end of the run
* that contains all attributes in the specified <code>Set</code> defined if (this.equals (LANGUAGE))
* for the current character. return LANGUAGE;
*
* @param attribs The <code>Set</code> of attributes. if (this.equals (INPUT_METHOD_SEGMENT))
* return INPUT_METHOD_SEGMENT;
* @return The end index of the run.
*/ throw new InvalidObjectException ("Can't resolve Attribute: " + getName());
int getRunLimit (Set attribs); }
/** /**
* This methods returns the index of the character after the end of the run * This method tests this object for equality against the specified object.
* that contains the specified attribute defined for the current character. * The two objects will be considered equal if and only if:
* * <ul>
* @param attrib The attribute. * <li>The specified object is not <code>null</code>.
* * <li>The specified object is an instance of <code>AttributedCharacterIterator.Attribute</code>.
* @return The end index of the run. * <li>The specified object has the same attribute name as this object.
*/ * </ul>
int getRunLimit (AttributedCharacterIterator.Attribute attrib); *
* @param The <code>Object</code> to test for equality against this object.
*
* @return <code>true</code> if the specified object is equal to this one, <code>false</code> 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 <code>String</code> representation of this object.
*
* @return A <code>String</code> 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 <code>Map</code> of the attributed defined for
* the current character.
*
* @return A <code>Map</code> 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, <code>null</code> 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 <code>Set</code> defined for
* the current character.
*
* @param attribs The <code>Set</code> 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 <code>Set</code> defined
* for the current character.
*
* @param attribs The <code>Set</code> 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 } // interface AttributedCharacterIterator
...@@ -140,4 +140,5 @@ public interface CharacterIterator extends Cloneable ...@@ -140,4 +140,5 @@ public interface CharacterIterator extends Cloneable
* @return A copy of this <code>CharacterIterator</code>. * @return A copy of this <code>CharacterIterator</code>.
*/ */
Object clone(); Object clone();
}
} // interface CharacterIterator
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment