A PluginParameter that holds a boolean value. More...
Inheritance diagram for net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Collaboration diagram for net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Public Member Functions | |
| BooleanParameter () | |
| Creates a new instance. More... | |
| String | getFalseText () |
| Returns the string representation of the "false" value. More... | |
| String | getParameterType () |
| String | getStringValue () |
| String | getTrueText () |
| Returns the string representation of the "true" value. More... | |
| void | setFalseText (@NotNull final String falseText) |
| Sets the string representation of the "false" value. More... | |
| boolean | setStringValue (@NotNull final String stringValue) |
| void | setTrueText (@NotNull final String trueText) |
| Sets the string representation of the "true" value. More... | |
| Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean > | |
| V | getValue () |
| V | getValueOrNull () |
| void | setValue ( @NotNull final V value) |
| Updates the parameter value. More... | |
Static Public Attributes | |
| static final String | PARAMETER_TYPE = Boolean.class.getName() |
| The string representation of this parameter type. More... | |
Private Attributes | |
| String | falseText = "No" |
| The string representation of the "false" value. More... | |
| String | trueText = "Yes" |
| The string representation of the "true" value. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean > | |
| AbstractValuePluginParameter ( @NotNull final V value) | |
| Creates a new instance. More... | |
Detailed Description
A PluginParameter that holds a boolean value.
Definition at line 30 of file BooleanParameter.java.
Constructor & Destructor Documentation
◆ BooleanParameter()
| net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.BooleanParameter | ( | ) |
Creates a new instance.
Definition at line 53 of file BooleanParameter.java.
Member Function Documentation
◆ getFalseText()
| String net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getFalseText | ( | ) |
Returns the string representation of the "false" value.
- Returns
- the string representation
Definition at line 93 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanFromXml1(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanFromXml2().
Here is the caller graph for this function:
◆ getParameterType()
| String net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType | ( | ) |
◆ getStringValue()
| String net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getStringValue | ( | ) |
Definition at line 84 of file BooleanParameter.java.
References net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean >.getValue().
Here is the call graph for this function:
◆ getTrueText()
| String net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getTrueText | ( | ) |
Returns the string representation of the "true" value.
- Returns
- the string representation
Definition at line 102 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanFromXml1(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanFromXml2().
Here is the caller graph for this function:
◆ setFalseText()
| void net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setFalseText | ( | @NotNull final String | falseText | ) |
Sets the string representation of the "false" value.
- Parameters
-
falseText the string representation
Definition at line 110 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanToXml2().
Here is the caller graph for this function:
◆ setStringValue()
| boolean net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setStringValue | ( | @NotNull final String | stringValue | ) |
Definition at line 64 of file BooleanParameter.java.
References net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean >.setValue().
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanToXml2().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setTrueText()
| void net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setTrueText | ( | @NotNull final String | trueText | ) |
Sets the string representation of the "true" value.
- Parameters
-
trueText the string representation
Definition at line 122 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testBooleanToXml2().
Here is the caller graph for this function:
Member Data Documentation
◆ falseText
|
private |
The string representation of the "false" value.
Definition at line 48 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getFalseText(), and net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setFalseText().
◆ PARAMETER_TYPE
|
static |
The string representation of this parameter type.
Definition at line 36 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.createParameter(), net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType(), and net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.getTypes().
◆ trueText
|
private |
The string representation of the "true" value.
Definition at line 42 of file BooleanParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getTrueText(), and net.sf.gridarta.plugin.parameter.BooleanParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setTrueText().
The documentation for this class was generated from the following file:
- gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/BooleanParameter.java
