|
| |
|
| java.lang.Object
 java.text.FieldPosition
All known Subclasses: java.text.DontCareFieldPosition,
| FieldPosition | | public class FieldPosition (Code) | | 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 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.
version:
1.23 10/10/06
author:
Mark Davis
See Also: java.text.Format |
| Field Summary | |
| int | beginIndex
Output: Start offset of field in text. | | int | endIndex
Output: End offset of field in text. | | int | field
Input: Desired field to determine start and end offsets for. |
| Constructor Summary | |
| public | FieldPosition(int field)
Creates a FieldPosition object for the given field. | | public | FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant. | | 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 the
Field subclasses as well as an integer field ID
defined by the Format subclasses. |
| Method Summary | |
| public boolean | equals(Object obj)
| | public int | getBeginIndex()
Retrieves the index of the first character in the requested field. | | public int | getEndIndex()
Retrieves the index of the character following the last character in the
requested field. | | public int | getField()
Retrieves the field identifier. | | public Format.Field | getFieldAttribute()
Returns the field identifier as an attribute constant
from one of the Field subclasses. | | Format.FieldDelegate | getFieldDelegate()
Returns a Format.FieldDelegate instance that is associated
with the FieldPosition. | | public int | hashCode()
Returns a hash code for this FieldPosition. | | public void | setBeginIndex(int bi)
Sets the begin index. | | public void | setEndIndex(int ei)
Sets the end index. | | public String | toString()
Return a string representation of this FieldPosition. |
| beginIndex | | int beginIndex(Code) | | Output: Start offset of field in text.
If the field does not occur in the text, 0 is returned.
|
| endIndex | | int endIndex(Code) | | Output: End offset of field in text.
If the field does not occur in the text, 0 is returned.
|
| field | | int field(Code) | | Input: Desired field to determine start and end offsets for.
The meaning depends on the subclass of Format.
|
| FieldPosition | | public FieldPosition(Format.Field attribute)(Code) | | 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 constant identifying a field
since:
1.4 |
| FieldPosition | | public FieldPosition(Format.Field attribute, int fieldID)(Code) | | 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 constant identifying a field
Parameters:
fieldID - integer constantce identifying a field
since:
1.4 |
| equals | | public boolean equals(Object obj)(Code) | | Overrides equals
|
| getBeginIndex | | public int getBeginIndex()(Code) | | Retrieves the index of the first character in the requested field.
|
| getEndIndex | | public int getEndIndex()(Code) | | Retrieves the index of the character following the last character in the
requested field.
|
| getField | | public int getField()(Code) | | Retrieves the field identifier.
|
| getFieldAttribute | | public Format.Field getFieldAttribute()(Code) | | 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.
Identifier for the field
since:
1.4 |
| getFieldDelegate | | Format.FieldDelegate getFieldDelegate()(Code) | | Returns a Format.FieldDelegate instance that is associated
with the FieldPosition. When the delegate is notified of the same
field the FieldPosition is associated with, the begin/end will be
adjusted.
|
| hashCode | | public int hashCode()(Code) | | Returns a hash code for this FieldPosition.
a hash code value for this object |
| setBeginIndex | | public void setBeginIndex(int bi)(Code) | | Sets the begin index. For use by subclasses of Format.
since:
1.2 |
| setEndIndex | | public void setEndIndex(int ei)(Code) | | Sets the end index. For use by subclasses of Format.
since:
1.2 |
| toString | | public String toString()(Code) | | Return a string representation of this FieldPosition.
a string representation of this object |
|
|
|