A PluginParameter that holds an integer value and a range of valid values. More...
Inheritance diagram for net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Collaboration diagram for net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Public Member Functions | |
| int | getMax () |
| Returns the maximal allowed value. More... | |
| int | getMin () |
| Returns the minimal allowed value. More... | |
| String | getParameterType () |
| String | getStringValue () |
| IntegerParameter () | |
| Creates a new instance. More... | |
| void | setMax (final int max) |
| Sets the maximal allowed value. More... | |
| void | setMin (final int min) |
| Sets the minimal allowed value. More... | |
| boolean | setStringValue (@NotNull final String stringValue) |
| void | setValue (@NotNull final Integer value) |
| Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Integer > | |
| V | getValue () |
| V | getValueOrNull () |
| void | setValue ( @NotNull final V value) |
| Updates the parameter value. More... | |
Static Public Attributes | |
| static final String | PARAMETER_TYPE = Integer.class.getName() |
| The string representation of this parameter type. More... | |
Private Attributes | |
| int | max = Integer.MAX_VALUE |
| The maximal allowed value. More... | |
| int | min = Integer.MIN_VALUE |
| The minimal allowed value. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Integer > | |
| AbstractValuePluginParameter ( @NotNull final V value) | |
| Creates a new instance. More... | |
Detailed Description
A PluginParameter that holds an integer value and a range of valid values.
Definition at line 31 of file IntegerParameter.java.
Constructor & Destructor Documentation
◆ IntegerParameter()
| net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.IntegerParameter | ( | ) |
Creates a new instance.
Definition at line 52 of file IntegerParameter.java.
Member Function Documentation
◆ getMax()
| int net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMax | ( | ) |
Returns the maximal allowed value.
- Returns
- the maximal allowed value
Definition at line 102 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerFromXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerFromXml2(), and net.sf.gridarta.gui.dialog.plugin.parameter.IntegerParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateTooltip().
Here is the caller graph for this function:
◆ getMin()
| int net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMin | ( | ) |
Returns the minimal allowed value.
- Returns
- the minimal allowed value
Definition at line 126 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerFromXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerFromXml2(), and net.sf.gridarta.gui.dialog.plugin.parameter.IntegerParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateTooltip().
Here is the caller graph for this function:
◆ getParameterType()
| String net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType | ( | ) |
Definition at line 88 of file IntegerParameter.java.
◆ getStringValue()
| String net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getStringValue | ( | ) |
Definition at line 94 of file IntegerParameter.java.
◆ setMax()
| void net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMax | ( | final int | max | ) |
Sets the maximal allowed value.
- Parameters
-
max the maximal allowed value
Definition at line 110 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerToXml2().
Here is the caller graph for this function:
◆ setMin()
| void net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMin | ( | final int | min | ) |
Sets the minimal allowed value.
- Parameters
-
min the minimal allowed value
Definition at line 134 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerToXml2().
Here is the caller graph for this function:
◆ setStringValue()
| boolean net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setStringValue | ( | @NotNull final String | stringValue | ) |
Definition at line 63 of file IntegerParameter.java.
◆ setValue()
| void net.sf.gridarta.plugin.parameter.IntegerParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setValue | ( | @NotNull final Integer | value | ) |
Definition at line 82 of file IntegerParameter.java.
Referenced by net.sf.gridarta.gui.dialog.plugin.parameter.IntegerParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.IntegerParameterView(), net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.setMax(), net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.setMin(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testIntegerToXml2().
Here is the caller graph for this function:
Member Data Documentation
◆ max
|
private |
The maximal allowed value.
Definition at line 47 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.getMax().
◆ min
|
private |
The minimal allowed value.
Definition at line 42 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.getMin(), and net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.setValue().
◆ PARAMETER_TYPE
|
static |
The string representation of this parameter type.
Definition at line 37 of file IntegerParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.createParameter(), net.sf.gridarta.plugin.parameter.IntegerParameter< G, A, R >.getParameterType(), and net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.getTypes().
The documentation for this class was generated from the following file:
- gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/IntegerParameter.java
