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:
- By an integer constant, whose names typically end with
_FIELD. The constants are defined in the various subclasses ofFormat. - By a
Format.Fieldconstant, seeERA_FIELDand its friends inDateFormatfor 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.
- Since:
- 1.1
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionFieldPosition(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 aFieldPositionobject for the given field. -
Method Summary
Modifier and TypeMethodDescriptionbooleanOverrides equalsintRetrieves the index of the first character in the requested field.intRetrieves the index of the character following the last character in the requested field.intgetField()Retrieves the field identifier.Returns the field identifier as an attribute constant from one of theFieldsubclasses.inthashCode()Returns a hash code for this FieldPosition.voidsetBeginIndex(int bi) Sets the begin index.voidsetEndIndex(int ei) Sets the end index.toString()Return a string representation of this FieldPosition.
-
Constructor Details
-
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.- Parameters:
field- the field identifier- See Also:
-
FieldPosition
Creates a FieldPosition object for the given field constant. Fields are identified by constants defined in the variousFormatsubclasses. This is equivalent to callingnew FieldPosition(attribute, -1).- Parameters:
attribute- Format.Field constant identifying a field- Since:
- 1.4
-
FieldPosition
Creates aFieldPositionobject for the given field. The field is identified by an attribute constant from one of theFieldsubclasses as well as an integer field ID defined by theFormatsubclasses.Formatsubclasses that are aware ofFieldshould give precedence toattributeand ignorefieldIDifattributeis not null. However, olderFormatsubclasses may not be aware ofFieldand rely onfieldID. If the field has no corresponding integer constant,fieldIDshould be -1.- Parameters:
attribute- Format.Field constant identifying a fieldfieldID- integer constant identifying a field- Since:
- 1.4
-
-
Method Details
-
getFieldAttribute
Returns the field identifier as an attribute constant from one of theFieldsubclasses. 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.- Returns:
- the field identifier
-
getBeginIndex
public int getBeginIndex()Retrieves the index of the first character in the requested field.- Returns:
- the begin index
-
getEndIndex
public int getEndIndex()Retrieves the index of the character following the last character in the requested field.- Returns:
- the end index
-
setBeginIndex
public void setBeginIndex(int bi) Sets the begin index. For use by subclasses of Format.- Parameters:
bi- the begin index- Since:
- 1.2
-
setEndIndex
public void setEndIndex(int ei) Sets the end index. For use by subclasses of Format.- Parameters:
ei- the end index- Since:
- 1.2
-
equals
Overrides equals -
hashCode
public int hashCode()Returns a hash code for this FieldPosition. -
toString
Return a string representation of this FieldPosition.
-