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

Class MessagePrefixProperty

java.lang.Object

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

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

All Implemented Interfaces:

SpecialPropertySpec, PropertySpec

@ClassVersion(sourceVersion="$Id: MessagePrefixProperty.java 1001 2022-01-29 16:42:15Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class MessagePrefixProperty
extends SpecialPropertySpecBase

The implementation of SpecialPropertySpecBase for SpecialPropertyType.CONFIG_PROPERTY_MESSAGEPREFIX.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: MessagePrefixProperty.java 1001 2022-01-29 16:42:15Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

Nested Class Summary

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

PropertySpec.PropertyFlag

Constructor Summary

Constructors

Constructor	Description
MessagePrefixProperty()	Creates a new instance of ProcessIdProperty.

Method Summary

Modifier and Type	Method	Description
private static final MethodSpec	composeGetter(CodeBuilder codeBuilder, PropertySpecImpl property)	The implementation of the method that composes a getter for the given property.
final Optional<TypeName>	getCLIValueHandlerClass()	Returns the CLI value handler class for this property.
final Optional<BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec>>	getFieldComposer()	Returns the method that composes the field for the property.
Optional<BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>>	getGetterComposer()	Returns the method that composes the getter for the property.
final TypeName	getGetterReturnType()	Returns the return type of the getter.
final Optional<TypeName>	getPrefsAccessorClass()	Returns the Preferences accessor class.
final TypeName	getPropertyType()	Returns the property type.
final Optional<TypeName>	getStringConverterClass()	Returns the class that implements the String converter for the type of this property.

Methods inherited from class org.tquadrat.foundation.config.ap.impl.specialprops.SpecialPropertySpecBase

createAddMethod, createConstructorFragment, createField, createGetter, createSetter, getAddMethodArgumentName, getAddMethodComposer, getAddMethodName, getAllFlags, getCLIArgumentIndex, getCLIFormat, getCLIMetaVar, getCLIOptionNames, getCLIUsage, getCLIUsageKey, getCollectionKind, getConstructorFragmentComposer, getEnvironmentDefaultValue, getEnvironmentVariableName, getGetterBuilder, getGetterMethodName, getINIComment, getINIGroup, getINIKey, getPrefsKey, getPropertyName, getSetterArgumentName, getSetterBuilder, getSetterComposer, getSetterMethodName, getSpecialPropertyType, getSystemPrefsPath, getSystemPropertyName, hasFlag, isEnum, merge

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, getFieldName, isCollection, isOnCLI

Constructor Details

MessagePrefixProperty

public MessagePrefixProperty()

Creates a new instance of ProcessIdProperty.

Method Details

composeGetter

private static final MethodSpec composeGetter(CodeBuilder codeBuilder,
 PropertySpecImpl property)

The implementation of the method that composes a getter for the given property.

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The method specification.

getCLIValueHandlerClass

public final Optional<TypeName> getCLIValueHandlerClass()

Returns the CLI value handler class for this property.

Returns:

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

See Also:

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

getFieldComposer

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

Returns the method that composes the field for the property.

Specified by:

getFieldComposer in interface SpecialPropertySpec

Overrides:

getFieldComposer in class SpecialPropertySpecBase

Returns:

An instance of Optional that holds the field composer.

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

Overrides:

getGetterComposer in class SpecialPropertySpecBase

Returns:

An instance of Optional that holds the getter composer.

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

Overrides:

getGetterReturnType in class SpecialPropertySpecBase

Returns:

The getter's return type.

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.

Returns:

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

See Also:

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

getPropertyType

public final TypeName getPropertyType()

Returns the property type.

Returns:

The property type.

getStringConverterClass

public final Optional<TypeName> getStringConverterClass()

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

Returns:

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