Package de.codecamp.messages.shared.conf

Class ProjectConf

java.lang.Object

de.codecamp.messages.shared.conf.ProjectConf

All Implemented Interfaces:

MessageModule

public class ProjectConf
extends Object
implements MessageModule

ProjectConf contains the aspects of the project configuration shared by the annotation processor and other tools like the Eclipse companion plug-in. It represents a snapshot of the current configuration, so it's not intended to be long lived or stored for later use.

Field Summary

Fields

Modifier and Type	Field	Description
static List<String>	ALL_CONF_NAMES
static String	BUNDLE_DIR_DEFAULT
static String	CONF_BUNDLE_DIR
static String	CONF_BUNDLE_ENCODING
static String	CONF_BUNDLE_MISMATCH_POLICY
static String	CONF_BUNDLES
static String	CONF_EXTERNAL_PACKAGE_MAPPING
static String	CONF_GENERATE_CONSTANTS
static String	CONF_GENERATE_PROXIES
static String	CONF_IGNORED_BUNDLES
static String	CONF_IMPORTS
static String	CONF_MESSAGE_ARG_POLICY
static String	CONF_MESSAGE_FORMAT
static String	CONF_MISSING_MESSAGE_POLICY
static String	CONF_MODE
static String	CONF_MODULE_NAME
static String	CONF_PREFIX
static String	CONF_PROJECT_DIR
static String	CONF_TARGET_LOCALES
static String	CONF_TYPE_ABBREVIATIONS
static String	CONF_UNDECLARED_KEY_COMMENT
static String	CONF_UNDECLARED_KEY_POLICY
static String	ERROR_CONF_FILE_ERROR
static String	ERROR_ILLEGAL_BUNDLE_MAPPING
static String	ERROR_ILLEGAL_EXTERNAL_PACKAGE_MAPPING
static String	ERROR_ILLEGAL_IMPORT
static String	ERROR_ILLEGAL_LOCALE
static String	ERROR_ILLEGAL_TYPE_ABBREVIATION
static String	ERROR_MISSING_IMPORT
static String	ERROR_MISSING_OPTION
static String	ERROR_UNKNOWN_VALUE
static String	PROJECT_CONF_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
ProjectConf(ConfValueProvider confProvider)

Method Summary

Modifier and Type	Method	Description
MessageBundleManager<Path,Path>	createDefaultMessageBundleManager()
String	getBundleDir()
Charset	getBundleEncoding()
List<BundleMapping>	getBundleMappings()
BundleMismatchPolicy	getBundleMismatchPolicy()
List<PackageMapping>	getExternalPackageMappings()
boolean	getGenerateConstants()
boolean	getGenerateProxies()
Set<String>	getIgnoredBundles()
List<String>	getImportedModules()
List<String>	getImports()
MessageArgPolicy	getMessageArgPolicy()
String	getMessageFormat()
MissingMessagePolicy	getMissingMessagePolicy()
Mode	getMode()
String	getModuleName()
String	getProjectDir()
List<Locale>	getTargetLocales()
Map<String,String>	getTypeAbbreviations()
String	getUndeclaredKeyComment()
UndeclaredKeyPolicy	getUndeclaredKeyPolicy()
void	resolveBundleMappings(Function<String,MessageModule> importedModuleProvider)
Optional<String>	toTargetBundleName(String messageKey)	Returns the most specific bundle name for the given message key after applying the bundle root mappings.
Optional<String>	toTargetBundleName(String messageKey, boolean onlyLocalMappings)
String	toTargetForExternalPackage(String packageName)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CONF_FILE_ERROR

public static final String ERROR_CONF_FILE_ERROR

See Also:

Constant Field Values

ERROR_MISSING_OPTION

public static final String ERROR_MISSING_OPTION

See Also:

Constant Field Values

ERROR_ILLEGAL_LOCALE

public static final String ERROR_ILLEGAL_LOCALE

See Also:

Constant Field Values

ERROR_ILLEGAL_BUNDLE_MAPPING

public static final String ERROR_ILLEGAL_BUNDLE_MAPPING

See Also:

Constant Field Values

ERROR_ILLEGAL_TYPE_ABBREVIATION

public static final String ERROR_ILLEGAL_TYPE_ABBREVIATION

See Also:

Constant Field Values

ERROR_ILLEGAL_IMPORT

public static final String ERROR_ILLEGAL_IMPORT

See Also:

Constant Field Values

ERROR_MISSING_IMPORT

public static final String ERROR_MISSING_IMPORT

See Also:

Constant Field Values

ERROR_ILLEGAL_EXTERNAL_PACKAGE_MAPPING

public static final String ERROR_ILLEGAL_EXTERNAL_PACKAGE_MAPPING

See Also:

Constant Field Values

ERROR_UNKNOWN_VALUE

public static final String ERROR_UNKNOWN_VALUE

See Also:

Constant Field Values

PROJECT_CONF_FILE_NAME

public static final String PROJECT_CONF_FILE_NAME

See Also:

Constant Field Values

CONF_PREFIX

public static final String CONF_PREFIX

See Also:

Constant Field Values

