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| Constructor and Description |
|---|
FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant.
|
FieldPosition(Format.Field attribute,
int fieldID)
Creates a
FieldPosition object for the given field. |
FieldPosition(int field)
Creates a FieldPosition object for the given field.
|
| Modifier and Type | Method and Description |
|---|---|
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
Field subclasses. |
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.
|
public FieldPosition(int field)
field - the field identifierNumberFormat.INTEGER_FIELD,
NumberFormat.FRACTION_FIELD,
DateFormat.YEAR_FIELD,
DateFormat.MONTH_FIELDpublic FieldPosition(Format.Field attribute)
Format
subclasses. This is equivalent to calling
new FieldPosition(attribute, -1).attribute - Format.Field constant identifying a fieldpublic FieldPosition(Format.Field attribute, int fieldID)
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()
Field subclasses. May return null if
the field is specified only by an integer field ID.public int getField()
public int getBeginIndex()
public int getEndIndex()
public void setBeginIndex(int bi)
bi - the begin indexpublic void setEndIndex(int ei)
ei - the end indexpublic boolean equals(Object obj)
equals in class Objectobj - the reference object with which to compare.true if this object is the same as the obj
argument; false otherwise.Object.hashCode(),
HashMappublic int hashCode()
hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object) Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.