Class FieldPosition

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.

  See Also:

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

• FieldPosition

  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:

  attribute - Format.Field constant identifying a field

  Since:

  1.4

• FieldPosition

  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:

  attribute - Format.Field constant identifying a field

  fieldID - integer constantce identifying a field

  Since:

  1.4

Method Detail

• getFieldAttribute

  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.

  Returns:

  Identifier for the field

  Since:

  1.4

• getField

  public int getField()

  Retrieves the field identifier.

• getBeginIndex

  public int getBeginIndex()

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

• getEndIndex

  public int getEndIndex()

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

• setBeginIndex

  public void setBeginIndex(int bi)

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

  Since:

  1.2

• setEndIndex

  public void setEndIndex(int ei)

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

  Since:

  1.2

• equals

  public boolean equals(Object obj)

  Overrides equals

  Overrides:

  equals in class Object

  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(), HashMap

• hashCode

  public int hashCode()

  Returns a hash code for this FieldPosition.

  Overrides:

  hashCode in class Object

  Returns:

  a hash code value for this object

  See Also:

  Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

• toString

  public String toString()

  Return a string representation of this FieldPosition.

  Overrides:

  toString in class Object

  Returns:

  a string representation of this object