Package org.tquadrat.foundation.config.ap.impl.specialprops

Class SpecialPropertySpecBase

java.lang.Object

org.tquadrat.foundation.config.ap.impl.specialprops.SpecialPropertySpecBase

All Implemented Interfaces:

SpecialPropertySpec, PropertySpec

Direct Known Subclasses:

CharsetProperty, ClockProperty, LocaleProperty, MessagePrefixProperty, ProcessIdProperty, RandomProperty, ResourceBundleProperty, SessionKeyProperty, TimeZoneProperty

@ClassVersion(sourceVersion="$Id: SpecialPropertySpecBase.java 1010 2022-02-05 19:28:36Z tquadrat $")
@API(status=MAINTAINED,
     since="0.1.0")
abstract sealed class SpecialPropertySpecBase
extends Object
implements SpecialPropertySpec
permits CharsetProperty, ClockProperty, LocaleProperty, MessagePrefixProperty, ProcessIdProperty, RandomProperty, ResourceBundleProperty, SessionKeyProperty, TimeZoneProperty

The base class for the special property specifications.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.impl.specialprops.SpecialPropertySpecBase"

⁠

Nested Class Summary

Nested classes/interfaces inherited from interface org.tquadrat.foundation.config.ap.PropertySpec

PropertySpec.PropertyFlag

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<PropertySpec.PropertyFlag>	m_PropertyFlags	The property flags.
private final SpecialPropertyType	m_Type	The type of the special property.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpecialPropertySpecBase(SpecialPropertyType type, PropertySpec.PropertyFlag... flags)	Creates a new instance of SpecialPropertySpecBase.

Method Summary

Modifier and Type	Method	Description
final Optional<MethodSpec>	createAddMethod(CodeBuilder codeBuilder)	Creates the specification of the 'add' method for this property.
final Optional<CodeBlock>	createConstructorFragment(CodeBuilder codeBuilder)	Creates a code block that is a fragment for the constructor of the new configuration bean and that initialises this property.
final Optional<FieldSpec>	createField(CodeBuilder codeBuilder)	Creates the field specification for this property.
final Optional<MethodSpec>	createGetter(CodeBuilder codeBuilder)	Creates the specification of the getter for this property.
final Optional<MethodSpec>	createSetter(CodeBuilder codeBuilder)	Creates the specification of the setter for this property.
final Name	getAddMethodArgumentName()	Returns the name of the 'add' method's argument.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>>	getAddMethodComposer()	Returns the method that composes the 'add' method for the property.
final Optional<Name>	getAddMethodName()	Returns the name of the 'add' method for this property.
final EnumSet<PropertySpec.PropertyFlag>	getAllFlags()	Returns all the flags that were set for this special property specification.
final OptionalInt	getCLIArgumentIndex()	Returns the index for an argument on the command line.
final Optional<String>	getCLIFormat()	Returns the special CLI format.
final Optional<String>	getCLIMetaVar()	Returns the name of the CLI meta variable for this property.
final Optional<List<String>>	getCLIOptionNames()	Returns the CLI option names.
final Optional<String>	getCLIUsage()	Returns the CLI usage text for this property.
final Optional<String>	getCLIUsageKey()	Returns the CLI usage key for this property.
CollectionKind	getCollectionKind()	Returns the kind of collection for this property.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>>	getConstructorFragmentComposer()	Returns the method that composes the constructor fragment for the initialisation of the property.
Optional<String>	getEnvironmentDefaultValue()	Returns the default value for an environment variable or a system property.
final Optional<String>	getEnvironmentVariableName()	Returns the name of the environment variable that is used to initialise this property.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec>>	getFieldComposer()	Returns the method that composes the field for the property.
Optional<MethodSpec.Builder>	getGetterBuilder()	Returns a builder for the getter for this property.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>>	getGetterComposer()	Returns the method that composes the getter for the property.
final Optional<Name>	getGetterMethodName()	Returns the name of the getter method name.
TypeName	getGetterReturnType()	Returns the return type of the getter.
final Optional<String>	getINIComment()	Returns the comment for this property in the INI file.
final Optional<String>	getINIGroup()	Returns the group for this property in the INI file.
final Optional<String>	getINIKey()	Returns the key for this property in the INI file.
final Optional<String>	getPrefsKey()	Returns the Preferences key for this property.
final String	getPropertyName()	Returns the name of the configuration property.
final Name	getSetterArgumentName()	Returns the name of the setter's argument.
Optional<MethodSpec.Builder>	getSetterBuilder()	Returns a builder for the setter for this property.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>>	getSetterComposer()	Returns the method that composes the setter for the property.
final Optional<Name>	getSetterMethodName()	Returns the name of the setter method name.
final Optional<SpecialPropertyType>	getSpecialPropertyType()	Return the 'speciality' type for this property.
final Optional<String>	getSystemPrefsPath()	Returns the path to the SYSTEM Preferences node that holds the data for the initialisation of this property.
final Optional<String>	getSystemPropertyName()	Returns the name of the system property that is used to initialise this property.
final boolean	hasFlag(PropertySpec.PropertyFlag flag)	Checks whether the given flag is set for this property.
boolean	isEnum()	Returns the flag that indicates whether the property is an enum type.
final PropertySpec	merge()	'Merges' the attributes from a special property with the attributes retrieved from the configuration bean specification and returns a new instance of PropertySpec.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.config.ap.PropertySpec

