Parameter for a Plugin. More...

Inheritance diagram for net.sf.gridarta.plugin.parameter.AbstractPluginParameter< 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.AbstractPluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >:

Public Member Functions
void	addPluginParameterListener (@NotNull final PluginParameterListener listener)

String	getDescription ()

String	getName ()

void	removePluginParameterListener (@NotNull final PluginParameterListener listener)

void	setDescription (@NotNull final String description)

void	setName (@NotNull final String name)

Public Member Functions inherited from net.sf.gridarta.plugin.parameter.PluginParameter< G, A, R, V >
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...

Protected Member Functions
	AbstractPluginParameter ()
	Creates a new instance. More...

void	changed ()
	Notifies all listeners that this plugin parameter has changed. More...

Private Attributes
String	description = "[description]"
	The user-provided description of the value for the user interface. More...

final EventListenerList2< PluginParameterListener >	listeners = new EventListenerList2<>(PluginParameterListener.class)
	The listeners to notify. More...

String	name = "[name]"
	The name of the parameter for the plugin script. More...

Detailed Description

Parameter for a Plugin.

Author: tchize

Definition at line 32 of file AbstractPluginParameter.java.

Constructor & Destructor Documentation

◆ AbstractPluginParameter()

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

protected

Creates a new instance.

Definition at line 55 of file AbstractPluginParameter.java.

Member Function Documentation

◆ addPluginParameterListener()

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

Definition at line 59 of file AbstractPluginParameter.java.

◆ changed()

void net.sf.gridarta.plugin.parameter.AbstractPluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.changed ( )

protected

Notifies all listeners that this plugin parameter has changed.

Definition at line 101 of file AbstractPluginParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.AbstractPluginParameter< G, A, R, V >.setDescription(), and net.sf.gridarta.plugin.parameter.AbstractPluginParameter< G, A, R, V >.setName().

Here is the caller graph for this function:

◆ getDescription()

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

Definition at line 85 of file AbstractPluginParameter.java.

◆ getName()

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

Definition at line 70 of file AbstractPluginParameter.java.

◆ removePluginParameterListener()

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

Definition at line 64 of file AbstractPluginParameter.java.

◆ setDescription()

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

Definition at line 90 of file AbstractPluginParameter.java.

◆ setName()

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