FieldPosition

open class FieldPosition
kotlin.Any
   ↳ 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 of Format.
  • By a 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.

Summary

Public constructors
<init>(field: Int)

Creates a FieldPosition object for the given field.

<init>(attribute: Format.Field!)

Creates a FieldPosition object for the given field constant.

<init>(attribute: Format.Field!, fieldID: Int)

Creates a FieldPosition object for the given field.

Public methods
open Int

Retrieves the field identifier.

open Int

Returns a hash code for this FieldPosition.

open Boolean
equals(other: Any?)

Overrides equals

open Format.Field!

Returns the field identifier as an attribute constant from one of the Field subclasses.

open String

Return a string representation of this FieldPosition.

open Unit

Sets the begin index.

open Unit

Sets the end index.

open Int

Retrieves the index of the first character in the requested field.

open Int

Retrieves the index of the character following the last character in the requested field.

Public constructors

<init>

FieldPosition(field: Int)

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 Int: the field identifier

<init>

added in API level 1.4
FieldPosition(attribute: Format.Field!)

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).

Parameters
attribute Format.Field!: Format.Field constant identifying a field

<init>

added in API level 1.4
FieldPosition(attribute: Format.Field!, fieldID: Int)

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.

Parameters
attribute Format.Field!: Format.Field constant identifying a field
fieldID Format.Field!: integer constant identifying a field

Public methods

getField

open fun getField(): Int

Retrieves the field identifier.

Return
Int: the field identifier

hashCode

open fun hashCode(): Int

Returns a hash code for this FieldPosition.

Return
Int: a hash code value for this object

equals

open fun equals(other: Any?): Boolean

Overrides equals

Parameters
obj Any?: the reference object with which to compare.
Return
Boolean: true if this object is the same as the obj argument; false otherwise.

getFieldAttribute

added in API level 1.4
open fun getFieldAttribute(): Format.Field!

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.

Return
Format.Field!: Identifier for the field

toString

open fun toString(): String

Return a string representation of this FieldPosition.

Return
String: a string representation of this object

setBeginIndex

added in API level 1.2
open fun setBeginIndex(bi: Int): Unit

Sets the begin index. For use by subclasses of Format.

Parameters
bi Int: the begin index

setEndIndex

added in API level 1.2
open fun setEndIndex(ei: Int): Unit

Sets the end index. For use by subclasses of Format.

Parameters
ei Int: the end index

getBeginIndex

open fun getBeginIndex(): Int

Retrieves the index of the first character in the requested field.

Return
Int: the begin index

getEndIndex

open fun getEndIndex(): Int

Retrieves the index of the character following the last character in the requested field.

Return
Int: the end index