CONF_PROJECT_DIR

public static final String CONF_PROJECT_DIR

See Also:

Constant Field Values

CONF_MODULE_NAME

public static final String CONF_MODULE_NAME

See Also:

Constant Field Values

CONF_BUNDLE_DIR

public static final String CONF_BUNDLE_DIR

See Also:

Constant Field Values

BUNDLE_DIR_DEFAULT

public static final String BUNDLE_DIR_DEFAULT

See Also:

Constant Field Values

CONF_BUNDLE_ENCODING

public static final String CONF_BUNDLE_ENCODING

See Also:

Constant Field Values

CONF_BUNDLES

public static final String CONF_BUNDLES

See Also:

Constant Field Values

CONF_IGNORED_BUNDLES

public static final String CONF_IGNORED_BUNDLES

See Also:

Constant Field Values

CONF_TARGET_LOCALES

public static final String CONF_TARGET_LOCALES

See Also:

Constant Field Values

CONF_IMPORTS

public static final String CONF_IMPORTS

See Also:

Constant Field Values

CONF_TYPE_ABBREVIATIONS

public static final String CONF_TYPE_ABBREVIATIONS

See Also:

Constant Field Values

CONF_MODE

public static final String CONF_MODE

See Also:

Constant Field Values

CONF_MISSING_MESSAGE_POLICY

public static final String CONF_MISSING_MESSAGE_POLICY

See Also:

Constant Field Values

CONF_MESSAGE_ARG_POLICY

public static final String CONF_MESSAGE_ARG_POLICY

See Also:

Constant Field Values

CONF_UNDECLARED_KEY_POLICY

public static final String CONF_UNDECLARED_KEY_POLICY

See Also:

Constant Field Values

CONF_UNDECLARED_KEY_COMMENT

public static final String CONF_UNDECLARED_KEY_COMMENT

See Also:

Constant Field Values

CONF_BUNDLE_MISMATCH_POLICY

public static final String CONF_BUNDLE_MISMATCH_POLICY

See Also:

Constant Field Values

CONF_MESSAGE_FORMAT

public static final String CONF_MESSAGE_FORMAT

See Also:

Constant Field Values

CONF_GENERATE_CONSTANTS

public static final String CONF_GENERATE_CONSTANTS

See Also:

Constant Field Values

CONF_GENERATE_PROXIES

public static final String CONF_GENERATE_PROXIES

See Also:

Constant Field Values

CONF_EXTERNAL_PACKAGE_MAPPING

public static final String CONF_EXTERNAL_PACKAGE_MAPPING

See Also:

Constant Field Values

ALL_CONF_NAMES

public static final List<String> ALL_CONF_NAMES

Constructor Detail

ProjectConf

public ProjectConf(ConfValueProvider confProvider)
            throws ProjectConfException

Throws:

ProjectConfException

Method Detail

getProjectDir

public String getProjectDir()

getModuleName

public String getModuleName()

Specified by:

getModuleName in interface MessageModule

getBundleDir

public String getBundleDir()

getBundleEncoding

public Charset getBundleEncoding()

getIgnoredBundles

public Set<String> getIgnoredBundles()

getBundleMappings

public List<BundleMapping> getBundleMappings()

Specified by:

getBundleMappings in interface MessageModule

getTargetLocales

public List<Locale> getTargetLocales()

Specified by:

getTargetLocales in interface MessageModule

getImportedModules

public List<String> getImportedModules()

Specified by:

getImportedModules in interface MessageModule

getImports

public List<String> getImports()

getTypeAbbreviations

public Map<String,String> getTypeAbbreviations()

getMode

public Mode getMode()

getMissingMessagePolicy

public MissingMessagePolicy getMissingMessagePolicy()

getMessageArgPolicy

public MessageArgPolicy getMessageArgPolicy()

getUndeclaredKeyPolicy

public UndeclaredKeyPolicy getUndeclaredKeyPolicy()

getUndeclaredKeyComment

public String getUndeclaredKeyComment()

getBundleMismatchPolicy

public BundleMismatchPolicy getBundleMismatchPolicy()

getMessageFormat

public String getMessageFormat()

Specified by:

getMessageFormat in interface MessageModule

getGenerateConstants

public boolean getGenerateConstants()

getGenerateProxies

public boolean getGenerateProxies()

getExternalPackageMappings

public List<PackageMapping> getExternalPackageMappings()

toTargetForExternalPackage

public String toTargetForExternalPackage(String packageName)

resolveBundleMappings

public void resolveBundleMappings(Function<String,MessageModule> importedModuleProvider)
                           throws ProjectConfException

Throws:

ProjectConfException

toTargetBundleName

public Optional<String> toTargetBundleName(String messageKey)

Returns the most specific bundle name for the given message key after applying the bundle root mappings.

Parameters:

messageKey - a message key

Returns:

the target bundle name for the given message key or null if no mapping is available

toTargetBundleName

public Optional<String> toTargetBundleName(String messageKey,
                                           boolean onlyLocalMappings)

createDefaultMessageBundleManager

public MessageBundleManager<Path,Path> createDefaultMessageBundleManager()