Author: echatellier Date: 2009-11-02 11:18:53 +0100 (Mon, 02 Nov 2009) New Revision: 1697 Modified: trunk/src/main/java/org/nuiton/i18n/I18n.java Log: Ajout de doc concernant l'utilit?\195?\169 de la fonction n_ Modified: trunk/src/main/java/org/nuiton/i18n/I18n.java =================================================================== --- trunk/src/main/java/org/nuiton/i18n/I18n.java 2009-11-02 06:58:34 UTC (rev 1696) +++ trunk/src/main/java/org/nuiton/i18n/I18n.java 2009-11-02 10:18:53 UTC (rev 1697) @@ -166,11 +166,22 @@ /** * Retourne la chaine passée en argument. * - * @param message message formate avec la meme syntaxe que {@link - * java.text.MessageFormat} - * @param args les parametres pour le message. - * @return le message passe en argument mais formatte - * avec les parametres + * Utile surtout pour collecter les chaines et ne pas les traduires à leur + * apparition. + * + * Par exemple : + * <pre>String key = "nuitonutils.key"; + * String result = _(key)</pre> + * fonctionnera, mais la chaine n'aura pas été marquée comme devant être + * internationalisé. + * + * Tres utile par exemple, pour crée des objets non internationnalisé, et + * devant être traduit seulement à leur lecture suivant la locale du + * lecteur et non du créateur. + * + * @param message message formate avec la meme syntaxe que {@link String#format(String, Object...)} + * @param args les parametres pour le message. + * @return le message passe en argument mais formatté avec les parametres */ public static String n_(String message, Object... args) { try { @@ -182,11 +193,23 @@ } /** - * Retourne la chaine passé en argument + * Retourne la chaine passé en argument. + * + * Utile surtout pour collecter les chaines et ne pas les traduires à leur + * apparition. + * + * Par exemple : + * <pre>String key = "nuitonutils.key"; + * String result = _(key)</pre> + * fonctionnera, mais la chaine n'aura pas été marquée comme devant être + * internationalisé. + * + * Tres utile par exemple, pour crée des objets non internationnalisé, et + * devant être traduit seulement à leur lecture suivant la locale du + * lecteur et non du créateur. * * @param message la chaine à traduire - * @return la chaine passée en argument - * sinon. + * @return la chaine passée en argument. */ public static String n_(String message) { return message;