net.sf.mmm.util.nls.base

Class ResourceBundleSynchronizer

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.util.cli.api.AbstractMain

net.sf.mmm.util.cli.api.AbstractVersionedMain

net.sf.mmm.util.nls.base.AbstractResourceBundleCli

net.sf.mmm.util.nls.base.ResourceBundleSynchronizer

@CliClass(usage="Create and/or update resource-bundle property-files.")
 @CliMode(id="default",
         title="default",
         usage="Create and/or update resource-bundle property-files from <bundle-class> for the given locales (including the root locale). Example:\n\n{mainClass} --bundle-class foo.bar.NlsBundleMyExample --locale de de_DE en en_US en_GB fr zh ja_JP zh_TW\n\nFor each locale a property-file foo/bar/NlsBundleMyExample_<locale>.properties will be created or updated in the base-path. In each property-file all properties defined in <bundle-class> will be added with a TODO-marker and the original text as value. If the property-file already exists, all existing properties will remain unchanged and comments will be kept.")
public class ResourceBundleSynchronizer
extends AbstractResourceBundleCli

This class can be used to create and update the localized bundles (properties) from an NlsBundle or AbstractResourceBundle. If you do not explicitly specify the bundle to synchronize as commandline option (using --bundle) this ResourceBundleSynchronizer will automatically scan your classpath for NlsBundles and synchronize all of them.
This is a main-program to execute via command-line. Simply call it with the parameter --help to get help.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	locales

Fields inherited from class net.sf.mmm.util.nls.base.AbstractResourceBundleCli

DEFAULT_BASE_PATH, OPTION_BUNDLE_CLASS, OPTION_DATE_PATTERN, OPTION_ENCODING, OPTION_LOCALE, OPTION_PATH

Fields inherited from class net.sf.mmm.util.cli.api.AbstractMain

EXIT_CODE_CONSTRAINT_VIOLATION, EXIT_CODE_ILLEGAL_SYNTAX, EXIT_CODE_OK, EXIT_CODE_UNEXPECTED

Constructor Summary

Constructors

Constructor and Description
ResourceBundleSynchronizer() The constructor.

Method Summary

Modifier and Type	Method and Description
String[]	getLocales() This method gets the locales of the bundles that should be synchronized.
protected File	getTargetFile(NlsBundleDescriptor bundle, String locale)
private Properties	loadOrCreatePropertiesFile(PrintWriter out, File file, boolean update)
static void	main(String[] arguments) This is the main method used to run this class as application.
void	setLocales(String[] locales) This method sets the locales.
protected void	synchronize(NlsBundleDescriptor bundle, String locale, File targetFile, String date) Like AbstractResourceBundleCli.synchronize(NlsBundleDescriptor) but for a single Locale.
private void	synchronizeProperties(NlsBundleDescriptor bundle, String locale, Properties existingBundle, StringBuffer buffer)
private void	writeProperties(String date, File file, boolean update, StringBuffer buffer)

Methods inherited from class net.sf.mmm.util.nls.base.AbstractResourceBundleCli

getBundleClasses, getBundleHelper, getDatePattern, getEncoding, getLocales, getNewline, getPath, getReflectionUtil, getResourceBundleLocator, getTargetFileMkdirs, runDefaultMode, setBundleClasses, setBundleHelper, setDatePattern, setEncoding, setLocales, setNewline, setPath, setReflectionUtil, setResourceBundleLocator, synchronize

Methods inherited from class net.sf.mmm.util.cli.api.AbstractVersionedMain

getVersion, run

Methods inherited from class net.sf.mmm.util.cli.api.AbstractMain

getIocContainer, getOutputSettings, getParserBuilder, getStandardError, getStandardOutput, getStreamUtil, handleError, printHelp, run, runAndExit, setStandardError, setStandardOutput, validate

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

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

Field Detail

locales

@CliOption(name="--locale",
           aliases="-l",
           operand="LOCALE",
           required=true,
           usage="The list of locales to process. Each locale has to be in the form \"ll[_CC[_vv]]\" where \"ll\" is the lowercase ISO 639 code, CC is the uppercase ISO 3166 2-letter code and vv is an arbitrary variant. Examples are \"de\", \"en_US\" or \"th_TH_TH\".")
private String[] locales

Constructor Detail

ResourceBundleSynchronizer

public ResourceBundleSynchronizer()

The constructor.

Method Detail

getLocales

public String[] getLocales()

Description copied from class: AbstractResourceBundleCli

This method gets the locales of the bundles that should be synchronized. Examples for locales (entries of the returned array) are "", "en", or "en_GB".

Specified by:

getLocales in class AbstractResourceBundleCli

Returns:

the locales to create/update.

setLocales

public void setLocales(String[] locales)

Description copied from class: AbstractResourceBundleCli

This method sets the locales.

Specified by:

setLocales in class AbstractResourceBundleCli

Parameters:

locales - are the locales to set

getTargetFile

protected File getTargetFile(NlsBundleDescriptor bundle,
                             String locale)

Specified by:

getTargetFile in class AbstractResourceBundleCli

synchronize

protected void synchronize(NlsBundleDescriptor bundle,
                           String locale,
                           File targetFile,
                           String date)
                    throws IOException

Description copied from class: AbstractResourceBundleCli

Like AbstractResourceBundleCli.synchronize(NlsBundleDescriptor) but for a single Locale.

Specified by:

synchronize in class AbstractResourceBundleCli

Parameters:

bundle - the bundle instance as java object.

locale - the locale to synchronize as string.

targetFile - the File to write to. May not yet exists but parent folder exists.

date - is the current date as string.

Throws:

IOException - if an I/O problem occurred.

loadOrCreatePropertiesFile

private Properties loadOrCreatePropertiesFile(PrintWriter out,
                                              File file,
                                              boolean update)
                                       throws FileNotFoundException,
                                              UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

synchronizeProperties

private void synchronizeProperties(NlsBundleDescriptor bundle,
                                   String locale,
                                   Properties existingBundle,
                                   StringBuffer buffer)

writeProperties

private void writeProperties(String date,
                             File file,
                             boolean update,
                             StringBuffer buffer)
                      throws FileNotFoundException,
                             UnsupportedEncodingException,
                             IOException

Throws:

FileNotFoundException

UnsupportedEncodingException

IOException

main

public static void main(String[] arguments)

This is the main method used to run this class as application.

Parameters:

arguments - are the command-line arguments.