com.lf.vfslib.core

Class VFSLibSettings

java.lang.Object

com.lf.vfslib.core.VFSLibSettings

public class VFSLibSettings
extends java.lang.Object

Global settings for the VFSLib package.

Since:

1.6

Version:

$Revision: 1.6 $, $Date: 2013/10/12 10:50:01 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_PREFIX Prefix used for the log messages created by this module.
static java.lang.String	MSG_PREFIX Prefix used for the log messages like "VFSLIB-0001".
protected static VFSLibSettings	sharedInstance Shared VFSLibSettings instance.
protected static VFSFileSystemManager	vfsManagerNetwork Shared FileSystemManager instance holding the network connections.

Constructor Summary

Constructors

Constructor and Description
VFSLibSettings() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
void	check() Performs some simple tests for the caches and configurations and creates log messages.
static int	extractLocalization(java.lang.Object target) Searches for localization patterns and reads the object texts into the configuration.
com.lf.commons.lang.DeployProps	getDeployProps() Gets the global version information.
static java.lang.String	getEnglishMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable) Convenience method to get the original (English) text.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get the original (English) text.
com.lf.commons.i18n.I18NConfiguration	getEnglishTexts() Provides the English texts for the GUI (labels, tooltips etc.).
java.lang.String	getI18NBase() Provides the global resource path for internationalization resources.
com.lf.commons.i18n.I18NConfiguration	getI18NTexts() Provides the global localized texts for the user.
java.util.logging.Logger	getLogger() Gets the global logging instance.
com.lf.commons.i18n.Locale	getLogLocale() Gets the global locale used for logging.
static VFSFileSystemManager	getManagerNetwork() Get a shared instance of the Commons FileSystemManager holding the network connections.
com.lf.commons.msg.MessageCodes	getMessageCodes() Provides the global message codes handlers.
static VFSLibSettings	getSharedInstance() Convenience method to get a shared instance.
java.util.Vector<com.lf.commons.i18n.Locale>	getSupportedLocales(boolean synonyms) Returns the locales currently supported by the package.
com.lf.commons.i18n.Locale	getUserLocale() Gets the global user locale.
static java.lang.String	getUserMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getUserMessage(java.lang.String code, boolean prefix) Convenience method to get a localized official message for the user.
static java.lang.String	getUserMessage(java.lang.String code, java.lang.String[] regex, java.lang.String[] replacement, boolean prefix) Convenience method to log a localized official message.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable) Convenience method to get a localized text for the user.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get a localized text for the user.
static void	localize(java.lang.Object target, java.lang.Class targetclazz) Provides the info whether to enable object localization or not.
static void	log(java.util.logging.Level level, java.lang.String message) Convenience method to log a message.
static void	logMessage(java.util.logging.Level level, java.lang.String message) Convenience method to log a message.
static void	logMessage(java.lang.String code, java.util.logging.Level level) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String regex, java.lang.String replacement) Convenience method to log a localized official message.
static void	main(java.lang.String[] arg) This may be used especially for debugging purposes.
void	setLogger(java.util.logging.Logger logger) Sets the global logging instance.
void	setUserLocale(com.lf.commons.i18n.Locale locale) Sets the global user locale.

Methods inherited from class java.lang.Object

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

Field Detail

sharedInstance

protected static VFSLibSettings sharedInstance

Shared VFSLibSettings instance.

vfsManagerNetwork

protected static VFSFileSystemManager vfsManagerNetwork

Shared FileSystemManager instance holding the network connections.

MSG_PREFIX

public static final java.lang.String MSG_PREFIX

Prefix used for the log messages like "VFSLIB-0001".

See Also:

Constant Field Values

LOG_PREFIX

public static final java.lang.String LOG_PREFIX

Prefix used for the log messages created by this module.

See Also:

Constant Field Values

Constructor Detail

VFSLibSettings

public VFSLibSettings()

Constructor method.

Since:

1.6

Method Detail

getManagerNetwork

public static VFSFileSystemManager getManagerNetwork()

Get a shared instance of the Commons FileSystemManager holding the network connections.

Here, the connections are managed while the global VFSFileSystemManager (which can be accessed using VFSUtils.getManager()) does not.

Returns:

Shared instance

Since:

1.6

check

public void check()

Performs some simple tests for the caches and configurations and creates log messages.

If either the configurations, or the message codes, or the build properties are absent, then the application should be interrupted since this is fatal.

Since:

1.6

getI18NBase

public java.lang.String getI18NBase()

Provides the global resource path for internationalization resources.

Returns:

The i18n path for use with separate localization JARs

Since:

1.6

getI18NTexts

public com.lf.commons.i18n.I18NConfiguration getI18NTexts()

Provides the global localized texts for the user.

Returns:

The localized texts

Since:

1.6

getEnglishTexts

public com.lf.commons.i18n.I18NConfiguration getEnglishTexts()

Provides the English texts for the GUI (labels, tooltips etc.).

Returns:

The English texts

Since:

1.6

localize

public static void localize(java.lang.Object target,
            java.lang.Class targetclazz)

Provides the info whether to enable object localization or not.

Parameters:

target - The target object to be localized

targetclazz - The target clazz, maybe a superclass

Since:

1.6

extractLocalization

public static int extractLocalization(java.lang.Object target)

Searches for localization patterns and reads the object texts into the configuration.

Parameters:

target - The target object to be localized

Returns:

Number of successfully retrieved fields

Since:

1.6

