compact1, compact2, compact3
java.text
Class FieldPosition
- java.lang.Object
-
- java.text.FieldPosition
-
public class FieldPosition extends Object
FieldPositionis a simple class used byFormatand 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 ofFormat. - By a
Format.Fieldconstant, seeERA_FIELDand its friends inDateFormatfor an example.
FieldPositionkeeps 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
formatmethod in the variousFormatclasses requires aFieldPositionobject as an argument. You use thisformatmethod 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
FormatmethodformatToCharacterIterator.- See Also:
-
Format
- By an integer constant, whose names typically end with
-
-
Constructor Summary
Constructors Constructor and Description FieldPosition(Format.Field attribute)Creates a FieldPosition object for the given field constant.FieldPosition(Format.Field attribute, int fieldID)Creates aFieldPositionobject for the given field.FieldPosition(int field)Creates a FieldPosition object for the given field.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description booleanequals(Object obj)Overrides equalsintgetBeginIndex()Retrieves the index of the first character in the requested field.intgetEndIndex()Retrieves the index of the character following the last character in the requested field.intgetField()Retrieves the field identifier.Format.FieldgetFieldAttribute()Returns the field identifier as an attribute constant from one of theFieldsubclasses.inthashCode()Returns a hash code for this FieldPosition.voidsetBeginIndex(int bi)Sets the begin index.voidsetEndIndex(int ei)Sets the end index.StringtoString()Return a string representation of this 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.- Parameters:
-
field- the field identifier - 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 variousFormatsubclasses. This is equivalent to callingnew FieldPosition(attribute, -1).- Parameters:
-
attribute- Format.Field constant identifying a field - Since:
- 1.4
FieldPosition
public FieldPosition(Format.Field attribute, int fieldID)
Creates aFieldPositionobject for the given field. The field is identified by an attribute constant from one of theFieldsubclasses as well as an integer field ID defined by theFormatsubclasses.Formatsubclasses that are aware ofFieldshould give precedence toattributeand ignorefieldIDifattributeis not null. However, olderFormatsubclasses may not be aware ofFieldand rely onfieldID. If the field has no corresponding integer constant,fieldIDshould be -1.- Parameters:
-
attribute- Format.Field constant identifying a field -
fieldID- integer constant identifying a field - Since:
- 1.4
-
Method Detail
getFieldAttribute
public Format.Field getFieldAttribute()
Returns the field identifier as an attribute constant from one of theFieldsubclasses. 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.- Returns:
- the field identifier
getBeginIndex
public int getBeginIndex()
Retrieves the index of the first character in the requested field.- Returns:
- the begin index
getEndIndex
public int getEndIndex()
Retrieves the index of the character following the last character in the requested field.- Returns:
- the end index
setBeginIndex
public void setBeginIndex(int bi)
Sets the begin index. For use by subclasses of Format.- Parameters:
-
bi- the begin index - Since:
- 1.2
setEndIndex
public void setEndIndex(int ei)
Sets the end index. For use by subclasses of Format.- Parameters:
-
ei- the end index - Since:
- 1.2
equals
public boolean equals(Object obj)
Overrides equals- Overrides:
-
equalsin classObject - Parameters:
-
obj- the reference object with which to compare. - Returns:
-
trueif this object is the same as the obj argument;falseotherwise. - See Also:
-
Object.hashCode(),HashMap
hashCode
public int hashCode()
Returns a hash code for this FieldPosition.- Overrides:
-
hashCodein classObject - Returns:
- a hash code value for this object
- See Also:
-
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
