Package org.nuiton.jaxx.runtime.application

Interface ApplicationConfiguration

public interface ApplicationConfiguration

Created by tchemit on 27/01/2018.

Author:

Tony Chemit - dev@tchemit.fr

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApplicationConfiguration.DefaultOptions

Method Summary

Modifier and Type	Method	Description
io.ultreia.java4all.config.ApplicationConfig	get()
default List<io.ultreia.java4all.config.spi.ConfigOptionDef>	getAllOptions()
default Date	getApplicationBuildDate()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_DATE configuration option.
default String	getApplicationBuildNumber()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_NUMBER configuration option.
default io.ultreia.java4all.util.Version	getApplicationBuildVersion()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_VERSION configuration option.
default String	getApplicationCopyrightText()
default String	getApplicationId()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ID configuration option.
default int	getApplicationInceptionYear()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_INCEPTION_YEAR configuration option.
default String	getApplicationLicenseName()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LICENSE_NAME configuration option.
default URL	getApplicationLicenseUrl()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LICENSE_URL configuration option.
default Locale	getApplicationLocale()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LOCALE configuration option.
default String	getApplicationName()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_NAME configuration option.
default String	getApplicationOrganizationName()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ORGANIZATION_NAME configuration option.
default URL	getApplicationOrganizationUrl()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ORGANIZATION_URL configuration option.
default URL	getApplicationSiteUrl()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_SITE_URL configuration option.
default io.ultreia.java4all.util.Version	getApplicationVersion()	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_VERSION configuration option.
default File	getDataDirectory()	Note: bind to ApplicationConfiguration.DefaultOptions.DATA_DIRECTORY configuration option.
default String	getI18nBundleName()	Note: bind to ApplicationConfiguration.DefaultOptions.I18N_BUNDLE_NAME configuration option.
default File	getI18nDefinitionFile()	Note: bind to ApplicationConfiguration.DefaultOptions.I18N_DEFINITION_FILE configuration option.
default File	getI18nDirectory()	Note: bind to ApplicationConfiguration.DefaultOptions.I18N_DIRECTORY configuration option.
default String	getI18nPrefix()	Note: bind to ApplicationConfiguration.DefaultOptions.I18N_PREFIX configuration option.
default String	getI18nProviderName()	Note: bind to ApplicationConfiguration.DefaultOptions.I18N_PROVIDER_NAME configuration option.
default File	getLogConfigurationFile()	Note: bind to ApplicationConfiguration.DefaultOptions.LOG_CONFIGURATION_FILE configuration option.
default File	getResourcesDirectory()	Note: bind to ApplicationConfiguration.DefaultOptions.RESOURCES_DIRECTORY configuration option.
default File	getSwingSessionFile()	Note: bind to ApplicationConfiguration.DefaultOptions.UI_SWING_SESSION_FILE configuration option.
default File	getTmpDirectory()	Note: bind to ApplicationConfiguration.DefaultOptions.TMP_DIRECTORY configuration option.
default void	initConfig(Properties p, String... args)
default boolean	isFullScreen()	Note: bind to ApplicationConfiguration.DefaultOptions.UI_FULL_SCREEN configuration option.
static List<String>	loadProperties(List<String> sourceProperties, io.ultreia.java4all.config.ApplicationConfig config)
static Properties	loadProperties(Properties sourceProperties, io.ultreia.java4all.config.ApplicationConfig config)
default List<io.ultreia.java4all.config.spi.ConfigOptionDef>	orderedByKey(List<io.ultreia.java4all.config.spi.ConfigOptionDef> options)
default void	printActions(StringBuilder out, io.ultreia.java4all.config.spi.ConfigActionDef... actions)
default void	printConfigurationOptions(StringBuilder builder)
default void	printOptions(StringBuilder out, io.ultreia.java4all.config.spi.ConfigOptionDef... options)
void	removeJaxxPropertyChangeListener()
default void	setApplicationLocale(Locale applicationLocale)	Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LOCALE configuration option.
default void	setFullScreen(boolean fullScreen)	Change full screen state value.

Method Detail

loadProperties

static Properties loadProperties(Properties sourceProperties,
                                 io.ultreia.java4all.config.ApplicationConfig config)

loadProperties

static List<String> loadProperties(List<String> sourceProperties,
                                   io.ultreia.java4all.config.ApplicationConfig config)

get

io.ultreia.java4all.config.ApplicationConfig get()

getApplicationId

default String getApplicationId()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ID configuration option.

Returns:

id of application (this is used as prefix of everything in application).

getApplicationName

default String getApplicationName()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_NAME configuration option.

Returns:

name of application

getApplicationVersion

default io.ultreia.java4all.util.Version getApplicationVersion()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_VERSION configuration option.

Returns:

stable version of application (remove any snapshot suffix)

getApplicationOrganizationName

