net.sf.gridarta.plugin.parameter

Class DoubleParameter<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.AbstractValuePluginParameter<G,A,R,java.lang.Double>

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

All Implemented Interfaces:

PluginParameter<G,A,R,java.lang.Double>

public class DoubleParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends AbstractValuePluginParameter<G,A,R,java.lang.Double>

A PluginParameter that holds a double value.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DoubleParameter() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
double	getMax() Returns the maximal allowed value.
double	getMin() Returns the minimal allowed value.
@NotNull java.lang.String	getParameterType() Returns the parameter type name.
@NotNull java.lang.String	getStringValue() Returns the string representation of the current value of the parameter.
void	setMax(double max) Sets the maximal allowed value.
void	setMin(double min) Sets the minimal allowed value.
boolean	setStringValue(@NotNull java.lang.String stringValue) Sets the parameter value from string representation.
void	setValue(@NotNull java.lang.Double value) Updates the parameter value.
<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.AbstractValuePluginParameter

getValue, getValueOrNull

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

DoubleParameter

public DoubleParameter()

Creates a new instance.

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

setStringValue

public boolean setStringValue(@NotNull
                              @NotNull java.lang.String stringValue)

Description copied from interface: PluginParameter

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

setValue

public void setValue(@NotNull
                     @NotNull java.lang.Double value)

Description copied from class: AbstractValuePluginParameter

Updates the parameter value.

Overrides:

setValue in class AbstractValuePluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,java.lang.Double>

Parameters:

value - the new value

getParameterType

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

Description copied from interface: PluginParameter

Returns the parameter type name.

Returns:

the parameter type name

getStringValue

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

Description copied from interface: PluginParameter

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

Returns:

the string representation of the value

getMax

public double getMax()

Returns the maximal allowed value.

Returns:

the maximal allowed value

setMax

public void setMax(double max)

Sets the maximal allowed value.

Parameters:

max - the maximal allowed value

getMin

public double getMin()

Returns the minimal allowed value.

Returns:

the minimal allowed value

setMin

public void setMin(double min)

Sets the minimal allowed value.

Parameters:

min - the minimal allowed value