Gridarta Editor
GameObjectParser.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.io;
21 
22 import java.io.BufferedReader;
23 import java.io.IOException;
24 import java.util.Collection;
25 import java.util.List;
26 import java.util.Map;
30 import org.jetbrains.annotations.NotNull;
31 import org.jetbrains.annotations.Nullable;
32 
37 public interface GameObjectParser<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
38 
49  @Nullable
50  G load(@NotNull BufferedReader reader, @Nullable Collection<G> objects) throws IOException;
51 
64  @Nullable
65  G load(@NotNull BufferedReader reader, @NotNull String firstLine, @Nullable Collection<G> objects) throws IOException;
66 
73  void save(@NotNull Appendable appendable, @NotNull G gameObject) throws IOException;
74 
80  void collectTempList(@NotNull List<G> objects);
81 
88  @NotNull
89  Map<String, String> getModifiedFields(@NotNull G gameObject);
90 
96  void addModifiedFields(@NotNull G gameObject, @NotNull Map<String, String> fields);
97 
98 }
net.sf.gridarta.model.io.GameObjectParser.save
void save(@NotNull Appendable appendable, @NotNull G gameObject)
Write a game object object to a stream.
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.io.GameObjectParser.addModifiedFields
void addModifiedFields(@NotNull G gameObject, @NotNull Map< String, String > fields)
Adds the modified fields of a GameObject to a map.
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.model.io.GameObjectParser.getModifiedFields
Map< String, String > getModifiedFields(@NotNull G gameObject)
Returns the modified fields of a GameObject.
net.sf.gridarta.model.io.GameObjectParser.load
G load(@NotNull BufferedReader reader, @Nullable Collection< G > objects)
Parse a game object from a stream.
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.model.io.GameObjectParser.collectTempList
void collectTempList(@NotNull List< G > objects)
Browse first through the archetype list and attach map arches to it then browse through the face list...
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.io.GameObjectParser
Interface for classes that read or write GameObject instances.
Definition: GameObjectParser.java:37