Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Annotation Interface ConfigurationBeanSpecification

@ClassVersion(sourceVersion="$Id: ConfigurationBeanSpecification.java 920 2021-05-23 14:27:24Z tquadrat $")
@Documented
@Retention(RUNTIME)
@Target(TYPE)
@API(status=STABLE,
     since="0.0.1")
public @interface ConfigurationBeanSpecification

The marker for a configuration bean specification. It will work only on interfaces that extend ConfigBeanSpec.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ConfigurationBeanSpecification.java 920 2021-05-23 14:27:24Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

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

⁠

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>	baseClass	The optional base class for the new configuration bean.
String	initDataResource	The name of the resource with the initialisation data for the configuration bean.
String	name	The fully qualified name of the class that implements the configuration bean.
boolean	samePackage	The flag that determines the package for the generated bean.
boolean	synchronizeAccess	The flag that indicates whether the access to the configuration bean properties should be synchronised.

Element Details

baseClass

Class<?> baseClass

The optional base class for the new configuration bean. The default is Object (and will be ignored).

Returns:

The base class.

Default:

java.lang.Object.class

initDataResource

String initDataResource

The name of the resource with the initialisation data for the configuration bean.

The resource file must have the format of a Java properties file, and the name is relative to the location of the configuration bean specification interface itself.

The special value "=" translates to the simple name of the interface, suffixed with .properties; this means, for a specification interface named com.sample.Specification, the resulting name for the property would be Specification.properties.

The keys for the properties are properties as specified in the configuration bean specification interface.

Returns:

The resource name for an initialisation data property; the default is not having such a resource.

See Also:

• Properties
• Class.getResourceAsStream(String)

Default:

""

name

String name

The fully qualified name of the class that implements the configuration bean. The default is the empty String.

If no explicit class name is set, it will be derived from the name of the interface that specifies the configuration bean as below:

  var packageName = specification.getClass().getPackageName();
  var specificationName = specification.getClass().getSimpleName();
  var className = format( "%sgenerated.%sImpl", packageName.isEmpty()
      ? ""
      : packageName + ".", specificationName );

For a specification interface named com.sample.Specification, the resulting name would be com.sample.generated.SpecificationImpl.

Returns:

The intended name of the configuration bean class.

Default:

""

samePackage

boolean samePackage

The flag that determines the package for the generated bean. If false (the default) it will be put to a package named generated below the package of the specification interface, on true it will be stored to the same package with the specification interface.

Returns:

true if the generated configuration bean should be placed in the same package as the specification interface, false if it should be placed to the generated sub-package.

Default:

false

synchronizeAccess

boolean synchronizeAccess

The flag that indicates whether the access to the configuration bean properties should be synchronised. The default is true.

Returns:

true if any access to a configuration value has to be thread-safe, false otherwise.

Default:

true