Parameter for a Plugin. More...

Inheritance diagram for net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >:

Collaboration diagram for net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >:

Public Member Functions
void	addPluginParameterListener (@NotNull PluginParameterListener listener)
	Adds a listener to be notified. More...

String	getDescription ()
	The user-provided description of the value for the user interface. More...

String	getName ()
	The name of the parameter. More...

String	getParameterType ()
	Returns the parameter type name. More...

String	getStringValue ()
	Returns the string representation of the current value of the parameter. More...

V	getValue () throws InvalidValueException
	Returns the current value of this parameter. More...

V	getValueOrNull ()
	Returns the current value of this parameter. More...

void	removePluginParameterListener (@NotNull PluginParameterListener listener)
	Removes a listener to be notified. More...

void	setDescription (@NotNull String description)
	Sets the user-provided description of the value for the user interface. More...

void	setName (@NotNull String name)
	Sets the name of the parameter. More...

boolean	setStringValue (@NotNull String stringValue)
	Sets the parameter value from string representation. More...

< T > T	visit (@NotNull PluginParameterVisitor< G, A, R, T > visitor)
	Calls the. More...

Detailed Description

Parameter for a Plugin.

Author: tchize; Andreas Kirschbaum

Definition at line 33 of file PluginParameter.java.

Member Function Documentation

◆ addPluginParameterListener()

void net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.addPluginParameterListener ( @NotNull PluginParameterListener listener )

Adds a listener to be notified.

Parameters

listener the listener

Referenced by net.sf.gridarta.plugin.Plugin< G, A, R >.convertType(), and net.sf.gridarta.plugin.Plugin< G, A, R >.newParameter().

Here is the caller graph for this function:

◆ getDescription()

String net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getDescription ( )

The user-provided description of the value for the user interface.

Returns: the description

Here is the caller graph for this function:

◆ getName()

String net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getName ( )

The name of the parameter.

It identifies the parameter in the user interface and from the plugin script code.

Returns: the name

Here is the caller graph for this function:

◆ getParameterType()

String net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getParameterType ( )

Returns the parameter type name.

Returns: the parameter type name

Here is the caller graph for this function:

◆ getStringValue()

String net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getStringValue ( )

Returns the string representation of the current value of the parameter.

Returns: the string representation of the value

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testArchetypeFromXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testArchetypeFromXml2(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testArchetypeFromXml3().

Here is the caller graph for this function:

◆ getValue()

V net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getValue ( ) throws InvalidValueException

Returns the current value of this parameter.

Returns: the value

Exceptions

InvalidValueException if the the value is invalid

◆ getValueOrNull()

V net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getValueOrNull ( )

Returns the current value of this parameter.

Returns: the value or
null
if the the value is invalid

Here is the caller graph for this function:

◆ removePluginParameterListener()

void net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.removePluginParameterListener ( @NotNull PluginParameterListener listener )

Removes a listener to be notified.

Parameters

listener the listener

Referenced by net.sf.gridarta.plugin.Plugin< G, A, R >.convertType().

Here is the caller graph for this function:

◆ setDescription()

void net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.setDescription ( @NotNull String description )

Sets the user-provided description of the value for the user interface.

Parameters

description the description

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapPathToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapToXml1(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testStringToXml1().

Here is the caller graph for this function:

◆ setName()

void net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.setName ( @NotNull String name )

Sets the name of the parameter.

It identifies the parameter in the user interface and from the plugin script code.

Parameters

name the name

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapPathToXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapToXml1(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testStringToXml1().

Here is the caller graph for this function:

◆ setStringValue()

boolean net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.setStringValue ( @NotNull String stringValue )

Sets the parameter value from string representation.

Parameters

stringValue the string representation of the value to set

Returns: true
if the value was accepted or
false
if the value was not changed because the new value is invalid

Referenced by net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.executePlugin(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testArchetypeToXml2(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testArchetypeToXml3(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapPathToXml2(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapToXml3(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testStringToXml2().

Here is the caller graph for this function:

◆ visit()

<T> T net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.visit ( @NotNull PluginParameterVisitor< G, A, R, T > visitor )

Calls the.

visit()

function for this parameter type.

Parameters

visitor	the visitor to call
<T>	the visitor-specific type of the return value

Returns: an visitor-specific return value

The documentation for this interface was generated from the following file:

gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/PluginParameter.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addPluginParameterListener()

◆ getDescription()

◆ getName()

◆ getParameterType()

◆ getStringValue()

◆ getValue()

◆ getValueOrNull()

◆ removePluginParameterListener()

◆ setDescription()

◆ setName()

◆ setStringValue()

◆ visit()