Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Interface ConfigBeanSpec

All Known Subinterfaces:

CLIBeanSpec, I18nSupport, INIBeanSpec, PreferencesBeanSpec, SessionBeanSpec

@ClassVersion(sourceVersion="$Id: ConfigBeanSpec.java 1010 2022-02-05 19:28:36Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public interface ConfigBeanSpec

The base for the specification of a configuration bean; the final specification interface must also be annotated with @ConfigurationBeanSpecification in order to be recognised properly.

The generation process will generate only getter and setter methods, other methods must be provided as default.

If the configuration bean should be initialised through command line arguments, the specification interface must extend CLIBeanSpec, and if it should work with Preferences, the interface needs to extend PreferencesBeanSpec. It could extend both.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ConfigBeanSpec.java 1010 2022-02-05 19:28:36Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ConfigBeanSpec"

⁠

Method Summary

Modifier and Type	Method	Description
void	addListener(ConfigurationChangeListener listener)	Adds a new ConfigurationChangeListener to this configuration bean.
Charset	getCharset()	Returns the Charset that is used throughout the program run.
Locale	getLocale()	Returns the locale that is used throughout the program run.
Optional<ResourceBundle>	getResourceBundle()	Returns the ResourceBundle that should be used to retrieve texts and messages for the application.
ZoneId	getTimezone()	Returns the time zone that is used throughout the program run.
boolean	isDebug()	Returns a flag that indicates whether the application should produce debug output of some kind.
boolean	isTest()	Returns a flag that indicates whether the application should produce test output of some kind.
void	removeListener(ConfigurationChangeListener listener)	Removes the given ConfigurationChangeListener from this configuration bean.
void	setCharset(Charset charset)	Sets the Charset that should be used throughout the program run. Setting a new Charset with this method will not change the system default Charset.
void	setLocale(Locale locale)	Sets the locale that should be used throughout the program run. Setting a new locale with this method will not change the system default locale.
void	setTimezone(ZoneId timezone)	Sets the time zone that should be used throughout the program run. Setting a new time zone with this method will not change the system default time zone.

Method Details

addListener

void addListener(ConfigurationChangeListener listener)

Adds a new ConfigurationChangeListener to this configuration bean.

Parameters:

listener - The new listener.

removeListener

void removeListener(ConfigurationChangeListener listener)

Removes the given ConfigurationChangeListener from this configuration bean.

Parameters:

listener - The listener to remove.

getCharset

@SpecialProperty(CONFIG_PROPERTY_CHARSET)
@ExemptFromToString
Charset getCharset()

Returns the Charset that is used throughout the program run. If it was not modified by a call to setCharset(Charset), this method will return the default Charset or a Charset that was previously stored as a preference value, if configured.

The Charset cannot be set via a self-defined command line option, but through JVM options:

java -Dfile.encoding=<charset> <program> <program_options …>

Returns:

The Charset.

See Also:

• Charset.defaultCharset()
• CommonConstants.PROPERTY_FILE_ENCODING

getLocale

@SpecialProperty(CONFIG_PROPERTY_LOCALE)
Locale getLocale()

Returns the locale that is used throughout the program run. If it was not modified by a call to setLocale(Locale) this method will return the default locale or a locale that was previously stored as a preference value, if configured.

The locale cannot be set via a self-defined command line option, but through JVM options:

java -Duser.country=<country_code> -Duser.language=<language_code> <program> <program_options …>

Returns:

The locale.

See Also:

• Locale.getDefault()
• CommonConstants.PROPERTY_USER_COUNTRY
• CommonConstants.PROPERTY_USER_LANG

getResourceBundle

@SpecialProperty(CONFIG_PROPERTY_RESOURCEBUNDLE)
@ExemptFromToString
Optional<ResourceBundle> getResourceBundle()

Returns the ResourceBundle that should be used to retrieve texts and messages for the application.

Usually the resource bundle is set under the hood (i.e. when the configuration bean specification implements I18nSupport) or with the method initData(). But if necessary, a setter for this attribute can be added to the configuration bean specification like this:

  /**
   *  Sets the
   *  {@link ResourceBundle}
   *  that should be used to retrieve texts and messages for the
   *  application.<br>
   *  <br>As default, there is no {@code ResourceBundle} set
   *  ({@link #getResourceBundle()}
   *  returns
   *  {@link Optional#empty()}),
   *  but it not allowed to call this method with the argument {@code null}
   *  for the {@code bundle} argument.
   *
   *  @param  bundle  The resource bundle.
   */
  @SpecialProperty( CONFIG_PROPERTY_RESOURCEBUNDLE )
  @CheckNull
  public void setResourceBundle( final ResourceBundle bundle );

Returns:

An instance of Optional that holds the resource bundle.

getTimezone

@SpecialProperty(CONFIG_PROPERTY_TIMEZONE)
ZoneId getTimezone()

Returns the time zone that is used throughout the program run. If it was not modified by a call to setTimezone(ZoneId) this method will return the default time zone or a time zone that was previously stored as a preference value, if configured.

The time zone cannot be set via a self-defined command line option, but through JVM options:

java -Duser.timezone=<zone_id> <program> <program_options …>

Returns:

The time zone.

See Also:

• ZoneId.systemDefault()
• CommonConstants.PROPERTY_USER_TIMEZONE

isDebug

@SystemProperty(value="isDebug",
                defaultValue="false")
@PropertyName("isDebug")
boolean isDebug()

Returns a flag that indicates whether the application should produce debug output of some kind.

Returns:

true if the application is in debug mode, false otherwise.

See Also:

• CommonConstants.PROPERTY_IS_DEBUG

isTest

@SystemProperty(value="isTest",
                defaultValue="false")
@PropertyName("isTest")
boolean isTest()

Returns a flag that indicates whether the application should produce test output of some kind.

Returns:

true if the application is in test mode, false otherwise.

See Also:

• CommonConstants.PROPERTY_IS_TEST

setCharset

@SpecialProperty(CONFIG_PROPERTY_CHARSET)
void setCharset(Charset charset)

Sets the Charset that should be used throughout the program run.

Setting a new Charset with this method will not change the system default Charset.

Parameters:

charset - The new Charset; if null, the Charset will be set to the default locale.

See Also:

• Charset.defaultCharset()

setLocale

@SpecialProperty(CONFIG_PROPERTY_LOCALE)
void setLocale(Locale locale)

Sets the locale that should be used throughout the program run.

Setting a new locale with this method will not change the system default locale.

Parameters:

locale - The new locale; if null, the locale will be set to the default locale.

See Also:

• Locale.getDefault()

setTimezone

@SpecialProperty(CONFIG_PROPERTY_TIMEZONE)
void setTimezone(ZoneId timezone)

Sets the time zone that should be used throughout the program run.

Setting a new time zone with this method will not change the system default time zone.

Parameters:

timezone - The new time zone; if null the time zone will be set to the default time zone.