java.text

Class FieldPosition

java.lang.Object

java.text.FieldPosition

public class FieldPosition
extends Object

FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted output. Fields are identified by constants, whose names typically end with _FIELD, defined in the various subclasses of Format. 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).

See Also:

Format

Constructor Summary

Constructors

Constructor and Description
FieldPosition(int field) Creates a FieldPosition object for the given field.

Method Summary

Modifier and Type	Method and Description
int	getBeginIndex() Retrieve the index of the first character in the requested field.
int	getEndIndex() Retrieve the index of the character following the last character in the requested field.
int	getField() Retrieve the field identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

See Also:

NumberFormat.INTEGER_FIELD, NumberFormat.FRACTION_FIELD, DateFormat.YEAR_FIELD, DateFormat.MONTH_FIELD

Method Detail

getField

public int getField()

Retrieve the field identifier.

Returns:

identifier

getBeginIndex

public int getBeginIndex()

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

Returns:

index

getEndIndex

public int getEndIndex()

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

Returns:

index