Gridarta Editor
UndoState.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.undo;
21 
26 import org.jetbrains.annotations.NotNull;
27 import org.jetbrains.annotations.Nullable;
28 
34 public class UndoState<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
35 
39  @NotNull
40  private final String name;
41 
45  @NotNull
46  private final A mapArchObject;
47 
52  @Nullable
54 
61  public UndoState(@NotNull final String name, @NotNull final A mapArchObject) {
62  this.name = name;
63  this.mapArchObject = mapArchObject;
64  }
65 
70  @NotNull
71  public String getName() {
72  return name;
73  }
74 
81  public void setSavedSquares(@NotNull final SavedSquares<G, A, R> savedSquares) {
82  if (this.savedSquares != null) {
83  throw new IllegalStateException("saved squares already have been set");
84  }
85 
86  this.savedSquares = savedSquares;
87  }
88 
94  @NotNull
96  if (savedSquares == null) {
97  throw new IllegalStateException("saved squares are unset");
98  }
99  return savedSquares;
100  }
101 
106  @NotNull
107  public A getMapArchObject() {
108  return mapArchObject;
109  }
110 
111 }
net.sf.gridarta.model.undo.UndoState.savedSquares
SavedSquares< G, A, R > savedSquares
The affected map squares.
Definition: UndoState.java:53
net.sf.gridarta.model.undo.UndoState.getMapArchObject
A getMapArchObject()
Returns the map arch object before the operation started.
Definition: UndoState.java:107
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.undo.UndoState.setSavedSquares
void setSavedSquares(@NotNull final SavedSquares< G, A, R > savedSquares)
Records the affected map squares.
Definition: UndoState.java:81
net.sf
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.undo.UndoState.mapArchObject
final A mapArchObject
The map arch object before the operation started.
Definition: UndoState.java:46
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.undo.UndoState.UndoState
UndoState(@NotNull final String name, @NotNull final A mapArchObject)
Creates a new instance.
Definition: UndoState.java:61
net.sf.gridarta.model.undo.UndoState.getSavedSquares
SavedSquares< G, A, R > getSavedSquares()
Returns the map squares that have changed in the operation.
Definition: UndoState.java:95
net.sf.gridarta.model.mapmodel.SavedSquares
Records a set of changed map squares.
Definition: SavedSquares.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.model.undo.UndoState.getName
String getName()
Return the name of the operation.
Definition: UndoState.java:71
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.undo.UndoState
Holds information to undo/redo one edit operation.
Definition: UndoState.java:34
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.model.undo.UndoState.name
final String name
The name of the operation.
Definition: UndoState.java:40