public
class
FieldPosition
extends Object
| java.lang.Object | |
| ↳ | java.text.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:
Developers
_FIELD. The constants are defined in the various
subclasses of Format.
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 various
Format 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 method
formatToCharacterIterator.
See also:
Public constructors | |
|---|---|
FieldPosition(int field)
Creates a FieldPosition object for the given field. |
|
FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant. |
|
FieldPosition(Format.Field attribute, int fieldID)
Creates a |
|
Public methods | |
|---|---|
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 |
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. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
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.
| Parameters | |
|---|---|
field |
int
|
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 calling
new FieldPosition(attribute, -1).
| Parameters | |
|---|---|
attribute |
Format.Field:
Format.Field constant identifying a field |
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 the
Field 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 if
attribute is not null. However, older Format
subclasses may not be aware of Field and rely on
fieldID. If the field has no corresponding integer
constant, fieldID should be -1.
| Parameters | |
|---|---|
attribute |
Format.Field:
Format.Field constant identifying a field |
fieldID |
int:
integer constantce identifying a field |
boolean equals (Object obj)
Overrides equals
| Parameters | |
|---|---|
obj |
Object:
the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
int getBeginIndex ()
Retrieves the index of the first character in the requested field.
| Returns | |
|---|---|
int |
|
int getEndIndex ()
Retrieves the index of the character following the last character in the requested field.
| Returns | |
|---|---|
int |
|
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 | |
|---|---|
Format.Field |
Identifier for the field |
int hashCode ()
Returns a hash code for this FieldPosition.
| Returns | |
|---|---|
int |
a hash code value for this object |
void setBeginIndex (int bi)
Sets the begin index. For use by subclasses of Format.
| Parameters | |
|---|---|
bi |
int
|
void setEndIndex (int ei)
Sets the end index. For use by subclasses of Format.
| Parameters | |
|---|---|
ei |
int
|
String toString ()
Return a string representation of this FieldPosition.
| Returns | |
|---|---|
String |
a string representation of this object |