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

Class PropertySpecImpl

java.lang.Object

org.tquadrat.foundation.config.ap.impl.PropertySpecImpl

All Implemented Interfaces:

PropertySpec

@ClassVersion(sourceVersion="$Id: PropertySpecImpl.java 1053 2023-03-11 00:10:49Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class PropertySpecImpl
extends Object
implements PropertySpec

The implementation for PropertySpec.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PropertySpecImpl.java 1053 2023-03-11 00:10:49Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.impl.PropertySpecImpl"

⁠

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 Name	m_AddMethodArgumentName	The name for the 'add' method's argument.
private MethodSpec.Builder	m_AddMethodBuilder	The builder for the 'add' method of this property.
private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	m_AddMethodComposer	The method that creates the 'add' method for this property.
private Name	m_AddMethodName	The name for the 'add'' method.
private int	m_CLIArgumentIndex	The argument index.
private String	m_CLIFormat	The special CLI format.
private String	m_CLIMetaVar	The CLI meta variable.
private List<String>	m_CLIOptionNames	The names for a CLI option.
private String	m_CLIUsage	The CLI usage text.
private String	m_CLIUsageKey	The CLI usage key.
private TypeName	m_CLIValueHandlerClass	The CLI value handler class.
private CollectionKind	m_CollectionKind	The kind of collection for this property.
private BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>	m_ConstructorFragmentComposer	The method that creates the constructor fragment for the initialisation of this property.
private String	m_EnvironmentDefaultValue	The default value for environment variables or system properties.
private String	m_EnvironmentVariableName	The name of the environment variable that is used to initialise this property.
private BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec>	m_FieldComposer	The method that creates the field for this property.
private String	m_FieldName	The name of the field for the property.
private MethodSpec.Builder	m_GetterBuilder	The builder for the getter of this property.
private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	m_GetterComposer	The method that creates the getter for this property.
private Name	m_GetterMethodName	The name for the getter method.
private TypeName	m_GetterReturnType	The return type for the getter method.
private String	m_INIComment	The comment for this property when stored in an INI file.
private String	m_INIGroup	The group for this property when stored in an INI file.
private String	m_INIKey	The key for this property when stored in an INI file.
private boolean	m_IsEnum	The flag that indicates whether the property type is an enum type.
private TypeName	m_PrefsAccessorClass	The Preferences accessor class.
private String	m_PrefsKey	The Preferences key.
private final EnumSet<PropertySpec.PropertyFlag>	m_PropertyFlags	The property flags.
private final String	m_PropertyName	The name of the property.
private TypeName	m_PropertyType	The type of the property.
private Name	m_SetterArgumentName	The name for the setter's argument.
private MethodSpec.Builder	m_SetterBuilder	The builder for the setter of this property.
private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	m_SetterComposer	The method that creates the setter for this property.
private Name	m_SetterMethodName	The name for the setter method.
private SpecialPropertyType	m_SpecialPropertyType	The speciality type for this property; usually, this is null.
private TypeName	m_StringConverterClass	The class that implements the String converter for the type of this property.
private String	m_SystemPrefsPath	The path for the SYSTEM preferences node that holds the initialisation data for this property.
private String	m_SystemPropertyName	The name of the system property that is used to initialise this property.

Constructor Summary

Constructors

Constructor	Description
PropertySpecImpl(String propertyName)	Creates a new PropertySpecImpl instance.

Method Summary

Modifier and Type	Method	Description
final Optional<MethodSpec>	createAddMethod(CodeBuilder codeBuilder)	Creates the specification of the 'add' method for this property.
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.
Optional<MethodSpec>	createGetter(CodeBuilder codeBuilder)	Creates the specification of the getter for this property.
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.
final Optional<MethodSpec.Builder>	getAddMethodBuilder()	Returns a builder for the 'add' method for this property.
final Optional<Name>	getAddMethodName()	Returns the name of the 'add' method for this property.
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.
final Optional<TypeName>	getCLIValueHandlerClass()	Returns the CLI value handler class for this property.
final CollectionKind	getCollectionKind()	Returns the kind of collection for this property.
final 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.
final String	getFieldName()	Returns the name of the field for the property.
final Optional<MethodSpec.Builder>	getGetterBuilder()	Returns a builder for the getter for this property.
final Optional<Name>	getGetterMethodName()	Returns the name of the getter method name.
final TypeName	getGetterReturnType()	Returns the return type of the getter.
Optional<String>	getINIComment()	Returns the comment for this property in the INI file.
Optional<String>	getINIGroup()	Returns the group for this property in the INI file.
Optional<String>	getINIKey()	Returns the key for this property in the INI file.
final Optional<TypeName>	getPrefsAccessorClass()	Returns the Preferences accessor class.
final Optional<String>	getPrefsKey()	Returns the Preferences key for this property.
final String	getPropertyName()	Returns the name of the configuration property.
final TypeName	getPropertyType()	Returns the property type.
final Name	getSetterArgumentName()	Returns the name of the setter's argument.
final Optional<MethodSpec.Builder>	getSetterBuilder()	Returns a builder for the setter for this 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<TypeName>	getStringConverterClass()	Returns the class that implements the String converter for the type of this property.
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.
final 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.
final void	setAddMethodArgumentName(Name name)	Sets the name for the 'add' method's argument.
final void	setAddMethodBuilder(MethodSpec.Builder builder)	Sets the builder for the 'add' method of this property.
final void	setAddMethodName(Name name)	Sets the name of the 'add'' method for this property.
final void	setCLIArgumentIndex(int index)	Sets the index for an argument on the command line.
final void	setCLIFormat(String format)	Sets the special CLI format.
final void	setCLIMetaVar(String metaVar)	Sets the CLI meta variable.
final void	setCLIOptionNames(List<String> names)	Sets the CLI option names.
final void	setCLIUsage(String text)	Sets the CLI usage text.
final void	setCLIUsageKey(String key)	Sets the CLI usage key.
final void	setCLIValueHandlerClass(TypeName handlerClass)	Sets the CLI value handler class.
final void	setCollectionKind(CollectionKind collectionKind)	Sets the kind of collection for this property.
final void	setEnvironmentDefaultValue(String value)	Sets the default value for an environment variable or a system property.
final void	setEnvironmentVariableName(String name)	Sets the name of the environment variable that provides the (initial) value for this property.
final void	setFieldName(String name)	Sets the name of the field for the property.
final void	setFlag(PropertySpec.PropertyFlag... flag)	Sets the given flags to the property.
final void	setGetterBuilder(MethodSpec.Builder builder)	Sets the builder for the getter of this property.
final void	setGetterMethodName(Name name)	Sets the method name for the getter.
final void	setGetterReturnType(TypeName type)	Sets the return type for the getter.
final void	setINIConfiguration(String group, String key, String comment)	Sets the INI file configuration for this property.
void	setINIConfiguration(INIValue configuration)	Sets the INI file configuration for this property.
final void	setIsEnum(boolean flag)	Sets the flag that indicates whether the property is an enum type.
final void	setPrefsAccessorClass(TypeName accessorClass)	Sets the preferences accessor class for this property.
final void	setPrefsKey(String preferenceKey)	Sets the preferences key for this property.
final void	setPropertyType(TypeName type)	Sets the property type.
final void	setSetterArgumentName(Name name)	Sets the name for the setter's argument.
final void	setSetterBuilder(MethodSpec.Builder builder)	Sets the builder for the setter of this property.
void	setSetterMethodName(Name name)	Sets the name of the setter method for this property.
final void	setSpecialPropertyType(SpecialPropertyType type)	Sets the speciality type for this property.
final void	setStringConverterClass(TypeName typeName)	Sets the name for the class that implements StringConverter for the type of this property.
final void	setSystemPrefsPath(String path)	Sets the path for the SYSTEM Preferences node that holds the initialisation data for this property.
final void	setSystemPropertyName(String name)	Sets the name of the system property that provides the (initial) value for this property.

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

getElementType, isCollection, isOnCLI

Field Details

m_AddMethodArgumentName

private Name m_AddMethodArgumentName

The name for the 'add' method's argument.

m_AddMethodBuilder

private MethodSpec.Builder m_AddMethodBuilder

The builder for the 'add' method of this property.

m_AddMethodComposer

private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> m_AddMethodComposer

The method that creates the 'add' method for this property.

m_AddMethodName

private Name m_AddMethodName

The name for the 'add'' method.

m_CLIArgumentIndex

private int m_CLIArgumentIndex

The argument index.

See Also:

• Argument.index()

m_CLIFormat

private String m_CLIFormat

The special CLI format.

See Also:

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

m_CLIMetaVar

private String m_CLIMetaVar

The CLI meta variable.

See Also:

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

m_CLIOptionNames

private List<String> m_CLIOptionNames

The names for a CLI option.

See Also:

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

m_CLIValueHandlerClass

private TypeName m_CLIValueHandlerClass

The CLI value handler class.

See Also:

• Argument.handler()
• Option.handler()

m_CLIUsage

private String m_CLIUsage

The CLI usage text.

See Also:

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

m_CLIUsageKey

private String m_CLIUsageKey

The CLI usage key.

See Also:

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

m_CollectionKind

private CollectionKind m_CollectionKind

The kind of collection for this property.

m_ConstructorFragmentComposer

private BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock> m_ConstructorFragmentComposer

The method that creates the constructor fragment for the initialisation of this property.

m_EnvironmentDefaultValue

private String m_EnvironmentDefaultValue

The default value for environment variables or system properties.

m_EnvironmentVariableName

private String m_EnvironmentVariableName

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

m_FieldComposer

private BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec> m_FieldComposer

The method that creates the field for this property.

m_FieldName

private String m_FieldName

The name of the field for the property.

m_GetterBuilder

private MethodSpec.Builder m_GetterBuilder

The builder for the getter of this property.

m_GetterComposer

private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> m_GetterComposer

The method that creates the getter for this property.

m_GetterMethodName

private Name m_GetterMethodName

The name for the getter method.

m_GetterReturnType

private TypeName m_GetterReturnType

The return type for the getter method.

m_INIComment

private String m_INIComment

The comment for this property when stored in an INI file.

m_INIGroup

private String m_INIGroup

The group for this property when stored in an INI file.

m_INIKey

private String m_INIKey

The key for this property when stored in an INI file.

m_IsEnum

private boolean m_IsEnum

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

m_PrefsAccessorClass

private TypeName m_PrefsAccessorClass

The Preferences accessor class.

This is used when this property is linked to a preference, but also to initialise it from a SYSTEM preference.

See Also:

• Preference.accessor()
• SystemPreference.accessor()

m_PrefsKey

private String m_PrefsKey

The Preferences key.

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.

See Also:

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

m_PropertyFlags

private final EnumSet<PropertySpec.PropertyFlag> m_PropertyFlags

The property flags.

m_PropertyName

private final String m_PropertyName

The name of the property.

m_PropertyType

private TypeName m_PropertyType

The type of the property.

m_SetterArgumentName

private Name m_SetterArgumentName

The name for the setter's argument.

m_SetterBuilder

private MethodSpec.Builder m_SetterBuilder

The builder for the setter of this property.

m_SetterComposer

private BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> m_SetterComposer

The method that creates the setter for this property.

m_SetterMethodName

private Name m_SetterMethodName

The name for the setter method.

m_SpecialPropertyType

private SpecialPropertyType m_SpecialPropertyType

The speciality type for this property; usually, this is null.

m_StringConverterClass

private TypeName m_StringConverterClass

The class that implements the String converter for the type of this property.

m_SystemPrefsPath

private String m_SystemPrefsPath

The path for the SYSTEM preferences node that holds the initialisation data for this property.

See Also:

• SystemPreference.path()

m_SystemPropertyName

private String m_SystemPropertyName

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

Constructor Details

PropertySpecImpl

public PropertySpecImpl(String propertyName)

Creates a new PropertySpecImpl instance.

Parameters:

propertyName - The name of the 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 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 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 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().

getAddMethodBuilder

public final Optional<MethodSpec.Builder> getAddMethodBuilder()

Returns a builder for the 'add' method for this property.

This is a convenience method that allows to benefit from JavaComposer.createMethod(ExecutableElement).

Returns:

An instance of Optional that holds the builder.

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.

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()

getCLIValueHandlerClass

public final Optional<TypeName> getCLIValueHandlerClass()

Returns the CLI value handler class for this property.

Specified by:

getCLIValueHandlerClass in interface PropertySpec

Returns:

An instance of Optional that holds the TypeName for the handler class.

See Also:

• Argument.handler()
• Option.handler()

getCollectionKind

public final CollectionKind getCollectionKind()

Returns the kind of collection for this property.

Specified by:

getCollectionKind in interface PropertySpec

Returns:

The collection kind.

getEnvironmentDefaultValue

public final 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.

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

getFieldName

public final String getFieldName()

Returns the name of the field for the property.

Specified by:

getFieldName in interface PropertySpec

Returns:

The field name.

getGetterBuilder

public final 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.

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

public final 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 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 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 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.

getPrefsAccessorClass

public final Optional<TypeName> getPrefsAccessorClass()

Returns the Preferences accessor class.

This is used when this property is linked to a preference, but also to initialise it from a SYSTEM preference.

Specified by:

getPrefsAccessorClass in interface PropertySpec

Returns:

An instance of Optional that holds the TypeName for the accessor class.

See Also:

• PreferencesBeanSpec
• Preference.accessor()
• SystemPreference.accessor()

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.

getPropertyType

public final TypeName getPropertyType()

Returns the property type.

Specified by:

getPropertyType in interface PropertySpec

Returns:

The property type.

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

public final 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.

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.

getStringConverterClass

public final Optional<TypeName> getStringConverterClass()

Returns the class that implements the String converter for the type of this property.

Specified by:

getStringConverterClass in interface PropertySpec

Returns:

An instance of Optional that holds the implementation class for StringConverter.

getSystemPrefsPath

public 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

isEnum

public final 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.

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.

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.

setAddMethodArgumentName

public final void setAddMethodArgumentName(Name name)

Sets the name for the 'add' method's argument.

Parameters:

name - The name of the argument.

setAddMethodBuilder

public final void setAddMethodBuilder(MethodSpec.Builder builder)

Sets the builder for the 'add' method of this property.

Parameters:

builder - The builder; can be null.

setAddMethodName

public final void setAddMethodName(Name name)

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

Parameters:

name - The name of the setter method.

setCLIArgumentIndex

public final void setCLIArgumentIndex(int index)

Sets the index for an argument on the command line.

Parameters:

index - The index, starting by 0. A negative value indicates, that the value was not set.

See Also:

• Argument.index()

setCLIFormat

public final void setCLIFormat(String format)

Sets the special CLI format.

Parameters:

format - The format String; can be null.

See Also:

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

setCLIMetaVar

public final void setCLIMetaVar(String metaVar)

Sets the CLI meta variable.

Parameters:

metaVar - The meta variable; can be null.

See Also:

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

setCLIOptionNames

public final void setCLIOptionNames(List<String> names)

Sets the CLI option names.

The first entry of the list is the option name, the others are the aliases.

Parameters:

names - The name and the aliases for the CLI option for this property; can be null, but may not be empty.

See Also:

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

setCLIUsage

public final void setCLIUsage(String text)

Sets the CLI usage text.

Parameters:

text - The usage text; can be null.

See Also:

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

setCLIUsageKey

public final void setCLIUsageKey(String key)

Sets the CLI usage key.

Parameters:

key - The usage key; can be null.

See Also:

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

setCLIValueHandlerClass

public final void setCLIValueHandlerClass(TypeName handlerClass)

Sets the CLI value handler class.

Parameters:

handlerClass - The TypeName for the value handler class; can be null.

See Also:

• Argument.handler()
• Option.handler()
• CmdLineValueHandler

setCollectionKind

public final void setCollectionKind(CollectionKind collectionKind)

Sets the kind of collection for this property.

Parameters:

collectionKind - The kind of collection.

setEnvironmentDefaultValue

public final void setEnvironmentDefaultValue(String value)

Sets 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.

A String with the only the NUL character is treated as null.

Parameters:

value - The default value.

setEnvironmentVariableName

public final void setEnvironmentVariableName(String name)

Sets the name of the environment variable that provides the (initial) value for this property.

Parameters:

name - The name of the environment variable.

setFieldName

public final void setFieldName(String name)

Sets the name of the field for the property.

Parameters:

name - The field name.

setFlag

public final void setFlag(PropertySpec.PropertyFlag... flag)

Sets the given flags to the property.

Parameters:

flag - The flags to set.

setGetterBuilder

public final void setGetterBuilder(MethodSpec.Builder builder)

Sets the builder for the getter of this property.

Parameters:

builder - The builder; can be null.

setGetterMethodName

public final void setGetterMethodName(Name name)

Sets the method name for the getter.

Parameters:

name - The method name.

setGetterReturnType

public final void setGetterReturnType(TypeName type)

Sets the return type for the getter.

Parameters:

type - The getter's return type.

setINIConfiguration

public final void setINIConfiguration(String group,
 String key,
 String comment)

Sets the INI file configuration for this property.

Parameters:

group - The group.

key - The key.

comment - The comment; can be null.

setINIConfiguration

public void setINIConfiguration(INIValue configuration)

Sets the INI file configuration for this property.

Parameters:

configuration - The configuration annotation.

setIsEnum

public final void setIsEnum(boolean flag)

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

Parameters:

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

setPrefsAccessorClass

public final void setPrefsAccessorClass(TypeName accessorClass)

Sets the preferences accessor class for this property.

Parameters:

accessorClass - The accessor class; can be null.

setPrefsKey

public final void setPrefsKey(String preferenceKey)

Sets the preferences key for this property.

Parameters:

preferenceKey - The key.

setPropertyType

public final void setPropertyType(TypeName type)

Sets the property type.

Parameters:

type - The type of the property.

setSetterArgumentName

public final void setSetterArgumentName(Name name)

Sets the name for the setter's argument.

Parameters:

name - The name of the argument.

setSetterBuilder

public final void setSetterBuilder(MethodSpec.Builder builder)

Sets the builder for the setter of this property.

Parameters:

builder - The builder; can be null.

setSetterMethodName

public void setSetterMethodName(Name name)

Sets the name of the setter method for this property.

Parameters:

name - The name of the setter method.

setSpecialPropertyType

public final void setSpecialPropertyType(SpecialPropertyType type)

Sets the speciality type for this property.

Parameters:

type - The speciality type.

setStringConverterClass

public final void setStringConverterClass(TypeName typeName)

Sets the name for the class that implements StringConverter for the type of this property.

Parameters:

typeName - The String converter class; can be null.

setSystemPrefsPath

public final void setSystemPrefsPath(String path)

Sets the path for the SYSTEM Preferences node that holds the initialisation data for this property.

Parameters:

path - The path.

setSystemPropertyName

public final void setSystemPropertyName(String name)

Sets the name of the system property that provides the (initial) value for this property.

Parameters:

name - The name of the system property.