- java.lang.Object
-
- java.text.FieldPosition
-
public class FieldPosition extends Object
FieldPosition
is a simple class used byFormat
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.Field
constant, seeERA_FIELD
and its friends inDateFormat
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 variousFormat
classes requires aFieldPosition
object as an argument. You use thisformat
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
methodformatToCharacterIterator
.- Since:
- 1.1
- See Also:
Format
- By an integer constant, whose names typically end with
-
-
Constructor Summary
Constructors Constructor Description FieldPosition(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 aFieldPosition
object for the given field.
-
Method Summary
Modifier and Type Method Description boolean
equals(Object obj)
Overrides equalsint
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 theField
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.
-
-
-
Constructor Detail
-
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:
NumberFormat.INTEGER_FIELD
,NumberFormat.FRACTION_FIELD
,DateFormat.YEAR_FIELD
,DateFormat.MONTH_FIELD
-
FieldPosition
public FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant. Fields are identified by constants defined in the variousFormat
subclasses. This is equivalent to callingnew FieldPosition(attribute, -1)
.- Parameters:
attribute
- Format.Field constant identifying a field- Since:
- 1.4
-
FieldPosition
public FieldPosition(Format.Field attribute, int fieldID)
Creates aFieldPosition
object for the given field. The field is identified by an attribute constant from one of theField
subclasses as well as an integer field ID defined by theFormat
subclasses.Format
subclasses that are aware ofField
should give precedence toattribute
and ignorefieldID
ifattribute
is not null. However, olderFormat
subclasses may not be aware ofField
and rely onfieldID
. If the field has no corresponding integer constant,fieldID
should be -1.- Parameters:
attribute
- Format.Field constant identifying a fieldfieldID
- integer constant identifying a field- Since:
- 1.4
-
-
Method Detail
-
getFieldAttribute
public Format.Field getFieldAttribute()
Returns the field identifier as an attribute constant from one of theField
subclasses. 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
public boolean equals(Object obj)
Overrides equals- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns a hash code for this FieldPosition.- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-