org.codehaus.mojo.jaxb2.shared.environment.locale

Class LocaleFacet

java.lang.Object

org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet

org.codehaus.mojo.jaxb2.shared.environment.locale.LocaleFacet

All Implemented Interfaces:

EnvironmentFacet

public class LocaleFacet
extends AbstractLogAwareFacet

EnvironmentFacet implementation which alters the default Locale for the remainder of the tool execution.

Author:

Lennart Jörelid, jGuru Europe AB

Field Summary

Fields inherited from class org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet

log

Constructor Summary

Constructors

Constructor and Description
LocaleFacet(org.apache.maven.plugin.logging.Log log, Locale newLocale) Compound constructor creating a LocaleFacet wrapping the supplied instances.

Method Summary

Modifier and Type	Method and Description
static LocaleFacet	createFor(String localeString, org.apache.maven.plugin.logging.Log log) Helper method used to parse a locale configuration string into a Locale instance.
void	restore() Restores the original Environment, implying that the change performed in setup() method are restored to the state before the setup method was called.
void	setup() Sets up this Environment, inferring temporary changes to environment variables or conditions.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleFacet

public LocaleFacet(org.apache.maven.plugin.logging.Log log,
                   Locale newLocale)

Compound constructor creating a LocaleFacet wrapping the supplied instances.

Parameters:

log - The active Maven Log.

newLocale - The non-null Locale to be set by this LocaleFacet during execution.

Method Detail

setup

public void setup()

Sets up this Environment, inferring temporary changes to environment variables or conditions. The changes must be reversible, and should be restored to their original values in the restore() method.

Changes the Locale during the execution of the plugin.

restore

public void restore()

Restores the original Environment, implying that the change performed in setup() method are restored to the state before the setup method was called.

Restores the original locale following the plugin's execution.

createFor

public static LocaleFacet createFor(String localeString,
                                    org.apache.maven.plugin.logging.Log log)
                             throws org.apache.maven.plugin.MojoExecutionException

Helper method used to parse a locale configuration string into a Locale instance.

Parameters:

localeString - A configuration string parameter on the form <language>[,<country>[,<variant>]]

log - The active Maven Log. Cannot be null.

Returns:

A fully constructed Locale.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the localeString was not supplied on the required form.