Gridarta Editor
PluginParameter.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 import org.jetbrains.annotations.Nullable;
27 
33 public interface PluginParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>, V> {
34 
40 
46 
52  @NotNull
53  String getName();
54 
60  void setName(@NotNull String name);
61 
66  @NotNull
67  String getParameterType();
68 
73  @NotNull
74  String getDescription();
75 
80  void setDescription(@NotNull String description);
81 
87  @NotNull
89 
94  @Nullable
95  V getValueOrNull();
96 
101  @NotNull
102  String getStringValue();
103 
110  boolean setStringValue(@NotNull String stringValue);
111 
118  @NotNull
119  <T> T visit(@NotNull PluginParameterVisitor<G, A, R, T> visitor);
120 
121 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.plugin.parameter.PluginParameter.getParameterType
String getParameterType()
Returns the parameter type name.
net.sf.gridarta.plugin.parameter.PluginParameter.getStringValue
String getStringValue()
Returns the string representation of the current value of the parameter.
net.sf.gridarta.plugin.parameter.PluginParameter
Parameter for a Plugin.
Definition: PluginParameter.java:33
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.plugin.parameter.PluginParameterListener
Interface for listeners interested in PluginParameter related events.
Definition: PluginParameterListener.java:29
net.sf
net.sf.gridarta.plugin.parameter.PluginParameter.addPluginParameterListener
void addPluginParameterListener(@NotNull PluginParameterListener listener)
Adds a listener to be notified.
net.sf.gridarta.plugin.parameter.PluginParameter.getDescription
String getDescription()
The user-provided description of the value for the user interface.
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.PluginParameter.getValueOrNull
V getValueOrNull()
Returns the current value of this parameter.
net.sf.gridarta.plugin.parameter.PluginParameter.getValue
V getValue()
Returns the current value of this parameter.
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.plugin.parameter.PluginParameter.setStringValue
boolean setStringValue(@NotNull String stringValue)
Sets the parameter value from string representation.
net.sf.gridarta.plugin.parameter.PluginParameter.getName
String getName()
The name of the parameter.
net.sf.gridarta.plugin.parameter.InvalidValueException
An exception that is thrown if the string representation of value in a {} cannot be converted to an o...
Definition: InvalidValueException.java:30
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.plugin.parameter.PluginParameter.visit
< T > T visit(@NotNull PluginParameterVisitor< G, A, R, T > visitor)
Calls the.
net.sf.gridarta.plugin.parameter.PluginParameter.setDescription
void setDescription(@NotNull String description)
Sets the user-provided description of the value for the user interface.
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.PluginParameter.removePluginParameterListener
void removePluginParameterListener(@NotNull PluginParameterListener listener)
Removes a listener to be notified.
net.sf.gridarta.plugin.parameter.PluginParameter.setName
void setName(@NotNull String name)
Sets the name of the parameter.