js.util

Class I18nRepository.ConfigBuilder

java.lang.Object

js.lang.ConfigBuilder

js.util.I18nRepository.ConfigBuilder

Enclosing class:

I18nRepository

public static class I18nRepository.ConfigBuilder
extends ConfigBuilder

Configuration builder for I18N repository. Repository instance is configured using a Config instance that is created by this builder. Configuration builder needs repository path and optional files pattern. Repository path is a standard directories path but with ${locale} variable indicating locale directory position into directories hierarchy, e.g. /var/www/vhosts/site/${locale}/emails/. Directory path can be relative or absolute. If files pattern is not provided accept all files.

For completeness here are the properties required by I18N repository.

Properties

Name	Type	Default	Description
multi-locale	Boolean	true	I18N repository is usually multiple locale; if single locale is desired set this property to false.
base-dir	File	null	Mandatory repository base directory, absolute or relative. Base directory contains locale directories as direct children.
sub-path	String	null	Optional sub-path following after locale directory.
files-pattern	String	WildcardFilter.ACCEPT_ALL	Pattern for the files to match. Should have format as accepted by WildcardFilter.

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private String	baseDir Base directory for I18N repository.
private String	filesPattern Optional files pattern, default to null, in which case all files are accepted.
private static String	LOCALE_VARIABLE Locale variable present into repository directory path to mark sub-directory used for locale discriminate.
private boolean	multiLocale Support for multiple locale.
private String	subpath Optional sub-path following locale directory, default to null

Constructor Summary

Constructors

Constructor and Description
ConfigBuilder(String repositoryPath, String filesPattern) Create configuration builder for given repository path and optional files pattern.

Method Summary

Modifier and Type	Method and Description
Config	build() Build configuration object.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_VARIABLE

private static final String LOCALE_VARIABLE

Locale variable present into repository directory path to mark sub-directory used for locale discriminate.

See Also:

Constant Field Values

multiLocale

private final boolean multiLocale

Support for multiple locale.

baseDir

private final String baseDir

Base directory for I18N repository.

subpath

private final String subpath

Optional sub-path following locale directory, default to null

filesPattern

private final String filesPattern

Optional files pattern, default to null, in which case all files are accepted.

Constructor Detail

ConfigBuilder

public ConfigBuilder(String repositoryPath,
                     String filesPattern)

Create configuration builder for given repository path and optional files pattern. Repository path may have locale variable ${locale} and optional sub-path, e.g. /var/www/vhosts/site/${locale}/emails/.

Parameters:

repositoryPath - repository path,

filesPattern - optional files pattern, null if not used.

Throws:

IllegalArgumentException - if repositoryPath argument is null or empty, inferred base directory does not exist or filesPattern argument is empty.

Method Detail

build

public Config build()
             throws ConfigException

Description copied from class: ConfigBuilder

Build configuration object. Configuration object is not reusable so this factory creates a new instance for every call.

Overrides:

build in class ConfigBuilder

Returns:

newly created configuration object.

Throws:

ConfigException - if XML stream read operation fails or is not well formed.