getCLIValueHandlerClass, getElementType, getFieldName, getPrefsAccessorClass, getPropertyType, getStringConverterClass, isCollection, isOnCLI

Field Details

m_PropertyFlags

private final Set<PropertySpec.PropertyFlag> m_PropertyFlags

The property flags.

m_Type

private final SpecialPropertyType m_Type

The type of the special property.

Constructor Details

SpecialPropertySpecBase

protected SpecialPropertySpecBase(SpecialPropertyType type,
 PropertySpec.PropertyFlag... flags)

Creates a new instance of SpecialPropertySpecBase.

Parameters:

type - The type of the special property.

flags - The flags for this special property.

Method Details

createAddMethod

public final Optional<MethodSpec> createAddMethod(CodeBuilder codeBuilder)

Creates the specification of the 'add' method for this property.

Specified by:

createAddMethod in interface PropertySpec

Parameters:

codeBuilder - The factory for the code generation.

Returns:

An instance of Optional that holds the method specification.

createConstructorFragment

public final Optional<CodeBlock> createConstructorFragment(CodeBuilder codeBuilder)

Creates a code block that is a fragment for the constructor of the new configuration bean and that initialises this property.

Specified by:

createConstructorFragment in interface PropertySpec

Parameters:

codeBuilder - The factory for the code generation.

Returns:

An instance of Optional that holds the code block.

createField

public final Optional<FieldSpec> createField(CodeBuilder codeBuilder)

Creates the field specification for this property.

Specified by:

createField in interface PropertySpec

Parameters:

codeBuilder - The factory for the code generation.

Returns:

An instance of Optional that holds the field specification.

createGetter

public final Optional<MethodSpec> createGetter(CodeBuilder codeBuilder)

Creates the specification of the getter for this property.

Specified by:

createGetter in interface PropertySpec

Parameters:

codeBuilder - The factory for the code generation.

Returns:

An instance of Optional that holds the method specification.

createSetter

public final Optional<MethodSpec> createSetter(CodeBuilder codeBuilder)

Creates the specification of the setter for this property.

Specified by:

createSetter in interface PropertySpec

Parameters:

codeBuilder - The factory for the code generation.

Returns:

An instance of Optional that holds the method specification.

getAddMethodArgumentName

public final Name getAddMethodArgumentName()

Returns the name of the 'add' method's argument.

Specified by:

getAddMethodArgumentName in interface PropertySpec

Returns:

The argument name; is probable null when PropertySpec.getAddMethodName() returns Optional.empty().

getAddMethodComposer

@MountPoint
public Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>> getAddMethodComposer()

Returns the method that composes the 'add' method for the property.

Specified by:

getAddMethodComposer in interface SpecialPropertySpec

Returns:

An instance of Optional that holds the 'add' method composer.

getAddMethodName

public final Optional<Name> getAddMethodName()

Returns the name of the 'add' method for this property.

Specified by:

getAddMethodName in interface PropertySpec

Returns:

An instance of Optional that holds the name of the add method.

getAllFlags

public final EnumSet<PropertySpec.PropertyFlag> getAllFlags()

