public class FieldPosition extends Object
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
.
Format
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.
field
- the field identifierNumberFormat.INTEGER_FIELD
, NumberFormat.FRACTION_FIELD
, DateFormat.YEAR_FIELD
, DateFormat.MONTH_FIELD
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 calling new FieldPosition(attribute, -1)
.
attribute
- Format.Field constant identifying a fieldpublic 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.
attribute
- Format.Field constant identifying a fieldfieldID
- integer constant identifying a fieldpublic 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.
public int getField()
Retrieves the field identifier.
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 void setBeginIndex(int bi)
Sets the begin index. For use by subclasses of Format.
bi
- the begin indexpublic void setEndIndex(int ei)
Sets the end index. For use by subclasses of Format.
ei
- the end indexpublic boolean equals(Object obj)
Overrides equals
equals
in class Object
obj
- the reference object with which to compare.true
if this object is the same as the obj argument; false
otherwise.Object.hashCode()
, HashMap
public int hashCode()
Returns a hash code for this FieldPosition.
hashCode
in class Object
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
public String toString()
Return a string representation of this FieldPosition.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.