Класс FieldPosition

java.lang.Object
- java.text.FieldPosition

public class FieldPosition
extends Object

FieldPosition — это простой класс, используемый Format и его подклассами для идентификации полей в отформатированном выводе. Поля можно идентифицировать двумя способами:

По целочисленной константе, имена которых обычно оканчиваются на _FIELD. Константы определены в различных подклассах Format.
По константе Format.Field, см. ERA_FIELD и её аналоги в DateFormat для примера.

FieldPosition отслеживает положение поля в отформатированном выводе с помощью двух индексов: индекс первого символа поля и индекс последнего символа поля.

Один из вариантов метода format в различных классах Format требует объекта FieldPosition в качестве аргумента. Вы используете этот метод format для выполнения частичной форматирования или получения информации об отформатированном выводе (например, о положении поля).

Если вас интересуют позиции всех атрибутов в отформатированной строке, используйте метод Format formatToCharacterIterator.

Since:: 1.1
See Also:: Format

Конструкторы

Конструктор	Описание
`FieldPosition(int field)`	Создаёт объект FieldPosition для заданного поля.
`FieldPosition(Format.Field attribute)`	Создаёт объект FieldPosition для заданной константы поля.
`FieldPosition(Format.Field attribute, int fieldID)`	Создаёт объект `FieldPosition` для заданного поля.

Методы

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object obj)`	Переопределяет equals
`int`	`getBeginIndex()`	Возвращает индекс первого символа в запрошенном поле.
`int`	`getEndIndex()`	Возвращает индекс символа, следующего за последним символом в запрошенном поле.
`int`	`getField()`	Возвращает идентификатор поля.
`Format.Field`	`getFieldAttribute()`	Возвращает идентификатор поля как константу атрибута из одного из подклассов `Field`.
`int`	`hashCode()`	Возвращает хэш-код для этого FieldPosition.
`void`	`setBeginIndex(int bi)`	Устанавливает начальный индекс.
`void`	`setEndIndex(int ei)`	Устанавливает конечный индекс.
`String`	`toString()`	Возвращает строковое представление этого FieldPosition.

Методы, объявленные в классе java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Конструкторы

FieldPosition

public FieldPosition(int field)

Создаёт объект FieldPosition для заданного поля. Поля идентифицируются константами, имена которых обычно оканчиваются на _FIELD, в различных подклассах Format.

Parameters:: field — идентификатор поля
See Also:: NumberFormat.INTEGER_FIELD, NumberFormat.FRACTION_FIELD, DateFormat.YEAR_FIELD, DateFormat.MONTH_FIELD

FieldPosition

public FieldPosition(Format.Field attribute)

Создаёт объект FieldPosition для заданной константы поля. Поля идентифицируются константами, определёнными в различных подклассах Format. Это эквивалентно вызову new FieldPosition(attribute, -1).

Parameters:: attribute — константа Format.Field, идентифицирующая поле
Since:: 1.4

FieldPosition

public FieldPosition(Format.Field attribute,
                     int fieldID)

Создаёт объект FieldPosition для заданного поля. Поле идентифицируется константой атрибута из одного из подклассов Field, а также целочисленным идентификатором поля, определённым подклассами Format.

Подклассы Format которые осведомлены о Field должны отдавать предпочтение attribute и игнорировать fieldID если attribute не равен null. Однако более старые подклассы Format могут не знать о Field и полагаться на fieldID.

Если поле не имеет соответствующей целочисленной константы, fieldID должно быть равно -1.

Parameters:: attribute — константа Format.Field, идентифицирующая поле; fieldID — целочисленная константа, идентифицирующая поле
Since:: 1.4

Методы

getFieldAttribute

public Format.Field getFieldAttribute()

Возвращает идентификатор поля как константу атрибута из одного из подклассов Field. Может возвращать null, если поле указано только целочисленным идентификатором.

Returns:: Идентификатор поля
Since:: 1.4

getField

public int getField()

Возвращает идентификатор поля.

Returns:: идентификатор поля

getBeginIndex

public int getBeginIndex()

Возвращает индекс первого символа в запрошенном поле.

Returns:: начальный индекс

getEndIndex

public int getEndIndex()

Возвращает индекс символа, следующего за последним символом в запрошенном поле.

Returns:: конечный индекс

setBeginIndex

public void setBeginIndex(int bi)

Устанавливает начальный индекс. Для использования подклассами Format.

Parameters:: bi — начальный индекс
Since:: 1.2

setEndIndex

public void setEndIndex(int ei)

Устанавливает конечный индекс. Для использования подклассами Format.

Parameters:: ei — конечный индекс
Since:: 1.2

equals

public boolean equals(Object obj)

Переопределяет equals

Overrides:: equals в классе Object
Parameters:: obj — объект-ссылка для сравнения.
Returns:: true если этот объект такой же, как аргумент obj; false в противном случае.
See Also:: Object.hashCode(), HashMap

hashCode

public int hashCode()

Возвращает хэш-код для этого FieldPosition.

Overrides:: hashCode в классе Object
Returns:: значение хэш-кода для этого объекта
See Also:: Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Возвращает строковое представление этого FieldPosition.

Overrides:: toString в классе Object
Returns:: строковое представление этого объекта