Returns all the flags that were set for this special property specification.

Specified by:

getAllFlags in interface SpecialPropertySpec

Returns:

The flags.

getCLIArgumentIndex

public final OptionalInt getCLIArgumentIndex()

Returns the index for an argument on the command line.

The return value will be empty if the property is not a CLI argument.

Specified by:

getCLIArgumentIndex in interface PropertySpec

Returns:

An instance of OptionalInt that holds the index.

See Also:

• Argument.index()

getCLIFormat

public final Optional<String> getCLIFormat()

Returns the special CLI format.

Specified by:

getCLIFormat in interface PropertySpec

Returns:

An instance of Optional that holds the format.

See Also:

• Argument.format()
• Option.format()

getCLIMetaVar

public final Optional<String> getCLIMetaVar()

Returns the name of the CLI meta variable for this property.

Specified by:

getCLIMetaVar in interface PropertySpec

Returns:

An instance of Optional that holds the name of the meta variable.

See Also:

• Argument.metaVar()
• Option.metaVar()

getCLIOptionNames

public final Optional<List<String>> getCLIOptionNames()

Returns the CLI option names. The mandatory first name in the list is the primary name, the optional others are the aliases.

The return value will be empty if the property is not a CLI option.

Specified by:

getCLIOptionNames in interface PropertySpec

Returns:

An instance of Optional that holds the option names.

See Also:

• Option.name()
• Option.aliases()

getCLIUsage

public final Optional<String> getCLIUsage()

Returns the CLI usage text for this property. This text will not be localised.

Specified by:

getCLIUsage in interface PropertySpec

Returns:

An instance of Optional that holds the usage text.

See Also:

• Argument.usage()
• Option.usage()

getCLIUsageKey

public final Optional<String> getCLIUsageKey()

Returns the CLI usage key for this property. This key is used to retrieve a localised usage text.

Specified by:

getCLIUsageKey in interface PropertySpec

Returns:

An instance of Optional that holds the usage key.

See Also:

• Argument.usageKey()
• Option.usageKey()

getCollectionKind

@MountPoint
public CollectionKind getCollectionKind()

Returns the kind of collection for this property.

Specified by:

getCollectionKind in interface PropertySpec

Returns:

The collection kind.

getEnvironmentDefaultValue

@MountPoint
public Optional<String> getEnvironmentDefaultValue()

Returns the default value for an environment variable or a system property. This is used to initialise this property when it has the annotation @EnvironmentVariable or @EnvironmentVariable, but no value is provided.

A default value is mandatory when the annotated property has a primitive type.

Specified by:

getEnvironmentDefaultValue in interface PropertySpec

Returns:

An instance of Optional that holds the default value.

getConstructorFragmentComposer

@MountPoint
public Optional<BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>> getConstructorFragmentComposer()

Returns the method that composes the constructor fragment for the initialisation of the property.

Specified by:

getConstructorFragmentComposer in interface SpecialPropertySpec

Returns:

An instance of Optional that holds the composer for the constructor fragment.

getEnvironmentVariableName

public final Optional<String> getEnvironmentVariableName()

Returns the name of the environment variable that is used to initialise this property.

Specified by:

getEnvironmentVariableName in interface PropertySpec

Returns:

An instance of Optional that holds the environment variable name.

See Also:

• EnvironmentVariable

getFieldComposer

@MountPoint
public Optional<BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec>> getFieldComposer()

Returns the method that composes the field for the property.

Specified by:

getFieldComposer in interface SpecialPropertySpec

Returns:

An instance of Optional that holds the field composer.

getGetterBuilder

@MountPoint
public Optional<MethodSpec.Builder> getGetterBuilder()

Returns a builder for the getter for this property.

Specified by:

getGetterBuilder in interface PropertySpec

Returns:

An instance of Optional that holds the builder.

getGetterComposer

@MountPoint
public Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>> getGetterComposer()

Returns the method that composes the getter for the property.

Specified by:

getGetterComposer in interface SpecialPropertySpec

Returns:

An instance of Optional that holds the getter composer.

getGetterMethodName

public final Optional<Name> getGetterMethodName()

Returns the name of the getter method name. If there is no name for the method, it will not be generated.

Specified by:

getGetterMethodName in interface PropertySpec

Returns:

