AbstractStringPluginParameter (Gridarta)

java.lang.Object
- net.sf.gridarta.plugin.parameter.AbstractPluginParameter<G,A,R,V>
- - net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter<G,A,R,V>

All Implemented Interfaces:

PluginParameter<G,A,R,V>

Direct Known Subclasses:

AbstractPathParameter, ArchetypeParameter, MapParameter, MapPathParameter
```
public abstract class AbstractStringPluginParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,V>
extends AbstractPluginParameter<G,A,R,V>
```
Abstract base class for PluginParameter implementations for which the value is calculated from the string representation.

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractStringPluginParameter(@NotNull java.lang.String stringValue)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@NotNull java.lang.String`	`getStringValue()`	Returns the string representation of the current value of the parameter.
`boolean`	`setStringValue(@NotNull java.lang.String stringValue)`	Updates the parameter value.

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

Methods inherited from interface net.sf.gridarta.plugin.parameter.PluginParameter
getParameterType, getValue, getValueOrNull, visit

- Constructor Detail
  - AbstractStringPluginParameter
```
protected AbstractStringPluginParameter(@NotNull
                                        @NotNull java.lang.String stringValue)
```
    Creates a new instance.
    
    Parameters:
    
    stringValue - the initial value
- Method Detail
  - 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
  - setStringValue
```
public boolean setStringValue(@NotNull
                              @NotNull java.lang.String stringValue)
```
    Updates the parameter value.
    
    Parameters:
    
    stringValue - the new value
    
    Returns:
    
    true if the value was accepted or false if the value was not changed because the new value is invalid