Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.internal

Class Commons

java.lang.Object

org.tquadrat.foundation.config.internal.Commons

@UtilityClass
@ClassVersion(sourceVersion="$Id: Commons.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
@UseAdditionalTexts
public final class Commons
extends Object

The internal tools for the configuration module.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Commons.java 1061 2023-09-25 16:32:43Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.internal.Commons"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_BUNDLE_NAME	The name of the resource bundle with the messages and texts for this module: "org.tquadrat.foundation.config.MessagesAndTexts".
private static final ResourceBundle	m_ResourceBundle	The resource bundle that is used by this module.
static final String	MESSAGE_PREFIX	The message prefix: "CFG".

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Commons()	No instance allowed for this class!

Method Summary

Modifier and Type	Method	Description
static final CmdLineException	createException(Class<? extends StringConverter> stringConverterClass, Throwable cause, String value)	Creates an instance of CmdLineException based on the given arguments.
static final String	retrieveMessage(int key, boolean addKey, Object... args)	Retrieves the message with the given key from the resource bundle and applies the given arguments to it.
static final String	retrieveText(String key, Object... args)	Retrieves the text with the given key from the resource bundle and applies the given arguments to it.

Methods inherited from class java.lang.Object

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

Field Details

BASE_BUNDLE_NAME

@BaseBundleName(defaultLanguage="en")
public static final String BASE_BUNDLE_NAME

The name of the resource bundle with the messages and texts for this module: "org.tquadrat.foundation.config.MessagesAndTexts".

See Also:

• Constant Field Values

MESSAGE_PREFIX

public static final String MESSAGE_PREFIX

The message prefix: "CFG".

See Also:

• Constant Field Values

m_ResourceBundle

private static final ResourceBundle m_ResourceBundle

The resource bundle that is used by this module.

Constructor Details

Commons

private Commons()

No instance allowed for this class!

Method Details

createException

public static final CmdLineException createException(Class<? extends StringConverter> stringConverterClass,
 Throwable cause,
 String value)

Creates an instance of CmdLineException based on the given arguments.

Parameters:

stringConverterClass - The class of the StringConverter implementation.

cause - The causing Exception.

value - The problematic value.

Returns:

The instance of CmdLineException.

retrieveMessage

public static final String retrieveMessage(int key,
 boolean addKey,
 Object... args)

Retrieves the message with the given key from the resource bundle and applies the given arguments to it.

If the resource bundle does not contain a message for the given key, the key itself will be returned, appended with the arguments.

Parameters:

key - The key for the message.

addKey - The recommended value is true; this means that the message will be prefixed with the generated message key.

args - The arguments for the message.

Returns:

The text.

See Also:

• Objects.toString(Object)

retrieveText

public static final String retrieveText(String key,
 Object... args)

Retrieves the text with the given key from the resource bundle and applies the given arguments to it.

If the resource bundle does not contain a text for the given key, the key itself will be returned, appended with the arguments.

Parameters:

key - The key for the text.

args - The arguments for the text.

Returns:

The text.

See Also:

• Objects.toString(Object)