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

Class SessionKeyProperty

java.lang.Object

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

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

All Implemented Interfaces:

SpecialPropertySpec, PropertySpec

@ClassVersion(sourceVersion="$Id: SessionKeyProperty.java 943 2021-12-21 01:34:32Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class SessionKeyProperty
extends SpecialPropertySpecBase

The implementation of SpecialPropertySpecBase for SpecialPropertyType.CONFIG_PROPERTY_SESSION.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: SessionKeyProperty.java 943 2021-12-21 01:34:32Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

Nested Class Summary

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

PropertySpec.PropertyFlag

Constructor Summary

Constructors

Constructor	Description
SessionKeyProperty()	Creates a new instance of SessionKeyProperty.

Method Summary

Modifier and Type	Method	Description
final Optional<TypeName>	getCLIValueHandlerClass()	Returns the CLI value handler class for this property.
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, getFieldComposer, getGetterBuilder, getGetterComposer, getGetterMethodName, getGetterReturnType, 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

SessionKeyProperty

public SessionKeyProperty()

Creates a new instance of SessionKeyProperty.

Method Details

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

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.