net.sf.gridarta.plugin.parameter

Class BooleanParameter<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.Boolean>

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

All Implemented Interfaces:

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

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

A PluginParameter that holds a boolean 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
BooleanParameter() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getFalseText() Returns the string representation of the "false" 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.
@NotNull java.lang.String	getTrueText() Returns the string representation of the "true" value.
void	setFalseText(@NotNull java.lang.String falseText) Sets the string representation of the "false" value.
boolean	setStringValue(@NotNull java.lang.String stringValue) Sets the parameter value from string representation.
void	setTrueText(@NotNull java.lang.String trueText) Sets the string representation of the "true" 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, setValue

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

BooleanParameter

public BooleanParameter()

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

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

getFalseText

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

Returns the string representation of the "false" value.

Returns:

the string representation

getTrueText

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

Returns the string representation of the "true" value.

Returns:

the string representation

setFalseText

public void setFalseText(@NotNull
                         @NotNull java.lang.String falseText)

Sets the string representation of the "false" value.

Parameters:

falseText - the string representation

setTrueText

public void setTrueText(@NotNull
                        @NotNull java.lang.String trueText)

Sets the string representation of the "true" value.

Parameters:

trueText - the string representation