FieldPosition (Java 2 Platform SE 5.0) (original) (raw)

java.text

Class FieldPosition

java.lang.Object extended by java.text.FieldPosition

public class FieldPosition

FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted output. Fields can be identified in two ways:

By an integer constant, whose names typically end with_FIELD. The constants are defined in the various subclasses of Format.
By a Format.Field constant, see ERA_FIELD and its friends in DateFormat for an example.

FieldPosition keeps track of the position of the field within the formatted output with two indices: the index of the first character of the field and the index of the last character of the field.

One version of the format method in the variousFormat classes requires a FieldPosition object as an argument. You use this format method to perform partial formatting or to get information about the formatted output (such as the position of a field).

If you are interested in the positions of all attributes in the formatted string use the Format methodformatToCharacterIterator.

See Also:

Format

Constructor Summary
FieldPosition(Format.Field attribute) Creates a FieldPosition object for the given field constant.
[FieldPosition](../../java/text/FieldPosition.html#FieldPosition%28java.text.Format.Field, int%29)(Format.Field attribute, int fieldID) Creates a FieldPosition object for the given field.
FieldPosition(int field) Creates a FieldPosition object for the given field.

Method Summary
boolean	equals(Object obj) Overrides equals
int	getBeginIndex() Retrieves the index of the first character in the requested field.
int	getEndIndex() Retrieves the index of the character following the last character in the requested field.
int	getField() Retrieves the field identifier.
Format.Field	getFieldAttribute() Returns the field identifier as an attribute constant from one of the Field subclasses.
int	hashCode() Returns a hash code for this FieldPosition.
void	setBeginIndex(int bi) Sets the begin index.
void	setEndIndex(int ei) Sets the end index.
String	toString() Return a string representation of this FieldPosition.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

FieldPosition

public FieldPosition(int field)

Creates a FieldPosition object for the given field. Fields are identified by constants, whose names typically end with _FIELD, in the various subclasses of Format.

FieldPosition

public FieldPosition(Format.Field attribute)

Creates a FieldPosition object for the given field constant. Fields are identified by constants defined in the various Format subclasses. This is equivalent to callingnew FieldPosition(attribute, -1).

Parameters:

attribute - Format.Field constant identifying a field

Since:

1.4

FieldPosition

public FieldPosition(Format.Field attribute, int fieldID)

Creates a FieldPosition object for the given field. The field is identified by an attribute constant from one of theField subclasses as well as an integer field ID defined by the Format subclasses. Format subclasses that are aware of Field should give precedence to attribute and ignore fieldID ifattribute is not null. However, older Format subclasses may not be aware of Field and rely onfieldID. If the field has no corresponding integer constant, fieldID should be -1.

Parameters:

attribute - Format.Field constant identifying a field

fieldID - integer constantce identifying a field

Since:

1.4

Method Detail

getFieldAttribute

public Format.Field getFieldAttribute()

Returns the field identifier as an attribute constant from one of the Field subclasses. May return null if the field is specified only by an integer field ID.

Returns:

Identifier for the field

Since:

1.4

getField

public int getField()

Retrieves the field identifier.

getBeginIndex

public int getBeginIndex()

Retrieves the index of the first character in the requested field.

getEndIndex

public int getEndIndex()

Retrieves the index of the character following the last character in the requested field.

setBeginIndex

public void setBeginIndex(int bi)

Sets the begin index. For use by subclasses of Format.

Since:

1.2

setEndIndex

public void setEndIndex(int ei)

Sets the end index. For use by subclasses of Format.

Since:

1.2

equals

public boolean equals(Object obj)

Overrides equals

Overrides:

[equals](../../java/lang/Object.html#equals%28java.lang.Object%29) 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(), Hashtable

hashCode

public int hashCode()

Returns a hash code for this FieldPosition.

Overrides:

[hashCode](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a hash code value for this object

toString

public String toString()

Return a string representation of this FieldPosition.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a string representation of this object

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.