jdk.text.FieldPosition
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.
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.->field-positionclj
(->field-position field)(->field-position attribute field-id)Constructor.
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.
attribute - Format.Field constant identifying a field - java.text.Format$Field
field-id - integer constant identifying a field - int
Constructor. 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. attribute - Format.Field constant identifying a field - `java.text.Format$Field` field-id - integer constant identifying a field - `int`
equalsclj
(equals this obj)Overrides equals
obj - the reference object with which to compare. - java.lang.Object
returns: true if this object is the same as the obj
argument; false otherwise. - boolean
Overrides equals
obj - the reference object with which to compare. - `java.lang.Object`
returns: true if this object is the same as the obj
argument; false otherwise. - `boolean`get-begin-indexclj
(get-begin-index this)Retrieves the index of the first character in the requested field.
returns: the begin index - int
Retrieves the index of the first character in the requested field. returns: the begin index - `int`
get-end-indexclj
(get-end-index this)Retrieves the index of the character following the last character in the requested field.
returns: the end index - int
Retrieves the index of the character following the last character in the requested field. returns: the end index - `int`
get-fieldclj
(get-field this)Retrieves the field identifier.
returns: the field identifier - int
Retrieves the field identifier. returns: the field identifier - `int`
get-field-attributeclj
(get-field-attribute this)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 - java.text.Format$Field
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 - `java.text.Format$Field`
hash-codeclj
(hash-code this)Returns a hash code for this FieldPosition.
returns: a hash code value for this object - int
Returns a hash code for this FieldPosition. returns: a hash code value for this object - `int`
set-begin-indexclj
(set-begin-index this bi)Sets the begin index. For use by subclasses of Format.
bi - the begin index - int
Sets the begin index. For use by subclasses of Format. bi - the begin index - `int`
set-end-indexclj
(set-end-index this ei)Sets the end index. For use by subclasses of Format.
ei - the end index - int
Sets the end index. For use by subclasses of Format. ei - the end index - `int`
to-stringclj
(to-string this)Return a string representation of this FieldPosition.
returns: a string representation of this object - java.lang.String
Return a string representation of this FieldPosition. returns: a string representation of this object - `java.lang.String`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close