Save This Page
Home » openjdk-7 » java » text » [javadoc | source]
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:

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.

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:
 public FieldPosition(int field) 
 public FieldPosition(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 -
 public FieldPosition(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 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) 
    Overrides equals
 public int getBeginIndex() 
    Retrieves the index of the first character in the requested field.
 public int getEndIndex() 
    Retrieves the index of the character following the last character in the requested field.
 public int getField() 
    Retrieves the field identifier.
 public 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.
 FieldDelegate getFieldDelegate() 
    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() 
    Returns a hash code for this FieldPosition.
 public  void setBeginIndex(int bi) 
    Sets the begin index. For use by subclasses of Format.
 public  void setEndIndex(int ei) 
    Sets the end index. For use by subclasses of Format.
 public String toString() 
    Return a string representation of this FieldPosition.