Gridarta Editor
AbstractExitConnectorModel.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.model.exitconnector;
21 
22 import java.util.Collection;
23 import java.util.Objects;
24 import java.util.concurrent.CopyOnWriteArrayList;
25 import org.jetbrains.annotations.NotNull;
26 import org.jetbrains.annotations.Nullable;
27 
32 public abstract class AbstractExitConnectorModel implements ExitConnectorModel {
33 
37  private final Collection<ExitConnectorModelListener> listeners = new CopyOnWriteArrayList<>();
38 
43  @Nullable
45 
49  private boolean pasteExitName = loadPasteExitName();
50 
54  private boolean autoCreateExit = loadAutoCreateExit();
55 
59  @NotNull
61 
62  @Override
63  @Nullable
65  return exitLocation;
66  }
67 
68  @Override
69  public void setExitLocation(@Nullable final ExitLocation exitLocation) {
70  if (Objects.equals(exitLocation, this.exitLocation)) {
71  return;
72  }
73 
74  this.exitLocation = exitLocation;
75  for (final ExitConnectorModelListener listener : listeners) {
76  listener.exitLocationChanged(exitLocation);
77  }
78  }
79 
80  @Override
81  public boolean isPasteExitName() {
82  return pasteExitName;
83  }
84 
85  @Override
86  public void setPasteExitName(final boolean pasteExitName) {
87  if (this.pasteExitName == pasteExitName) {
88  return;
89  }
90 
91  this.pasteExitName = pasteExitName;
93  for (final ExitConnectorModelListener listener : listeners) {
94  listener.pasteExitNameChanged(pasteExitName);
95  }
96  }
97 
98  @Override
99  public boolean isAutoCreateExit() {
100  return autoCreateExit;
101  }
102 
103  @Override
104  public void setAutoCreateExit(final boolean autoCreateExit) {
105  if (this.autoCreateExit == autoCreateExit) {
106  return;
107  }
108 
109  this.autoCreateExit = autoCreateExit;
111  for (final ExitConnectorModelListener listener : listeners) {
112  listener.autoCreateExitChanged(autoCreateExit);
113  }
114  }
115 
116  @Override
117  @NotNull
118  public String getExitArchetypeName() {
119  return exitArchetypeName;
120  }
121 
122  @Override
123  public void setExitArchetypeName(@NotNull final String exitArchetypeName) {
124  if (this.exitArchetypeName.equals(exitArchetypeName)) {
125  return;
126  }
127 
128  this.exitArchetypeName = exitArchetypeName;
130  for (final ExitConnectorModelListener listener : listeners) {
131  listener.exitArchetypeNameChanged(exitArchetypeName);
132  }
133  }
134 
135  @Override
136  public void addExitConnectorModelListener(@NotNull final ExitConnectorModelListener listener) {
137  listeners.add(listener);
138  }
139 
140  @Override
141  public void removeExitConnectorModelListener(@NotNull final ExitConnectorModelListener listener) {
142  listeners.remove(listener);
143  }
144 
149  protected abstract boolean loadPasteExitName();
150 
155  protected abstract void savePasteExitName(boolean pasteExitName);
156 
161  protected abstract boolean loadAutoCreateExit();
162 
167  protected abstract void saveAutoCreateExit(boolean autoCreateExit);
168 
173  @NotNull
174  protected abstract String loadExitArchetypeName();
175 
180  protected abstract void saveExitArchetypeName(@NotNull String exitArchetypeName);
181 
182 }
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel
Stores information needed by the exit connector.
Definition: AbstractExitConnectorModel.java:32
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.addExitConnectorModelListener
void addExitConnectorModelListener(@NotNull final ExitConnectorModelListener listener)
Adds an ExitConnectorModelListener to be notified of changes.
Definition: AbstractExitConnectorModel.java:136
net.sf.gridarta.model.exitconnector.ExitLocation
Stores information about a remembered exit location.
Definition: ExitLocation.java:35
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.exitArchetypeName
String exitArchetypeName
The archetype to insert when creating new exit game objects.
Definition: AbstractExitConnectorModel.java:60
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.loadPasteExitName
abstract boolean loadPasteExitName()
Returns the stored attribute value for pasteExitName.
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.autoCreateExit
boolean autoCreateExit
Whether exit game objects should be auto-created when needed.
Definition: AbstractExitConnectorModel.java:54
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.saveAutoCreateExit
abstract void saveAutoCreateExit(boolean autoCreateExit)
Sets the stored attribute value for isAutoCreateExit().
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.isAutoCreateExit
boolean isAutoCreateExit()
Returns whether exit game objects should be auto-created when needed.
Definition: AbstractExitConnectorModel.java:99
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.listeners
final Collection< ExitConnectorModelListener > listeners
The listeners to notify.
Definition: AbstractExitConnectorModel.java:37
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.exitLocation
ExitLocation exitLocation
Whether an exit has been remembered.
Definition: AbstractExitConnectorModel.java:44
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.savePasteExitName
abstract void savePasteExitName(boolean pasteExitName)
Sets the stored attribute value for pasteExitName.
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.pasteExitName
boolean pasteExitName
Whether the exit's name should be set when pasted.
Definition: AbstractExitConnectorModel.java:49
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.getExitArchetypeName
String getExitArchetypeName()
Returns the archetype name when creating exit game objects.
Definition: AbstractExitConnectorModel.java:118
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.loadExitArchetypeName
abstract String loadExitArchetypeName()
Returns the stored attribute value for exitArchetypeName.
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.setAutoCreateExit
void setAutoCreateExit(final boolean autoCreateExit)
Sets whether exit game objects should be auto-created when needed.
Definition: AbstractExitConnectorModel.java:104
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.loadAutoCreateExit
abstract boolean loadAutoCreateExit()
Returns the stored attribute value for autoCreateExit.
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.isPasteExitName
boolean isPasteExitName()
Returns whether the exit name should be updated.
Definition: AbstractExitConnectorModel.java:81
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.setPasteExitName
void setPasteExitName(final boolean pasteExitName)
Sets whether the exit name should be updated.
Definition: AbstractExitConnectorModel.java:86
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.getExitLocation
ExitLocation getExitLocation()
Returns the remembered exit location.
Definition: AbstractExitConnectorModel.java:64
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.setExitLocation
void setExitLocation(@Nullable final ExitLocation exitLocation)
Sets the remembered exit location.
Definition: AbstractExitConnectorModel.java:69
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.setExitArchetypeName
void setExitArchetypeName(@NotNull final String exitArchetypeName)
Sets the archetype name for creating exit game objects.
Definition: AbstractExitConnectorModel.java:123
net.sf.gridarta.model.exitconnector.ExitConnectorModel
Stores information needed by the exit connector.
Definition: ExitConnectorModel.java:29
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.saveExitArchetypeName
abstract void saveExitArchetypeName(@NotNull String exitArchetypeName)
Sets the stored attribute value for setExitArchetypeName(String).
net.sf.gridarta.model.exitconnector.ExitConnectorModelListener
Interface for listeners interested in ExitConnectorModel related events.
Definition: ExitConnectorModelListener.java:31
net.sf.gridarta.model.exitconnector.AbstractExitConnectorModel.removeExitConnectorModelListener
void removeExitConnectorModelListener(@NotNull final ExitConnectorModelListener listener)
Removes an ExitConnectorModelListener to be notified of changes.
Definition: AbstractExitConnectorModel.java:141