FieldPosition (Java Platform SE 8 ) (original) (raw)

• 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 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 variousFormat 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 methodformatToCharacterIterator.
  See Also:
  Format

• • Constructor Summary

  Constructors

  Constructor	Description
  FieldPosition(Format.Field attribute)	Creates a FieldPosition object for the given field constant.
  FieldPosition(Format.Field attribute, int fieldID)	Creates a FieldPosition object for the given field.
  FieldPosition(int field)	Creates a FieldPosition object for the given field.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	equals(Object obj)	Overrides equals
  int	getBeginIndex()	Retrieves the index of the first character in the requested field.
  int	getEndIndex()	Retrieves the index of the character following the last character in the requested field.
  int	getField()	Retrieves the field identifier.
  Format.Field	getFieldAttribute()	Returns the field identifier as an attribute constant from one of the Field subclasses.
  int	hashCode()	Returns a hash code for this FieldPosition.
  void	setBeginIndex(int bi)	Sets the begin index.
  void	setEndIndex(int ei)	Sets the end index.
  String	toString()	Return a string representation of this FieldPosition.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • 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 identifier  
     See Also:  
     [NumberFormat.INTEGER\_FIELD](../../java/text/NumberFormat.html#INTEGER%5FFIELD), [NumberFormat.FRACTION\_FIELD](../../java/text/NumberFormat.html#FRACTION%5FFIELD), [DateFormat.YEAR\_FIELD](../../java/text/DateFormat.html#YEAR%5FFIELD), [DateFormat.MONTH\_FIELD](../../java/text/DateFormat.html#MONTH%5FFIELD)  
     * #### FieldPosition  
     public FieldPosition([Format.Field](../../java/text/Format.Field.html "class in java.text") 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)`.  
     Parameters:  
     `attribute` \- Format.Field constant identifying a field  
     Since:  
     1.4  
     * #### FieldPosition  
     public FieldPosition([Format.Field](../../java/text/Format.Field.html "class in java.text") 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.  
     Parameters:  
     `attribute` \- Format.Field constant identifying a field  
     `fieldID` \- integer constant identifying a field  
     Since:  
     1.4  

  • Method Detail

    * #### getFieldAttribute  
    public [Format.Field](../../java/text/Format.Field.html "class in java.text") 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.  
    Returns:  
    Identifier for the field  
    Since:  
    1.4  
    * #### getField  
    public int getField()  
    Retrieves the field identifier.  
    Returns:  
    the field identifier  
    * #### getBeginIndex  
    public int getBeginIndex()  
    Retrieves the index of the first character in the requested field.  
    Returns:  
    the begin index  
    * #### getEndIndex  
    public int getEndIndex()  
    Retrieves the index of the character following the last character in the requested field.  
    Returns:  
    the end index  
    * #### setBeginIndex  
    public void setBeginIndex(int bi)  
    Sets the begin index. For use by subclasses of Format.  
    Parameters:  
    `bi` \- the begin index  
    Since:  
    1.2  
    * #### setEndIndex  
    public void setEndIndex(int ei)  
    Sets the end index. For use by subclasses of Format.  
    Parameters:  
    `ei` \- the end index  
    Since:  
    1.2  
    * #### equals  
    public boolean equals([Object](../../java/lang/Object.html "class in java.lang") obj)  
    Overrides equals  
    Overrides:  
    `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Parameters:  
    `obj` \- the reference object with which to compare.  
    Returns:  
    `true` if this object is the same as the obj argument; `false` otherwise.  
    See Also:  
    [Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
    * #### hashCode  
    public int hashCode()  
    Returns a hash code for this FieldPosition.  
    Overrides:  
    `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a hash code value for this object  
    See Also:  
    [Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString()  
    Return a string representation of this FieldPosition.  
    Overrides:  
    `[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a string representation of this object

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.