Gridarta Editor
StringParameter.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.plugin.parameter;
21 
25 import org.jetbrains.annotations.NotNull;
26 
30 public class StringParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValuePluginParameter<G, A, R, String> {
31 
35  @NotNull
36  public static final String PARAMETER_TYPE = String.class.getName();
37 
41  public StringParameter() {
42  super("");
43  }
44 
45  @Override
46  public boolean setStringValue(@NotNull final String stringValue) {
47  setValue(stringValue);
48  return true;
49  }
50 
51  @NotNull
52  @Override
53  public <T> T visit(@NotNull final PluginParameterVisitor<G, A, R, T> visitor) {
54  return visitor.visit(this);
55  }
56 
57  @NotNull
58  @Override
59  public String getParameterType() {
60  return PARAMETER_TYPE;
61  }
62 
63  @NotNull
64  @Override
65  public String getStringValue() {
66  return getValue();
67  }
68 
69 }
net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, String >::setValue
void setValue( @NotNull final V value)
Updates the parameter value.
Definition: AbstractValuePluginParameter.java:64
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, String >::getValue
V getValue()
Definition: AbstractValuePluginParameter.java:50
net.sf.gridarta.plugin.parameter.StringParameter.PARAMETER_TYPE
static final String PARAMETER_TYPE
The string representation of this parameter type.
Definition: StringParameter.java:36
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.plugin.parameter.StringParameter.StringParameter
StringParameter()
Creates a new instance.
Definition: StringParameter.java:41
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter
Abstract base class for PluginParameter implementations for which the string representation of the va...
Definition: AbstractValuePluginParameter.java:32
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.plugin.parameter.StringParameter.setStringValue
boolean setStringValue(@NotNull final String stringValue)
Definition: StringParameter.java:46
net.sf.gridarta.plugin.parameter.StringParameter.visit
public< T > T visit(@NotNull final PluginParameterVisitor< G, A, R, T > visitor)
Definition: StringParameter.java:53
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.plugin.parameter.StringParameter.getParameterType
String getParameterType()
Definition: StringParameter.java:59
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.plugin.parameter.PluginParameterVisitor
Interface for visitors of PluginParameter instances.
Definition: PluginParameterVisitor.java:32
net.sf.gridarta.plugin.parameter.StringParameter.getStringValue
String getStringValue()
Definition: StringParameter.java:65
net.sf.gridarta.plugin.parameter.StringParameter
A PluginParameter that holds a string value.
Definition: StringParameter.java:30