net.sf.gridarta.model.mapcontrol

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

java.lang.Object

net.sf.gridarta.model.mapcontrol.DefaultMapControl<G,A,R>

All Implemented Interfaces:

MapControl<G,A,R>

public class DefaultMapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements MapControl<G,A,R>

Implements map models.

Constructor Summary

Constructors

Constructor and Description
DefaultMapControl(@NotNull MapModel<G,A,R> mapModel, boolean isPickmap, @NotNull MapWriter<G,A,R> mapWriter, @NotNull ProjectSettings projectSettings) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	acquire() Increases the use counter.
void	addMapControlListener(@NotNull MapControlListener<G,A,R> listener) Registers a MapControlListener.
@NotNull MapModel<G,A,R>	getMapModel() Returns the map model.
int	getUseCounter() Returns the use counter.
boolean	isPickmap() Return flag that indicates whether this is a pickmap or not.
void	release() Decreases the use counter and possibly frees the map control.
void	removeMapControlListener(@NotNull MapControlListener<G,A,R> listener) Unregisters a MapControlListener.
void	save() Saves the map to a file.
void	saveAs(@NotNull MapFile mapFile) Saves the file with the given map file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMapControl

public DefaultMapControl(@NotNull
                         @NotNull MapModel<G,A,R> mapModel,
                         boolean isPickmap,
                         @NotNull
                         @NotNull MapWriter<G,A,R> mapWriter,
                         @NotNull
                         @NotNull ProjectSettings projectSettings)

Creates a new instance.

Parameters:

mapModel - the map model to use

isPickmap - true if this is a pickmap

mapWriter - the map writer for saving map control instances

projectSettings - the project settings to use

Method Detail

addMapControlListener

public void addMapControlListener(@NotNull
                                  @NotNull MapControlListener<G,A,R> listener)

Description copied from interface: MapControl

Registers a MapControlListener.

Specified by:

addMapControlListener in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to register

removeMapControlListener

public void removeMapControlListener(@NotNull
                                     @NotNull MapControlListener<G,A,R> listener)

Description copied from interface: MapControl

Unregisters a MapControlListener.

Specified by:

removeMapControlListener in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to unregister

acquire

public void acquire()

Description copied from interface: MapControl

Increases the use counter.

Specified by:

acquire in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

release

public void release()

Description copied from interface: MapControl

Decreases the use counter and possibly frees the map control.

Specified by:

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

getUseCounter

public int getUseCounter()

Description copied from interface: MapControl

Returns the use counter.

Specified by:

getUseCounter in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the use counter

isPickmap

public boolean isPickmap()

Description copied from interface: MapControl

Return flag that indicates whether this is a pickmap or not.

Specified by:

isPickmap in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

flag that indicates whether this is a pickmap or not

save

public void save()
          throws java.io.IOException

Description copied from interface: MapControl

Saves the map to a file.

Specified by:

save in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Throws:

java.io.IOException - if saving fails

saveAs

public void saveAs(@NotNull
                   @NotNull MapFile mapFile)
            throws java.io.IOException

Description copied from interface: MapControl

Saves the file with the given map file. This implicitly sets the map file and resets the modified state.

Specified by:

saveAs in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapFile - the map file to be saved to

Throws:

java.io.IOException - if saving fails; in this case the modified flag is not reset

getMapModel

@NotNull
public @NotNull MapModel<G,A,R> getMapModel()

Description copied from interface: MapControl

Returns the map model.

Specified by:

getMapModel in interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the map model