org.jomc.tools
Class ResourceFileProcessor

java.lang.Object
  org.jomc.tools.JomcTool
      org.jomc.tools.ResourceFileProcessor

public class ResourceFileProcessor
extends JomcTool

Processes resource files.

Use cases

• writeResourceBundleResourceFiles(File)
• writeResourceBundleResourceFiles(Module, File)
• writeResourceBundleResourceFiles(Specification, File)
• writeResourceBundleResourceFiles(Implementation, File)

Version:

$Id: ResourceFileProcessor.java 2179 2010-06-28 17:49:49Z schulte2005 $

Author:

Christian Schulte

See Also:

JomcTool.getModules()

Nested Class Summary

Modifier and Type	Class and Description

Nested classes/interfaces inherited from class org.jomc.tools.JomcTool

JomcTool.Listener

Constructor and Description

ResourceFileProcessor()
Creates a new ResourceFileProcessor instance.

ResourceFileProcessor(ResourceFileProcessor tool)
Creates a new ResourceFileProcessor instance taking a ResourceFileProcessor instance to initialize the instance with.

Method Summary

Modifier and Type	Method and Description
Locale	getResourceBundleDefaultLocale() Gets the language of the default language properties file of generated resource bundle resource files.
Map<Locale,Properties>	getResourceBundleResources(org.jomc.model.Implementation implementation) Gets resource bundle properties resources of a given implementation.
Map<Locale,Properties>	getResourceBundleResources(org.jomc.model.Specification specification) Gets resource bundle properties resources of a given specification.
void	setResourceBundleDefaultLocale(Locale value) Sets the language of the default language properties file of generated resource bundle resource files.
void	writeResourceBundleResourceFiles(File resourcesDirectory) Writes resource bundle resource files of the modules of the instance to a given directory.
void	writeResourceBundleResourceFiles(org.jomc.model.Implementation implementation, File resourcesDirectory) Writes resource bundle resource files of a given implementation from the modules of the instance to a directory.
void	writeResourceBundleResourceFiles(org.jomc.model.Module module, File resourcesDirectory) Writes resource bundle resource files of a given module from the modules of the instance to a given directory.
void	writeResourceBundleResourceFiles(org.jomc.model.Specification specification, File resourcesDirectory) Writes resource bundle resource files of a given specification from the modules of the instance to a directory.

Methods inherited from class org.jomc.tools.JomcTool

getDefaultLogLevel, getDefaultTemplateProfile, getDisplayLanguage, getIndentation, getIndentation, getInputEncoding, getJavaClasspathLocation, getJavaClasspathLocation, getJavadocComment, getJavaGetterMethodName, getJavaGetterMethodName, getJavaGetterMethodName, getJavaInterfaceNames, getJavaModifierName, getJavaModifierName, getJavaModifierName, getJavaPackageName, getJavaPackageName, getJavaPackageName, getJavaString, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getLineSeparator, getListeners, getLogLevel, getLongDate, getLongDateTime, getLongTime, getModel, getModules, getOutputEncoding, getShortDate, getShortDateTime, getShortTime, getTemplateEncoding, getTemplateProfile, getVelocityContext, getVelocityEngine, getVelocityTemplate, getYears, isJavaDefaultPackage, isJavaDefaultPackage, isJavaPrimitiveType, isLoggable, log, setDefaultLogLevel, setDefaultTemplateProfile, setIndentation, setInputEncoding, setLineSeparator, setLogLevel, setModel, setOutputEncoding, setTemplateEncoding, setTemplateProfile, setVelocityEngine

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFileProcessor

public ResourceFileProcessor()

Creates a new ResourceFileProcessor instance.

ResourceFileProcessor

public ResourceFileProcessor(ResourceFileProcessor tool)
                      throws IOException

Creates a new ResourceFileProcessor instance taking a ResourceFileProcessor instance to initialize the instance with.

Parameters:

tool - The instance to initialize the new instance with.

Throws:

NullPointerException - if tool is null.

IOException - if copying tool fails.

Method Detail

getResourceBundleDefaultLocale

public final Locale getResourceBundleDefaultLocale()

Gets the language of the default language properties file of generated resource bundle resource files.

Returns:

The language of the default language properties file of generated resource bundle resource files.

See Also:

setResourceBundleDefaultLocale(java.util.Locale)

setResourceBundleDefaultLocale

public final void setResourceBundleDefaultLocale(Locale value)

Sets the language of the default language properties file of generated resource bundle resource files.

Parameters:

value - The language of the default language properties file of generated resource bundle resource files.

See Also:

getResourceBundleDefaultLocale()

writeResourceBundleResourceFiles

public void writeResourceBundleResourceFiles(File resourcesDirectory)
                                      throws IOException

Writes resource bundle resource files of the modules of the instance to a given directory.

Parameters:

resourcesDirectory - The directory to write resource bundle resource files to.

Throws:

NullPointerException - if resourcesDirectory is null.

IOException - if writing resource bundle resource files fails.

See Also:

writeResourceBundleResourceFiles(org.jomc.model.Module, java.io.File)

writeResourceBundleResourceFiles

public void writeResourceBundleResourceFiles(org.jomc.model.Module module,
                                             File resourcesDirectory)
                                      throws IOException

Writes resource bundle resource files of a given module from the modules of the instance to a given directory.

Parameters:

module - The module to process.

resourcesDirectory - The directory to write resource bundle resource files to.

Throws:

NullPointerException - if module or resourcesDirectory is null.

IOException - if writing resource bundle resource files fails.

See Also:

writeResourceBundleResourceFiles(org.jomc.model.Specification, java.io.File), writeResourceBundleResourceFiles(org.jomc.model.Implementation, java.io.File)

writeResourceBundleResourceFiles

public void writeResourceBundleResourceFiles(org.jomc.model.Specification specification,
                                             File resourcesDirectory)
                                      throws IOException

Writes resource bundle resource files of a given specification from the modules of the instance to a directory.

Parameters:

specification - The specification to process.

resourcesDirectory - The directory to write resource bundle resource files to.

Throws:

NullPointerException - if specification or resourcesDirectory is null.

IOException - if writing resource bundle resource files fails.

See Also:

getResourceBundleResources(org.jomc.model.Specification)

writeResourceBundleResourceFiles

public void writeResourceBundleResourceFiles(org.jomc.model.Implementation implementation,
                                             File resourcesDirectory)
                                      throws IOException

Writes resource bundle resource files of a given implementation from the modules of the instance to a directory.

Parameters:

implementation - The implementation to process.

resourcesDirectory - The directory to write resource bundle resource files to.

Throws:

NullPointerException - if implementation or resourcesDirectory is null.

IOException - if writing resource bundle resource files fails.

See Also:

getResourceBundleResources(org.jomc.model.Implementation)

getResourceBundleResources

public Map<Locale,Properties> getResourceBundleResources(org.jomc.model.Specification specification)
                                                  throws IOException

Gets resource bundle properties resources of a given specification.

Parameters:

specification - The specification to get resource bundle properties resources of.

Returns:

Resource bundle properties resources of specification.

Throws:

NullPointerException - if specification is null.

IOException - if getting the resource bundle properties resources fails.

getResourceBundleResources

public Map<Locale,Properties> getResourceBundleResources(org.jomc.model.Implementation implementation)
                                                  throws IOException

Gets resource bundle properties resources of a given implementation.

Parameters:

implementation - The implementation to get resource bundle properties resources of.

Returns:

Resource bundle properties resources of implementation.

Throws:

NullPointerException - if implementation is null.

IOException - if getting the resource bundle properties resources fails.