Class: java.text.FieldPosition

  • public class 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.

Authors:
@author Mark Davis
See:
@see java.text.Format
Version:
@version 1.21 12/19/03

Inheritance

Superclass tree:

Methods

  • FieldPositiontop

    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.
    See:
    @see java.text.NumberFormat.INTEGER_FIELD
    @see java.text.NumberFormat.FRACTION_FIELD
    @see java.text.DateFormat.YEAR_FIELD
    @see java.text.DateFormat.MONTH_FIELD
    Related Links:
    Google Code Search
    Stack Overflow

  • FieldPositiontop

    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).
    Parameters:
    @param attribute Format.Field constant identifying a field
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • FieldPositiontop

    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.
    Parameters:
    @param attribute Format.Field constant identifying a field
    @param fieldID integer constantce identifying a field
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • equalstop

    public boolean equals(Object obj)
    Overrides equals
    Parameters:
    @param obj the reference object with which to compare.
    Return:
    @return true if this object is the same as the obj argument; false otherwise.
    Override hierarchy:
    equals from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • getBeginIndextop

    public int getBeginIndex()
    Retrieves the index of the first character in the requested field.
    Related Links:
    Google Code Search
    Stack Overflow

  • getEndIndextop

    public int getEndIndex()
    Retrieves the index of the character following the last character in the requested field.
    Related Links:
    Google Code Search
    Stack Overflow

  • getFieldtop

    public int getField()
    Retrieves the field identifier.
    Related Links:
    Google Code Search
    Stack Overflow

  • getFieldAttributetop

    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.
    Return:
    @return Identifier for the field
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • hashCodetop

    public int hashCode()
    Returns a hash code for this FieldPosition.
    Return:
    @return a hash code value for this object
    Override hierarchy:
    hashCode from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • setBeginIndextop

    public void setBeginIndex(int bi)
    Sets the begin index. For use by subclasses of Format.
    Since:
    @since 1.2
    Related Links:
    Google Code Search
    Stack Overflow

  • setEndIndextop

    public void setEndIndex(int ei)
    Sets the end index. For use by subclasses of Format.
    Since:
    @since 1.2
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Return a string representation of this FieldPosition.
    Return:
    @return a string representation of this object
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow