API java : Format

java.text
Class Format

java.lang.Object
  java.text.Format

All Implemented Interfaces:: Serializable, Cloneable

Direct Known Subclasses:: DateFormat, MessageFormat, NumberFormat

public abstract class Format
extends Object
implements Serializable, Cloneable
extends Object
implements Serializable, Cloneable

Format is an abstract base class for formatting locale-sensitive information such as dates, messages, and numbers.

Format defines the programming interface for formatting locale-sensitive objects into Strings (the format method) and for parsing Strings back into objects (the parseObject method).

Generally, a format's parseObject method must be able to parse any string formatted by its format method. However, there may be exceptional cases where this is not possible. For example, a format method might create two adjacent integer numbers with no separator in between, and in this case the parseObject could not tell which digits belong to which number.

Subclassing

The Java 2 platform provides three specialized subclasses of Format-- DateFormat, MessageFormat, and NumberFormat--for formatting dates, messages, and numbers, respectively.

Concrete subclasses must implement three methods:

format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
formatToCharacterIterator(Object obj)
parseObject(String source, ParsePosition pos)

These general methods allow polymorphic parsing and formatting of objects and are used, for example, by MessageFormat. Subclasses often also provide additional format methods for specific input types as well as parse methods for specific result types. Any parse method that does not take a ParsePosition argument should throw ParseException when no text in the required format is at the beginning of the input text.

Most subclasses will also implement the following factory methods:

getInstance for getting a useful format object appropriate for the current locale
getInstance(Locale) for getting a useful format object appropriate for the specified locale

In addition, some subclasses may also implement other getXxxxInstance methods for more specialized control. For example, the NumberFormat class provides getPercentInstance and getCurrencyInstance methods for getting specialized number formatters.

Subclasses of Format that allow programmers to create objects for locales (with getInstance(Locale) for example) must also implement the following class method:

public static Locale[] getAvailableLocales()

And finally subclasses may define a set of constants to identify the various fields in the formatted output. These constants are used to create a FieldPosition object which identifies what information is contained in the field and its position in the formatted result. These constants should be named item_FIELD where item identifies the field. For examples of these constants, see ERA_FIELD and its friends in DateFormat.

Synchronization

Formats are generally not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.

See Also:: ParsePosition, FieldPosition, NumberFormat, DateFormat, MessageFormat, Serialized Form

Nested Class Summary

static class Format.Field
          Defines constants that are used as attribute keys in the AttributedCharacterIterator returned from Format.formatToCharacterIterator and as field identifiers in FieldPosition.

Constructor Summary

Format()


Method Summary

Object clone()
          Creates and returns a copy of this object.

String format(Object obj)
          Formats an object to produce a string.

abstract StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
          Formats an object and appends the resulting text to a given string buffer.

AttributedCharacterIterator formatToCharacterIterator(Object obj)
          Formats an Object producing an AttributedCharacterIterator.

Object parseObject(String source)
          Parses text from the beginning of the given string to produce an object.

abstract Object parseObject(String source, ParsePosition pos)
          Parses text from a string to produce an object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Nested Class Summary
`static class`	`Format.Field` Defines constants that are used as attribute keys in the `AttributedCharacterIterator` returned from `Format.formatToCharacterIterator` and as field identifiers in `FieldPosition`.

Constructor Summary
`Format()`

Method Summary
`Object`	`clone()` Creates and returns a copy of this object.
`String`	`format(Object obj)` Formats an object to produce a string.
`abstract StringBuffer`	`format(Object obj, StringBuffer toAppendTo, FieldPosition pos)` Formats an object and appends the resulting text to a given string buffer.
`AttributedCharacterIterator`	`formatToCharacterIterator(Object obj)` Formats an Object producing an `AttributedCharacterIterator`.
`Object`	`parseObject(String source)` Parses text from the beginning of the given string to produce an object.
`abstract Object`	`parseObject(String source, ParsePosition pos)` Parses text from a string to produce an object.

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Format

public Format()

Method Detail

format

public final String format(Object obj)

Formats an object to produce a string. This is equivalent to

format(obj, new StringBuffer(), new FieldPosition(0)).toString();

Parameters:: obj - The object to format
Returns:: Formatted string.
Throws:: IllegalArgumentException - if the Format cannot format the given object

format

public abstract StringBuffer format(Object obj,
                                    StringBuffer toAppendTo,
                                    FieldPosition pos)

Formats an object and appends the resulting text to a given string buffer. If the pos argument identifies a field used by the format, then its indices are set to the beginning and end of the first such field encountered.

Parameters:: obj - The object to format; toAppendTo - where the text is to be appended; pos - A FieldPosition identifying a field in the formatted text
Returns:: the string buffer passed in as toAppendTo, with formatted text appended
Throws:: NullPointerException - if toAppendTo or pos is null; IllegalArgumentException - if the Format cannot format the given object

formatToCharacterIterator

public AttributedCharacterIterator formatToCharacterIterator(Object obj)

Formats an Object producing an AttributedCharacterIterator. You can use the returned AttributedCharacterIterator to build the resulting String, as well as to determine information about the resulting String.

Each attribute key of the AttributedCharacterIterator will be of type Field. It is up to each Format implementation to define what the legal values are for each attribute in the AttributedCharacterIterator, but typically the attribute key is also used as the attribute value.

The default implementation creates an AttributedCharacterIterator with no attributes. Subclasses that support fields should override this and create an AttributedCharacterIterator with meaningful attributes.

Parameters:: obj - The object to format
Returns:: AttributedCharacterIterator describing the formatted value.
Throws:: NullPointerException - if obj is null.; IllegalArgumentException - when the Format cannot format the given object.
Since:: 1.4

parseObject

public abstract Object parseObject(String source,
                                   ParsePosition pos)

Parses text from a string to produce an object.

The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed object is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned.

Parameters:: source - A String, part of which should be parsed.; pos - A ParsePosition object with index and error index information as described above.
Returns:: An Object parsed from the string. In case of error, returns null.
Throws:: NullPointerException - if pos is null.

parseObject

public Object parseObject(String source)
                   throws ParseException

Parses text from the beginning of the given string to produce an object. The method may not use the entire text of the given string.

Parameters:: source - A String whose beginning should be parsed.
Returns:: An Object parsed from the string.
Throws:: ParseException - if the beginning of the specified string cannot be parsed.

clone

public Object clone()

Creates and returns a copy of this object.

Overrides:: clone in class Object

Returns:: a clone of this instance.
See Also:: Cloneable

Package :

Ces informations proviennent du site de http://java.sun.com

Remarques

Contenu

Le contenu de cette page provient du site de Sun, et est généré depuis un cache sur l'infobrol après certains traitements automatisés. La présentation peut donc différer du document original, mais le contenu aussi. Vous pouvez utiliser ce bouton pour afficher la page originale du site de Sun :

Quels sont les motivations de cette démarche?

Maintenir les pages en cache sur différents sites peut offrir plus de disponibilité.

Chaque page est indexée dans la base de donnée, ce qui permet de retrouver facilement les informations, au moyen des sommaires, du moteur de recherche interne, etc.

Des facilités sont mises en place pour que les membres de l'infobrol puissent effectuer des traductions en français des différents documents. Ceci devrait permettre aux débutants en programmation Java de consulter les API en français s'ils maîtrisent moins bien la langue de Shakespeare. Dans le cas où une traduction a été soumise, elle est disponible au moyen d'un lien en bas de page. Si la traduction a été validée, la page s'affiche par défaut en français, et un lien en bas de page permet d'atteindre la version en anglais.

Le code sur l'infobrol est automatiquement coloré selon la syntaxe, et les différents mots clés sont transformés en liens pour accéder rapidement aux informations.

Vous avez la possibilité de partager vos expériences en proposant vos propres extraits de code en utilisant le bouton "ajouter un commentaire" en bas de page. Si vous visitez simplement l'infobrol, vous avez déjà accès à cette fonction, mais si vous étes membre du brol, vous pouvez en plus utiliser des boutons supplémentaires de mise en forme, dont la coloration automatique de vos extraits de codes.

<- FontUIResource Format.Field ->

Réseaux sociaux

|Plus d'options...

Vous pouvez modifier vos préférences dans votre profil pour ne plus afficher les interactions avec les réseaux sociaux sur ces pages.

Nuage de mots clés

6 mots clés dont 0 définis manuellement (plus d'information...).

Avertissement

Cette page ne possède pas encore de mots clés manuels, ceci est donc un exemple automatique (les niveaux de pertinence sont fictifs, mais les liens sont valables). Pour tester le nuage avec une page qui contient des mots définis manuellement, vous pouvez cliquer ici.

Vous pouvez modifier vos préférences dans votre profil pour ne plus afficher le nuage de mots clés.

Structure du document

Réseaux sociaux
Nuage de mots clés
- Avertissement :

Astuce pour imprimer les couleurs des cellules de tableaux : http://www.gaudry.be/ast-rf-450.html

Aucun commentaire pour cette page

tection. Enregistrement IDDN n° 5329-1063
Document créé le 28/08/06 22:16, dernière modification le Vendredi 17 Juin 2011, 12:12
Source du document imprimé : http://www.gaudry.be/java-api-rf-java/text/Format.html Document affiché 1 fois ce mois de Juin.
St.Gaudry©07.01.02

Outils (masquer)

Recherche (afficher)

Utilisateur (masquer)

Nouveaux :
S'enregistrer

Liste des Membres

Qui est en ligne?
FAQ du forum

FAQ

Navigation (masquer)

Apparence (afficher)

Stats (afficher)

15832 documents
452 astuces.
549 niouzes.
3099 definitions.
447 membres.
8115 messages.

Document genere en :
0,90 seconde

Mises à jour :

Citation (masquer)

Il faut se garder de trois fautes : parler sans y être invité, ce qui est impertinence ; ne pas parler quand on y est invité, ce qui est de la dissimulation ; parler sans observer les réactions de l'autre, ce qui est de l'aveuglement.

Confucius

Nous sommes le Vendredi 01 Juin 2012, 19:47, toutes les heures sont au format GMT+1.00 Heure, heure d'été (+1)

API java : Format

java.text Class Format

Subclassing

Synchronization

Format

format

format

formatToCharacterIterator

parseObject

parseObject

clone

Remarques

Contenu

Quels sont les motivations de cette démarche?

Réseaux sociaux

Nuage de mots clés

Structure du document

java.text
Class Format