Package java.text

Class FieldPosition

  • Direct Known Subclasses:
    DontCareFieldPosition, UFieldPosition
    public class FieldPosition
extends Object
    Identifies fields in formatted strings. If a FieldPosition is passed to the format method with such a parameter, then the indices will be set to the start and end indices of the field in the formatted string.

    A FieldPosition can be created by using the integer constants in the various format classes (for example NumberFormat.INTEGER_FIELD) or one of the fields of type Format.Field.

    If more than one field position is needed, the method Format.formatToCharacterIterator(Object) should be used.

    • Constructor Detail

      • FieldPosition

        public FieldPosition​(int field)
        Constructs a new FieldPosition for the given field id.

      • FieldPosition

        public FieldPosition​(Format.Field attribute)
        Constructs a new FieldPosition for the given Field attribute.

      • FieldPosition

        public FieldPosition​(Format.Field attribute,
                     int field)
        Constructs a new FieldPosition for the given Field attribute and field id.

    • Method Detail

      • equals

        public boolean equals​(Object object)
        Compares the given object to this field position and indicates if they are equal. In order to be equal, object must be an instance of FieldPosition with the same field, begin index and end index.
        Overrides:
        equals in class Object
        Parameters:
        object - the object to compare this instance with.
        Returns:
        true if the specified object is equal to this Object; false otherwise.
        See Also:
        Object.hashCode()

      • getBeginIndex

        public int getBeginIndex()
        Returns the index of the beginning of the field.

      • getEndIndex

        public int getEndIndex()
        Returns the index one past the end of the field.

      • getField

        public int getField()
        Returns the field which is being identified.

      • getFieldAttribute

        public Format.Field getFieldAttribute()
        Returns the attribute which is being identified.

      • hashCode

        public int hashCode()
        Description copied from class: Object
        Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

        Note that hash values must not change over time unless information used in equals comparisons also changes.

        See Writing a correct hashCode method if you intend implementing your own hashCode method.

        Overrides:
        hashCode in class Object
        Returns:
        this object's hash code.
        See Also:
        Object.equals(java.lang.Object)

      • setBeginIndex

        public void setBeginIndex​(int index)
        Sets the index of the beginning of the field.

      • setEndIndex

        public void setEndIndex​(int index)
        Sets the index of the end of the field.

      • toString

        public String toString()
        Returns the string representation of this field position.
        Overrides:
        toString in class Object
        Returns:
        a printable representation of this object.