- java.lang.Object
-
- java.text.FieldPosition
-
public class FieldPosition extends Object
FieldPosition
is a simple class used byFormat
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 ofFormat
. - By a
Format.Field
constant, seeERA_FIELD
and its friends inDateFormat
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 variousFormat
classes requires aFieldPosition
object as an argument. You use thisformat
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
methodformatToCharacterIterator
.- 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 aFieldPosition
object for the given field.FieldPosition(int field)
Creates a FieldPosition object for the given field.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object obj)
Overrides equalsint
getBeginIndex()
Retrieves the index of the first character in the requested field.int
getEndIndex()
Retrieves the index of the character following the last character in the requested field.int
getField()
Retrieves the field identifier.Format.Field
getFieldAttribute()
Returns the field identifier as an attribute constant from one of theField
subclasses.int
hashCode()
Returns a hash code for this FieldPosition.void
setBeginIndex(int bi)
Sets the begin index.void
setEndIndex(int ei)
Sets the end index.String
toString()
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.
-
FieldPosition
public FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant. Fields are identified by constants defined in the variousFormat
subclasses. 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 aFieldPosition
object for the given field. The field is identified by an attribute constant from one of theField
subclasses as well as an integer field ID defined by theFormat
subclasses.Format
subclasses that are aware ofField
should give precedence toattribute
and ignorefieldID
ifattribute
is not null. However, olderFormat
subclasses may not be aware ofField
and rely onfieldID
. If the field has no corresponding integer constant,fieldID
should be -1.- Parameters:
attribute
- Format.Field constant identifying a fieldfieldID
- integer constantce identifying a field- Since:
- 1.4
-
-
Method Detail
-
getFieldAttribute
public Format.Field getFieldAttribute()
Returns the field identifier as an attribute constant from one of theField
subclasses. 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.
-
getBeginIndex
public int getBeginIndex()
Retrieves the index of the first character in the requested field.
-
getEndIndex
public int getEndIndex()
Retrieves the index of the character following the last character in the requested field.
-
setBeginIndex
public void setBeginIndex(int bi)
Sets the begin index. For use by subclasses of Format.- Since:
- 1.2
-
setEndIndex
public void setEndIndex(int ei)
Sets the end index. For use by subclasses of Format.- Since:
- 1.2
-
equals
public boolean equals(Object obj)
Overrides equals- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns a hash code for this FieldPosition.- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 17:26:31 Cette version de la page est en cache (à la date du 05/11/2024 17:26:31) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/text/fieldposition.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.