Author: fdesbois Date: 2011-05-12 10:40:34 +0200 (Thu, 12 May 2011) New Revision: 1925 Url: http://nuiton.org/repositories/revision/i18n/1925 Log: doc improvement Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java trunk/src/site/apt/index.apt Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java 2011-05-11 15:46:17 UTC (rev 1924) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java 2011-05-12 08:40:34 UTC (rev 1925) @@ -25,6 +25,11 @@ package org.nuiton.i18n.init; +import java.net.URL; +import java.nio.charset.Charset; +import java.util.List; +import java.util.Properties; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.nuiton.i18n.I18n; @@ -34,10 +39,6 @@ import org.nuiton.i18n.bundle.I18nBundleEntry; import org.nuiton.i18n.bundle.I18nBundleUtil; -import java.net.URL; -import java.nio.charset.Charset; -import java.util.List; - /** * Abstract object to resolv {@link I18nBundle} and prepare initialization of * {@link I18n}. @@ -99,22 +100,46 @@ return result; } + /** + * Get the {@link Charset} encoding used for i18n {@link Properties} file loading. + * + * @return Charset + */ public Charset getEncoding() { return encoding; } - public void setEncoding(Charset encoding) { + /** + * Set {@code encoding} to use for i18n {@link Properties} file loading. + * + * @param encoding Charset encoding to use + * @throws NullPointerException if {@code encoding} is null + * @since 2.4 + */ + public void setEncoding(Charset encoding) throws NullPointerException { if (encoding == null) { throw new NullPointerException("Can not set a null encoding"); } this.encoding = encoding; } + /** + * Get the {@link I18nMessageFormatter} to use on each i18n message translation. + * + * @return I18nMessageFormatter + */ public I18nMessageFormatter getMessageFormatter() { return messageFormatter; } - public void setMessageFormatter(I18nMessageFormatter messageFormatter) { + /** + * Set {@code messageFormatter} to use on each i18n message translation. + * + * @param messageFormatter I18nMessageFormatter to use + * @throws NullPointerException if {@code messageFormatter} is null + * @since 2.4 + */ + public void setMessageFormatter(I18nMessageFormatter messageFormatter) throws NullPointerException { if (messageFormatter == null) { throw new NullPointerException( "Can not set a null message formatter"); Modified: trunk/src/site/apt/index.apt =================================================================== --- trunk/src/site/apt/index.apt 2011-05-11 15:46:17 UTC (rev 1924) +++ trunk/src/site/apt/index.apt 2011-05-12 08:40:34 UTC (rev 1925) @@ -81,8 +81,8 @@ - au niveau du runtime en spécifiant à l'initializer le bon messageFormatter à utiliser. (voir l'interface {{{./nuiton-i18n/apidocs/org/nuiton/i18n/I18nMessageFormatter.html}I18nMessageFormatter}}). - A noter qu'au runtime, les syntaxes de traductions ne peuvents pas être - changées et utiliser un formatter qui ne correspond pas à la syntaxe des + A noter qu'au runtime, les syntaxes de traductions ne peuvent pas être + changées. Utiliser un formatter qui ne correspond pas à la syntaxe des traductions ne fonctionnera pas correctement. Quoi de neuf dans la version 2.3