net.sf.gridarta.plugin.parameter

Class AbstractPluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

java.lang.Object

net.sf.gridarta.plugin.parameter.AbstractPluginParameter<G,A,R,V>

All Implemented Interfaces:

PluginParameter<G,A,R,V>

Direct Known Subclasses:

AbstractStringPluginParameter, AbstractValuePluginParameter

public abstract class AbstractPluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>
extends java.lang.Object
implements PluginParameter<G,A,R,V>

Parameter for a Plugin.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPluginParameter() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addPluginParameterListener(@NotNull PluginParameterListener listener) Adds a listener to be notified.
protected void	changed() Notifies all listeners that this plugin parameter has changed.
@NotNull java.lang.String	getDescription() The user-provided description of the value for the user interface.
@NotNull java.lang.String	getName() The name of the parameter.
void	removePluginParameterListener(@NotNull PluginParameterListener listener) Removes a listener to be notified.
void	setDescription(@NotNull java.lang.String description) Sets the user-provided description of the value for the user interface.
void	setName(@NotNull java.lang.String name) Sets the name of the parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.gridarta.plugin.parameter.PluginParameter

getParameterType, getStringValue, getValue, getValueOrNull, setStringValue, visit

Constructor Detail

AbstractPluginParameter

protected AbstractPluginParameter()

Creates a new instance.

Method Detail

addPluginParameterListener

public void addPluginParameterListener(@NotNull
                                       @NotNull PluginParameterListener listener)

Description copied from interface: PluginParameter

Adds a listener to be notified.

Specified by:

addPluginParameterListener in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Parameters:

listener - the listener

removePluginParameterListener

public void removePluginParameterListener(@NotNull
                                          @NotNull PluginParameterListener listener)

Description copied from interface: PluginParameter

Removes a listener to be notified.

Specified by:

removePluginParameterListener in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Parameters:

listener - the listener

getName

@NotNull
public @NotNull java.lang.String getName()

Description copied from interface: PluginParameter

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

Specified by:

getName in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Returns:

the name

setName

public void setName(@NotNull
                    @NotNull java.lang.String name)

Description copied from interface: PluginParameter

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

Specified by:

setName in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Parameters:

name - the name

getDescription

@NotNull
public @NotNull java.lang.String getDescription()

Description copied from interface: PluginParameter

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

Specified by:

getDescription in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Returns:

the description

setDescription

public void setDescription(@NotNull
                           @NotNull java.lang.String description)

Description copied from interface: PluginParameter

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

Specified by:

setDescription in interface PluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>

Parameters:

description - the description

changed

protected void changed()

Notifies all listeners that this plugin parameter has changed.