Gridarta Editor
BooleanParameter.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 BooleanParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValuePluginParameter<G, A, R, Boolean> {
31 
35  @NotNull
36  public static final String PARAMETER_TYPE = Boolean.class.getName();
37 
41  @NotNull
42  private String trueText = "Yes";
43 
47  @NotNull
48  private String falseText = "No";
49 
53  public BooleanParameter() {
54  super(false);
55  }
56 
57  @NotNull
58  @Override
59  public <T> T visit(@NotNull final PluginParameterVisitor<G, A, R, T> visitor) {
60  return visitor.visit(this);
61  }
62 
63  @Override
64  public boolean setStringValue(@NotNull final String stringValue) {
65  if (stringValue.equals("true")) {
66  setValue(true);
67  } else if (stringValue.equals("false")) {
68  setValue(false);
69  } else {
70  return false;
71  }
72 
73  return true;
74  }
75 
76  @NotNull
77  @Override
78  public String getParameterType() {
79  return PARAMETER_TYPE;
80  }
81 
82  @NotNull
83  @Override
84  public String getStringValue() {
85  return getValue().toString();
86  }
87 
92  @NotNull
93  public String getFalseText() {
94  return falseText;
95  }
96 
101  @NotNull
102  public String getTrueText() {
103  return trueText;
104  }
105 
110  public void setFalseText(@NotNull final String falseText) {
111  if (this.falseText.equals(falseText)) {
112  return;
113  }
114  this.falseText = falseText;
115  changed();
116  }
117 
122  public void setTrueText(@NotNull final String trueText) {
123  if (this.trueText.equals(trueText)) {
124  return;
125  }
126  this.trueText = trueText;
127  changed();
128  }
129 
130 }
net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean >::setValue
void setValue( @NotNull final V value)
Updates the parameter value.
Definition: AbstractValuePluginParameter.java:64
net.sf.gridarta.plugin.parameter.BooleanParameter.getTrueText
String getTrueText()
Returns the string representation of the "true" value.
Definition: BooleanParameter.java:102
net.sf.gridarta.plugin.parameter.BooleanParameter.setStringValue
boolean setStringValue(@NotNull final String stringValue)
Definition: BooleanParameter.java:64
net.sf.gridarta.plugin.parameter.BooleanParameter.getFalseText
String getFalseText()
Returns the string representation of the "false" value.
Definition: BooleanParameter.java:93
net.sf.gridarta.plugin.parameter.BooleanParameter
A PluginParameter that holds a boolean value.
Definition: BooleanParameter.java:30
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Boolean >::getValue
V getValue()
Definition: AbstractValuePluginParameter.java:50
net.sf.gridarta.plugin.parameter.BooleanParameter.setFalseText
void setFalseText(@NotNull final String falseText)
Sets the string representation of the "false" value.
Definition: BooleanParameter.java:110
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.BooleanParameter.trueText
String trueText
The string representation of the "true" value.
Definition: BooleanParameter.java:42
net.sf.gridarta.plugin.parameter.BooleanParameter.visit
public< T > T visit(@NotNull final PluginParameterVisitor< G, A, R, T > visitor)
Definition: BooleanParameter.java:59
net.sf.gridarta.plugin.parameter.BooleanParameter.falseText
String falseText
The string representation of the "false" value.
Definition: BooleanParameter.java:48
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.BooleanParameter.getStringValue
String getStringValue()
Definition: BooleanParameter.java:84
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.BooleanParameter.getParameterType
String getParameterType()
Definition: BooleanParameter.java:78
net.sf.gridarta.plugin.parameter.BooleanParameter.BooleanParameter
BooleanParameter()
Creates a new instance.
Definition: BooleanParameter.java:53
net.sf.gridarta.plugin.parameter.BooleanParameter.setTrueText
void setTrueText(@NotNull final String trueText)
Sets the string representation of the "true" value.
Definition: BooleanParameter.java:122
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
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.BooleanParameter.PARAMETER_TYPE
static final String PARAMETER_TYPE
The string representation of this parameter type.
Definition: BooleanParameter.java:36