Package net.sf.gridarta.plugin.parameter

Class ArchetypeParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

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

net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter<G,A,R,Archetype<G,A,R>>

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

All Implemented Interfaces:

PluginParameter<G,A,R,Archetype<G,A,R>>

public class ArchetypeParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends AbstractStringPluginParameter<G,A,R,Archetype<G,A,R>>

A PluginParameter that holds an Archetype value.

Field Summary

Fields

Modifier and Type	Field	Description
static @NotNull java.lang.String	PARAMETER_TYPE	The string representation of this parameter type.

Constructor Summary

Constructors

Constructor	Description
ArchetypeParameter(@NotNull ArchetypeSet<G,A,R> archetypeSet)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@NotNull java.lang.String	getParameterType()	Returns the parameter type name.
@NotNull Archetype<G,A,R>	getValue()	Returns the current value of this parameter.
@Nullable Archetype<G,A,R>	getValueOrNull()	Returns the current value of this parameter.
<T> T	visit(@NotNull PluginParameterVisitor<G,A,R,T> visitor)	Calls the visit() function for this parameter type.

Methods inherited from class net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter

getStringValue, setStringValue

Methods inherited from class net.sf.gridarta.plugin.parameter.AbstractPluginParameter

addPluginParameterListener, changed, getDescription, getName, removePluginParameterListener, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_TYPE

@NotNull
public static final @NotNull java.lang.String PARAMETER_TYPE

The string representation of this parameter type.

Constructor Detail

ArchetypeParameter

public ArchetypeParameter(@NotNull
                          @NotNull ArchetypeSet<G,A,R> archetypeSet)

Creates a new instance.

Parameters:

archetypeSet - the archetype set for looking up archetypes

Method Detail

visit

@NotNull
public <T> T visit(@NotNull
                   @NotNull PluginParameterVisitor<G,A,R,T> visitor)

Description copied from interface: PluginParameter

Calls the visit() function for this parameter type.

Type Parameters:

T - the visitor-specific type of the return value

Parameters:

visitor - the visitor to call

Returns:

a visitor-specific return value

getValue

@NotNull
public @NotNull Archetype<G,A,R> getValue()
                                               throws InvalidValueException

Description copied from interface: PluginParameter

Returns the current value of this parameter.

Returns:

the value

Throws:

InvalidValueException - if the the value is invalid

getValueOrNull

@Nullable
public @Nullable Archetype<G,A,R> getValueOrNull()

Description copied from interface: PluginParameter

Returns the current value of this parameter.

Returns:

the value or null if the the value is invalid

getParameterType

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

Description copied from interface: PluginParameter

Returns the parameter type name.

Returns:

the parameter type name