An instance of Optional that holds the name of the getter method.

getGetterReturnType

@MountPoint
public TypeName getGetterReturnType()

Returns the return type of the getter. This is not necessarily the same as the property type.

Specified by:

getGetterReturnType in interface PropertySpec

Returns:

The getter's return type.

getINIComment

public final Optional<String> getINIComment()

Returns the comment for this property in the INI file.

Specified by:

getINIComment in interface PropertySpec

Returns:

An instance of Optional that holds the comment.

getINIGroup

public final Optional<String> getINIGroup()

Returns the group for this property in the INI file.

Specified by:

getINIGroup in interface PropertySpec

Returns:

An instance of Optional that holds the group name.

getINIKey

public final Optional<String> getINIKey()

Returns the key for this property in the INI file.

Specified by:

getINIKey in interface PropertySpec

Returns:

An instance of Optional that holds the key.

getPrefsKey

public final Optional<String> getPrefsKey()

Returns the Preferences key for this property.

This is used when this property is linked to a preference, but also to initialise it from a SYSTEM preference. In first case, the name is defaulted to the property name, while it is mandatory otherwise.

Specified by:

getPrefsKey in interface PropertySpec

Returns:

An instance of Optional that holds the preferences key for this property.

See Also:

• PreferencesBeanSpec
• Preference.key()
• SystemPreference.key()

getPropertyName

public final String getPropertyName()

Returns the name of the configuration property.

Specified by:

getPropertyName in interface PropertySpec

Returns:

The name.

getSetterArgumentName

public final Name getSetterArgumentName()

Returns the name of the setter's argument.

Specified by:

getSetterArgumentName in interface PropertySpec

Returns:

The argument name; is probably null when PropertySpec.getSetterMethodName() returns Optional.empty().

getSetterBuilder

@MountPoint
public Optional<MethodSpec.Builder> getSetterBuilder()

Returns a builder for the setter for this property.

Specified by:

getSetterBuilder in interface PropertySpec

Returns:

An instance of Optional that holds the builder.

getSetterComposer

@MountPoint
public Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>> getSetterComposer()

Returns the method that composes the setter for the property.

Specified by:

getSetterComposer in interface SpecialPropertySpec

Returns:

An instance of Optional that holds the setter composer.

getSetterMethodName

public final Optional<Name> getSetterMethodName()

Returns the name of the setter method name. If there is no name for the method, it will not be generated.

Specified by:

getSetterMethodName in interface PropertySpec

Returns:

An instance of Optional that holds the name of the setter method.

getSpecialPropertyType

public final Optional<SpecialPropertyType> getSpecialPropertyType()

Return the 'speciality' type for this property.

Specified by:

getSpecialPropertyType in interface PropertySpec

Returns:

An instance of Optional that holds the speciality type.

getSystemPrefsPath

public final Optional<String> getSystemPrefsPath()

Returns the path to the SYSTEM Preferences node that holds the data for the initialisation of this property.

Specified by:

getSystemPrefsPath in interface PropertySpec

Returns:

An instance of Optional that holds the path.

See Also:

• SystemPreference.path()

getSystemPropertyName

public final Optional<String> getSystemPropertyName()

Returns the name of the system property that is used to initialise this property.

Specified by:

getSystemPropertyName in interface PropertySpec

Returns:

An instance of Optional that holds the system property name.

See Also:

• SystemProperty

hasFlag

public final boolean hasFlag(PropertySpec.PropertyFlag flag)

Checks whether the given flag is set for this property.

Specified by:

hasFlag in interface PropertySpec

Parameters:

flag - The flag to test for.

Returns:

true if the flag is set, false otherwise.

isEnum

@MountPoint
public boolean isEnum()

Returns the flag that indicates whether the property is an enum type.

Specified by:

isEnum in interface PropertySpec

Returns:

true if the property type is an enum, false otherwise.

merge

public final PropertySpec merge()

'Merges' the attributes from a special property with the attributes retrieved from the configuration bean specification and returns a new instance of PropertySpec. The original instance remains unchanged.

If the property is not a special property (the flag PropertySpec.PropertyFlag.PROPERTY_IS_SPECIAL is not set), this instance will be returned.

Specified by:

merge in interface PropertySpec

Returns:

The effective property specification.