Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/text/FieldPosition#pubctors) \| [Methods](https://developer.android.com/reference/java/text/FieldPosition#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/text/FieldPosition#inhmethods)

# FieldPosition

` public class FieldPosition `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.text.FieldPosition |

<br />

*** ** * ** ***

`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`.
**See also:**

- `https://developer.android.com/reference/java/text/Format`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/text/FieldPosition#FieldPosition(int)(int field) ` Creates a FieldPosition object for the given field. |
| ` https://developer.android.com/reference/java/text/FieldPosition#FieldPosition(java.text.Format.Field)(https://developer.android.com/reference/java/text/Format.Field attribute) ` Creates a FieldPosition object for the given field constant. |
| ` https://developer.android.com/reference/java/text/FieldPosition#FieldPosition(java.text.Format.Field,%20int)(https://developer.android.com/reference/java/text/Format.Field attribute, int fieldID) ` Creates a `FieldPosition` object for the given field. |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/java/text/FieldPosition#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Overrides equals |
| ` int` | ` https://developer.android.com/reference/java/text/FieldPosition#getBeginIndex()() ` Retrieves the index of the first character in the requested field. |
| ` int` | ` https://developer.android.com/reference/java/text/FieldPosition#getEndIndex()() ` Retrieves the index of the character following the last character in the requested field. |
| ` int` | ` https://developer.android.com/reference/java/text/FieldPosition#getField()() ` Retrieves the field identifier. |
| ` https://developer.android.com/reference/java/text/Format.Field` | ` https://developer.android.com/reference/java/text/FieldPosition#getFieldAttribute()() ` Returns the field identifier as an attribute constant from one of the `Field` subclasses. |
| ` int` | ` https://developer.android.com/reference/java/text/FieldPosition#hashCode()() ` Returns a hash code for this FieldPosition. |
| ` void` | ` https://developer.android.com/reference/java/text/FieldPosition#setBeginIndex(int)(int bi) ` Sets the begin index. |
| ` void` | ` https://developer.android.com/reference/java/text/FieldPosition#setEndIndex(int)(int ei) ` Sets the end index. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/text/FieldPosition#toString()() ` Return a string representation of this FieldPosition. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### FieldPosition

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `field` | `int`: the field identifier <br /> |

**See also:**

- `https://developer.android.com/reference/java/text/NumberFormat#INTEGER_FIELD`
- `https://developer.android.com/reference/java/text/NumberFormat#FRACTION_FIELD`
- `https://developer.android.com/reference/java/text/DateFormat#YEAR_FIELD`
- `https://developer.android.com/reference/java/text/DateFormat#MONTH_FIELD`

### FieldPosition

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `attribute` | `Format.Field`: Format.Field constant identifying a field <br /> |

### FieldPosition

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Parameters ||
|---|---|
| `attribute` | `Format.Field`: Format.Field constant identifying a field <br /> |
| `fieldID` | `int`: integer constant identifying a field <br /> |

## Public methods

### equals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object obj)
```

Overrides equals

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getBeginIndex

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getBeginIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | the begin index <br /> |

### getEndIndex

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getEndIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | the end index <br /> |

### getField

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getField ()
```

Retrieves the field identifier.

<br />

| Returns ||
|---|---|
| `int` | the field identifier <br /> |

### getFieldAttribute

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/text/Format.Field` | Identifier for the field <br /> |

### hashCode

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code for this FieldPosition.

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object <br /> |

### setBeginIndex

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setBeginIndex (int bi)
```

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

<br />

| Parameters ||
|---|---|
| `bi` | `int`: the begin index <br /> |

### setEndIndex

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setEndIndex (int ei)
```

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

<br />

| Parameters ||
|---|---|
| `ei` | `int`: the end index <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Return a string representation of this FieldPosition.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of this object <br /> |