java.text: public class: FieldPosition

java.text
public class: FieldPosition [javadoc | source]

java.lang.Object
   java.text.FieldPosition

Direct Known Subclasses:
DontCareFieldPosition

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.

Also see:

java.text.Format

author: Mark - Davis

Field Summary
int	field	Input: Desired field to determine start and end offsets for. The meaning depends on the subclass of Format.
int	endIndex	Output: End offset of field in text. If the field does not occur in the text, 0 is returned.
int	beginIndex	Output: Start offset of field in text. If the field does not occur in the text, 0 is returned.

Constructor:

Constructor:
public FieldPosition(int field) { this.field = 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. Also see: java.text.NumberFormat#INTEGER_FIELD java.text.NumberFormat#FRACTION_FIELD java.text.DateFormat#YEAR_FIELD java.text.DateFormat#MONTH_FIELD
public FieldPosition(Field attribute) { this(attribute, -1); } 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` -
public FieldPosition(Field attribute, int fieldID) { this.attribute = attribute; this.field = 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` -

 public FieldPosition(int field) {
        this.field = 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.

Also see:

java.text.NumberFormat#INTEGER_FIELD

java.text.NumberFormat#FRACTION_FIELD

java.text.DateFormat#YEAR_FIELD

java.text.DateFormat#MONTH_FIELD

 public FieldPosition(Field attribute) {
        this(attribute, -1);
}

Format

new FieldPosition(attribute, -1)

Parameters:

attribute - Format.Field constant identifying a field

since: 1.4 -

 public FieldPosition(Field attribute,
    int fieldID) {
        this.attribute = attribute;
        this.field = fieldID;
}

FieldPosition

Field

Format

Field

attribute

fieldID

attribute

Format

Field

fieldID

Parameters:

attribute - Format.Field constant identifying a field

fieldID - integer constantce identifying a field

since: 1.4 -

Method from java.text.FieldPosition Summary:
equals, getBeginIndex, getEndIndex, getField, getFieldAttribute, getFieldDelegate, hashCode, setBeginIndex, setEndIndex, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.text.FieldPosition Detail:
public boolean equals(Object obj) { if (obj == null) return false; if (!(obj instanceof FieldPosition)) return false; FieldPosition other = (FieldPosition) obj; if (attribute == null) { if (other.attribute != null) { return false; } } else if (!attribute.equals(other.attribute)) { return false; } return (beginIndex == other.beginIndex && endIndex == other.endIndex && field == other.field); } Overrides equals
public int getBeginIndex() { return beginIndex; } Retrieves the index of the first character in the requested field.
public int getEndIndex() { return endIndex; } Retrieves the index of the character following the last character in the requested field.
public int getField() { return field; } Retrieves the field identifier.
public Field getFieldAttribute() { return attribute; } 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.
FieldDelegate getFieldDelegate() { return new Delegate(); } Returns a `Format.FieldDelegate` instance that is associated with the FieldPosition. When the delegate is notified of the same field the FieldPosition is associated with, the begin/end will be adjusted.
public int hashCode() { return (field < < 24) \| (beginIndex < < 16) \| endIndex; } Returns a hash code for this FieldPosition.
public void setBeginIndex(int bi) { beginIndex = bi; } Sets the begin index. For use by subclasses of Format.
public void setEndIndex(int ei) { endIndex = ei; } Sets the end index. For use by subclasses of Format.
public String toString() { return getClass().getName() + "[field=" + field + ",attribute=" + attribute + ",beginIndex=" + beginIndex + ",endIndex=" + endIndex + ']'; } Return a string representation of this FieldPosition.

Method from java.text.FieldPosition Detail:

 public boolean equals(Object obj) {
        if (obj == null) return false;
        if (!(obj instanceof FieldPosition))
            return false;
        FieldPosition other = (FieldPosition) obj;
        if (attribute == null) {
            if (other.attribute != null) {
                return false;
            }
        }
        else if (!attribute.equals(other.attribute)) {
            return false;
        }
        return (beginIndex == other.beginIndex
            && endIndex == other.endIndex
            && field == other.field);
}

Overrides equals

 public int getBeginIndex() {
        return beginIndex;
}

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

 public int getEndIndex() {
        return endIndex;
}

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

 public int getField() {
        return field;
}

Retrieves the field identifier.

 public Field getFieldAttribute() {
        return attribute;
}

Field

 FieldDelegate getFieldDelegate() {
        return new Delegate();
}

Format.FieldDelegate

 public int hashCode() {
        return (field < <  24) | (beginIndex < <  16) | endIndex;
}

Returns a hash code for this FieldPosition.

 public  void setBeginIndex(int bi) {
        beginIndex = bi;
}

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

 public  void setEndIndex(int ei) {
        endIndex = ei;
}

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

 public String toString() {
        return getClass().getName() +
            "[field=" + field + ",attribute=" + attribute +
            ",beginIndex=" + beginIndex +
            ",endIndex=" + endIndex + ']';
}

Return a string representation of this FieldPosition.