net.sf.gridarta.model.mapmanager

Class AbstractMapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.model.mapmanager.AbstractMapManager<G,A,R>

All Implemented Interfaces:

MapManager<G,A,R>

Direct Known Subclasses:

DefaultMapManager, DefaultPickmapManager

public abstract class AbstractMapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements MapManager<G,A,R>

Abstract base class for MapManager implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMapManager(MapReaderFactory<G,A> mapReaderFactory, ProjectSettings projectSettings, FaceObjectProviders faceObjectProviders, PathManager pathManager) Create a new map manager.

Method Summary

Modifier and Type	Method and Description
void	addMapManagerListener(MapManagerListener<G,A,R> listener) Adds a MapManagerListener to be notified.
void	closeMap(MapControl<G,A,R> mapControl) Closes the given map, ignoring modified status.
protected abstract MapControl<G,A,R>	createMapControl(java.util.List<G> objects, A mapArchObject, MapFile mapFile) Creates a new MapControl instance.
MapControl<G,A,R>	getCurrentMap() Returns the current top map we are working with.
java.io.File	getLocalMapDir() Returns a guess for a script directory to use.
java.util.List<MapControl<G,A,R>>	getOpenedMaps() Returns all opened maps.
MapControl<G,A,R>	getOpenMap() Returns one open map.
MapControl<G,A,R>	newMap(java.util.List<G> objects, A mapArchObject, MapFile mapFile, boolean interactive) Creates a new map control without view.
MapControl<G,A,R>	openMapFile(java.io.File file, boolean interactive) Loads a map file.
MapControl<G,A,R>	openMapFile(MapFile mapFile, boolean interactive) Loads a map file.
void	release(MapControl<G,A,R> mapControl) Releases a MapControl instance.
void	removeMapManagerListener(MapManagerListener<G,A,R> listener) Removes a MapManagerListener to be notified.
void	revert(MapControl<G,A,R> mapControl) Reverts one map.
void	setCurrentMap(MapControl<G,A,R> mapControl) Sets the given map as the current one.
void	setFileControl(FileControl<G,A,R> fileControl) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMapManager

protected AbstractMapManager(@NotNull
                             MapReaderFactory<G,A> mapReaderFactory,
                             @NotNull
                             ProjectSettings projectSettings,
                             @NotNull
                             FaceObjectProviders faceObjectProviders,
                             @NotNull
                             PathManager pathManager)

Create a new map manager.

Parameters:

mapReaderFactory - the map reader factory instance

projectSettings - the project settings instance

faceObjectProviders - the face object providers

pathManager - the path manager for converting file instances

Method Detail

setFileControl

@Deprecated
public void setFileControl(@NotNull
                                       FileControl<G,A,R> fileControl)

Deprecated.

newMap

@NotNull
public MapControl<G,A,R> newMap(@Nullable
                                         java.util.List<G> objects,
                                         @NotNull
                                         A mapArchObject,
                                         @Nullable
                                         MapFile mapFile,
                                         boolean interactive)

Creates a new map control without view. The returned instance must be freed with MapManager.release(MapControl) when not needed anymore.

Specified by:

newMap in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

objects - the game objects to insert; may be null

mapArchObject - the map arch object for the new map

mapFile - the map file, or null if the map was not yet saved

interactive - if set, the new map becomes the current map

Returns:

the newly created map control

createMapControl

@NotNull
protected abstract MapControl<G,A,R> createMapControl(@Nullable
                                                               java.util.List<G> objects,
                                                               @NotNull
                                                               A mapArchObject,
                                                               @Nullable
                                                               MapFile mapFile)

Creates a new MapControl instance.

Parameters:

objects - the objects to insert into the new map

mapArchObject - the map arch object to use for the new map

mapFile - the associated map file

Returns:

the new map control instance

getOpenMap

@Nullable
public MapControl<G,A,R> getOpenMap()

Returns one open map.

Specified by:

getOpenMap in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the map or null if no open maps exist

closeMap

public void closeMap(@NotNull
                     MapControl<G,A,R> mapControl)

Closes the given map, ignoring modified status.

Specified by:

closeMap in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map to close

openMapFile

@NotNull
public MapControl<G,A,R> openMapFile(@NotNull
                                              MapFile mapFile,
                                              boolean interactive)
                                       throws java.io.IOException

Loads a map file. The returned instance must be freed with MapManager.release(MapControl) when not needed anymore.

Specified by:

openMapFile in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapFile - the map file to load

interactive - if set, may ask to delete undefined archetypes; if unset, keep undefined archetypes

Returns:

the map control

Throws:

java.io.IOException - if an I/O error occurs

openMapFile

@NotNull
public MapControl<G,A,R> openMapFile(@NotNull
                                              java.io.File file,
                                              boolean interactive)
                                       throws java.io.IOException

Loads a map file. The returned instance must be freed with MapManager.release(MapControl) when not needed anymore.

Specified by:

openMapFile in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

file - the map file to load

interactive - if set, may ask to delete undefined archetypes; if unset, keep undefined archetypes

Returns:

the map control

Throws:

java.io.IOException - if an I/O error occurs

setCurrentMap

public void setCurrentMap(@Nullable
                          MapControl<G,A,R> mapControl)

Sets the given map as the current one.

Specified by:

setCurrentMap in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the MapControl of the new current map

getOpenedMaps

@NotNull
public java.util.List<MapControl<G,A,R>> getOpenedMaps()

Returns all opened maps.

Specified by:

getOpenedMaps in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the opened maps

getCurrentMap

@Nullable
public MapControl<G,A,R> getCurrentMap()

Returns the current top map we are working with.

Specified by:

getCurrentMap in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the current top map we are working with, or null if no map is open

addMapManagerListener

public void addMapManagerListener(@NotNull
                                  MapManagerListener<G,A,R> listener)

Adds a MapManagerListener to be notified.

Specified by:

addMapManagerListener in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to add

removeMapManagerListener

public void removeMapManagerListener(@NotNull
                                     MapManagerListener<G,A,R> listener)

Removes a MapManagerListener to be notified.

Specified by:

removeMapManagerListener in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to remove

revert

public void revert(@NotNull
                   MapControl<G,A,R> mapControl)
            throws java.io.IOException

Reverts one map.

Specified by:

revert in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map to revert

Throws:

java.io.IOException - if an I/O error occurs

getLocalMapDir

public java.io.File getLocalMapDir()

Returns a guess for a script directory to use.

Specified by:

getLocalMapDir in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the directory

release

public void release(@NotNull
                    MapControl<G,A,R> mapControl)

Releases a MapControl instance.

Specified by:

release in interface MapManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map control instance