default String getApplicationOrganizationName()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ORGANIZATION_NAME configuration option.

Returns:

organization name of application

getApplicationOrganizationUrl

default URL getApplicationOrganizationUrl()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_ORGANIZATION_URL configuration option.

Returns:

organization url of application

getApplicationInceptionYear

default int getApplicationInceptionYear()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_INCEPTION_YEAR configuration option.

Returns:

inceptionYear of application

getApplicationLocale

default Locale getApplicationLocale()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LOCALE configuration option.

Returns:

locale of application

setApplicationLocale

default void setApplicationLocale(Locale applicationLocale)

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LOCALE configuration option.

Parameters:

applicationLocale - new locale of application

getApplicationSiteUrl

default URL getApplicationSiteUrl()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_SITE_URL configuration option.

Returns:

site url of application

getApplicationLicenseName

default String getApplicationLicenseName()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LICENSE_NAME configuration option.

Returns:

license name of application

getApplicationLicenseUrl

default URL getApplicationLicenseUrl()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_LICENSE_URL configuration option.

Returns:

license url of application

getApplicationBuildVersion

default io.ultreia.java4all.util.Version getApplicationBuildVersion()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_VERSION configuration option.

Returns:

version of build

getApplicationBuildDate

default Date getApplicationBuildDate()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_DATE configuration option.

Returns:

date of build

getApplicationBuildNumber

default String getApplicationBuildNumber()

Note: bind to ApplicationConfiguration.DefaultOptions.APPLICATION_BUILD_NUMBER configuration option.

Returns:

number of build

getI18nDirectory

default File getI18nDirectory()

Note: bind to ApplicationConfiguration.DefaultOptions.I18N_DIRECTORY configuration option.

Returns:

i18n directory

getI18nDefinitionFile

default File getI18nDefinitionFile()

Note: bind to ApplicationConfiguration.DefaultOptions.I18N_DEFINITION_FILE configuration option.

Returns:

i18n definition file

getI18nBundleName

default String getI18nBundleName()

Note: bind to ApplicationConfiguration.DefaultOptions.I18N_BUNDLE_NAME configuration option.

Returns:

name of i18n bundle

getI18nProviderName

default String getI18nProviderName()

Note: bind to ApplicationConfiguration.DefaultOptions.I18N_PROVIDER_NAME configuration option.

Returns:

name of i18n provider

getI18nPrefix

default String getI18nPrefix()

Note: bind to ApplicationConfiguration.DefaultOptions.I18N_PREFIX configuration option.

Returns:

i18n prefix

getDataDirectory

default File getDataDirectory()

Note: bind to ApplicationConfiguration.DefaultOptions.DATA_DIRECTORY configuration option.

Returns:

data directory (user directory where to place all data of application)

getTmpDirectory

default File getTmpDirectory()

Note: bind to ApplicationConfiguration.DefaultOptions.TMP_DIRECTORY configuration option.

Returns:

temporary directory (content is delete at each launch)

getResourcesDirectory

default File getResourcesDirectory()

Note: bind to ApplicationConfiguration.DefaultOptions.RESOURCES_DIRECTORY configuration option.

Returns:

resources directory (each version has his own directory)

getLogConfigurationFile

default File getLogConfigurationFile()

Note: bind to ApplicationConfiguration.DefaultOptions.LOG_CONFIGURATION_FILE configuration option.

Returns:

log configuration file

getSwingSessionFile

default File getSwingSessionFile()

Note: bind to ApplicationConfiguration.DefaultOptions.UI_SWING_SESSION_FILE configuration option.

Returns:

swing session file

isFullScreen

default boolean isFullScreen()

Note: bind to ApplicationConfiguration.DefaultOptions.UI_FULL_SCREEN configuration option.

Returns:

full screen state

setFullScreen

default void setFullScreen(boolean fullScreen)

Change full screen state value.

Parameters:

fullScreen - new state value

getApplicationCopyrightText

default String getApplicationCopyrightText()

printConfigurationOptions

default void printConfigurationOptions(StringBuilder builder)

getAllOptions

default List<io.ultreia.java4all.config.spi.ConfigOptionDef> getAllOptions()

printOptions

default void printOptions(StringBuilder out,
                          io.ultreia.java4all.config.spi.ConfigOptionDef... options)

printActions

default void printActions(StringBuilder out,
                          io.ultreia.java4all.config.spi.ConfigActionDef... actions)

initConfig

default void initConfig(Properties p,
                        String... args)
                 throws io.ultreia.java4all.config.ArgumentsParserException

Throws:

io.ultreia.java4all.config.ArgumentsParserException

orderedByKey

default List<io.ultreia.java4all.config.spi.ConfigOptionDef> orderedByKey(List<io.ultreia.java4all.config.spi.ConfigOptionDef> options)

removeJaxxPropertyChangeListener

void removeJaxxPropertyChangeListener()