getMessageCodes

public com.lf.commons.msg.MessageCodes getMessageCodes()

Provides the global message codes handlers.

Returns:

The message codes handlers

Since:

1.6

getLogger

public java.util.logging.Logger getLogger()

Gets the global logging instance.

Returns:

Logging instance

Since:

1.6

setLogger

public void setLogger(java.util.logging.Logger logger)

Sets the global logging instance.

Parameters:

logger - Logging instance

Throws:

java.lang.NullPointerException - Error indication

Since:

1.6

getUserLocale

public com.lf.commons.i18n.Locale getUserLocale()

Gets the global user locale.

Returns:

Current user locale

Since:

1.6

setUserLocale

public void setUserLocale(com.lf.commons.i18n.Locale locale)
                   throws java.lang.IllegalArgumentException

Sets the global user locale.

Make sure that the given new locale is supported by the settings class.

Parameters:

locale - Locale instance

Throws:

java.lang.IllegalArgumentException - Error indication

Since:

1.6

getSupportedLocales

public java.util.Vector<com.lf.commons.i18n.Locale> getSupportedLocales(boolean synonyms)

Returns the locales currently supported by the package.

Parameters:

synonyms - Also add the ISO 639-1/2 synonyms like "deu_DE" for "ger_DE"?

Returns:

The supported locales, maybe empty

Since:

1.6

getLogLocale

public com.lf.commons.i18n.Locale getLogLocale()

Gets the global locale used for logging.

At the moment this is static since exceptions and most System.outs are in English.

Returns:

Current logging locale

Since:

1.6

getDeployProps

public com.lf.commons.lang.DeployProps getDeployProps()

Gets the global version information.

Returns:

Current version information

Since:

1.6

getSharedInstance

public static VFSLibSettings getSharedInstance()

Convenience method to get a shared instance.

Returns:

Shared instance

Since:

1.6

log

public static void log(java.util.logging.Level level,
       java.lang.String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally "eng_US"). The log prefix like "[vfslib]" is prepended.

Parameters:

level - The log level

message - The log message

Since:

1.6

logMessage

public static void logMessage(java.util.logging.Level level,
              java.lang.String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally "eng_US"). The log prefix like "[vfslib]" is prepended.

Parameters:

level - The log level

message - The log message

Since:

1.6

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "VFSLIB-0006") while the package log prefix is omitted (e.g. "[vfslib]").

Parameters:

code - The log message id like "VFSLIB-0006"

level - The log level

Since:

1.6

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String regex,
              java.lang.String replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "VFSLIB-0006") while the package log prefix is omitted (e.g. "[vfslib]").

Parameters:

code - The log message id like "VFSLIB-0006"

level - The log level

regex - The regular expression

replacement - The replacement string

Since:

1.6

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String[] regex,
              java.lang.String[] replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "VFSLIB-0006") while the package log prefix is omitted (e.g. "[vfslib]").

Parameters:

code - The log message id like "VFSLIB-0006"

level - The log level

regex - The regular expressions

replacement - The replacement strings

Since:

1.6

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code)

Convenience method to get a localized official message for the user.

The message is returned using the current user locale (e.g. "eng_US"). The domain identifier is prepended (e.g. "VFSLIB-0006").

Parameters:

code - The message code of interest, don't pass null values

Returns:

The message text, null if code does not exist

Since:

1.6

getEnglishMessage

public static java.lang.String getEnglishMessage(java.lang.String code)

Convenience method to get a localized official message for the user.

The message is returned using the "eng_US" locale. The domain identifier is prepended (e.g. "LIMA-0006").

Parameters:

code - The message code of interest, don't pass null values

Returns:

The message text, null if code does not exist

Since:

1.6

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code,
                              boolean prefix)

Convenience method to get a localized official message for the user.

The message is returned using the current user locale (e.g. "eng_US"). The domain identifier is prepended (e.g. "VFSLIB-0006").

Parameters:

code - The message code of interest, don't pass null values

prefix - Prepend the prefix?

Returns:

The message text, null if code does not exist

Since:

1.6

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code,
                              java.lang.String[] regex,
                              java.lang.String[] replacement,
                              boolean prefix)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "VFSLIB-0006") while the package log prefix is omitted (e.g. "[vfslib]").

Parameters:

code - The log message id like "VFSLIB-0006"

regex - The regular expression

replacement - The replacement string

prefix - Prepend the prefix?

Returns:

The message text, null if code does not exist

Since:

1.6

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable)

Convenience method to get a localized text for the user.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

Returns:

The localized text or the variable

Since:

1.6

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable)

Convenience method to get the original (English) text.

The message is returned using the locale "eng_US". These texts are useful for the support.

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

Returns:

The localized text, null if variable does not exist

Since:

1.6

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable,
                              java.lang.String[] regex,
                              java.lang.String[] replacement)

Convenience method to get the original (English) text.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

regex - The regular expression

replacement - The replacement string

Returns:

The localized text or the variable

Since:

1.6

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable,
                           java.lang.String[] regex,
                           java.lang.String[] replacement)

Convenience method to get a localized text for the user.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

regex - The regular expression

replacement - The replacement string

Returns:

The localized text or the variable

Since:

1.6

main

public static void main(java.lang.String[] arg)
                 throws java.lang.Exception

This may be used especially for debugging purposes.

Parameters:

arg - Array of String objects with console params

Throws:

java.lang.Exception - Error indication

Since:

1.6