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:
_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
.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a FieldPosition object for the given field.
| |||||||||||
Creates a FieldPosition object for the given field constant.
| |||||||||||
Creates a
FieldPosition object for the given field. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Overrides equals
| |||||||||||
Retrieves the index of the first character in the requested field.
| |||||||||||
Retrieves the index of the character following the last character in the
requested field.
| |||||||||||
Retrieves the field identifier.
| |||||||||||
Returns the field identifier as an attribute constant
from one of the
Field subclasses. | |||||||||||
Returns a hash code for this FieldPosition.
| |||||||||||
Sets the begin index.
| |||||||||||
Sets the end index.
| |||||||||||
Return a string representation of this FieldPosition.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
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.
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)
.
attribute | Format.Field constant identifying a field |
---|
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.
attribute | Format.Field constant identifying a field |
---|---|
fieldID | integer constantce identifying a field |
Overrides equals
obj | the reference object with which to compare. |
---|
true
if this object is the same as the obj
argument; false
otherwise.Retrieves the index of the first character in the requested field.
Retrieves the index of the character following the last character in the requested field.
Retrieves the field identifier.
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 a hash code for this FieldPosition.
Sets the begin index. For use by subclasses of Format.
Sets the end index. For use by subclasses of Format.
Return a string representation of this FieldPosition.