public class

FieldPosition

extends Object
java.lang.Object
   ↳ java.text.FieldPosition

Class Overview

Identifies fields in formatted strings. If a FieldPosition is passed to the format method with such a parameter, then the indices will be set to the start and end indices of the field in the formatted string.

A FieldPosition can be created by using the integer constants in the various format classes (for example NumberFormat.INTEGER_FIELD) or one of the fields of type Format.Field.

If more than one field information is needed, the method formatToCharacterIterator(Object) should be used.

Summary

Public Constructors
FieldPosition(int field)
Constructs a new FieldPosition for the specified field.
FieldPosition(Format.Field attribute)
Constructs a new FieldPosition for the specified Field attribute.
FieldPosition(Format.Field attribute, int field)
Constructs a new FieldPosition for the specified Field attribute and field id.
Public Methods
boolean equals(Object object)
Compares the specified object to this field position and indicates if they are equal.
int getBeginIndex()
Returns the index of the beginning of the field.
int getEndIndex()
Returns the index one past the end of the field.
int getField()
Returns the field which is being identified.
Format.Field getFieldAttribute()
Returns the attribute which is being identified.
int hashCode()
Returns an integer hash code for this object.
void setBeginIndex(int index)
Sets the index of the beginning of the field.
void setEndIndex(int index)
Sets the index of the end of the field.
String toString()
Returns the string representation of this field position.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FieldPosition (int field)

Since: API Level 1

Constructs a new FieldPosition for the specified field.

Parameters
field the field to identify.

public FieldPosition (Format.Field attribute)

Since: API Level 1

Constructs a new FieldPosition for the specified Field attribute.

Parameters
attribute the field attribute to identify.

public FieldPosition (Format.Field attribute, int field)

Since: API Level 1

Constructs a new FieldPosition for the specified Field attribute and field id.

Parameters
attribute the field attribute to identify.
field the field to identify.

Public Methods

public boolean equals (Object object)

Since: API Level 1

Compares the specified object to this field position and indicates if they are equal. In order to be equal, object must be an instance of FieldPosition with the same field, begin index and end index.

Parameters
object the object to compare with this object.
Returns
  • true if the specified object is equal to this field position; false otherwise.
See Also

public int getBeginIndex ()

Since: API Level 1

Returns the index of the beginning of the field.

Returns
  • the first index of the field.

public int getEndIndex ()

Since: API Level 1

Returns the index one past the end of the field.

Returns
  • one past the index of the last character in the field.

public int getField ()

Since: API Level 1

Returns the field which is being identified.

Returns
  • the field constant.

public Format.Field getFieldAttribute ()

Since: API Level 1

Returns the attribute which is being identified.

Returns
  • the field.

public int hashCode ()

Since: API Level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public void setBeginIndex (int index)

Since: API Level 1

Sets the index of the beginning of the field.

Parameters
index the index of the first character in the field.

public void setEndIndex (int index)

Since: API Level 1

Sets the index of the end of the field.

Parameters
index one past the index of the last character in the field.

public String toString ()

Since: API Level 1

Returns the string representation of this field position.

Returns
  • the string representation of this field position.