Model class representing a folder of MapFiles. More...

Inheritance diagram for net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	addFolderListener (@NotNull final MapFolderListener< G, A, R > listenerMap)
	Adds a MapFolderListener to be notified of events. More...

PickmapState< G, A, R >	addPickmap (@NotNull final String name, @NotNull final MapReaderFactory< G, A > mapReaderFactory, @NotNull final MapManager< G, A, R > pickmapManager) throws InvalidNameException
	Adds a new PickmapState to this folder. More...

void	firePickmapReverted (@NotNull final PickmapState< G, A, R > pickmapState, @NotNull final MapControl< G, A, R > oldPickmap)
	Notifies all listeners about a reverted pickmap. More...

File	getDir ()
	Returns the base directory. More...

String	getName ()
	Returns the name. More...

MapFolder< G, A, R >	getParent ()
	Returns the parent folder. More...

int	getPickmaps ()
	Returns the number of pickmaps in this folder. More...

void	getUnsavedPickmaps (@NotNull final Collection< MapControl< G, A, R >> unsavedPickmaps)
	Returns all unsaved MapFiles in this folder. More...

Iterator< PickmapState< G, A, R > >	iterator ()
	Returns an Iterator returning all pickmaps of this folder in arbitrary order. More...

	MapFolder (@Nullable final MapFolder< G, A, R > parent, @NotNull final String name, @NotNull final File baseDir, @NotNull final MapViewsManager< G, A, R > mapViewsManager) throws InvalidNameException
	Creates a new instance. More...

void	removeAllPickmaps (final boolean deleteFile)
	Removes all PickmapState from this folder. More...

void	removeFolderListener (@NotNull final MapFolderListener< G, A, R > listenerMap)
	Removes a MapFolderListener to be notified of events. More...

void	removePickmap (@NotNull final PickmapState< G, A, R > pickmapState, final boolean deleteFile)
	Removes a PickmapState from this folder. More...

Private Attributes
final File	baseDir
	The base directory for folder file names. More...

final EventListenerList2< MapFolderListener< G, A, R > >	listeners = new EventListenerList2<>(MapFolderListener.class)
	The registered event listeners. More...

final MapViewsManager< G, A, R >	mapViewsManager
	The MapViewsManager. More...

final String	name
	The folder's name. More...

final MapFolder< G, A, R >	parent
	The parent folder, or. More...

final List< PickmapState< G, A, R > >	pickmapStates = new ArrayList<>()
	The pickmaps of this folder. More...

final Object	sync = new Object()
	The synchronization object for accesses to pickmapStates. More...

Static Private Attributes
static final Pattern	PATTERN_VALID_MAP_FOLDER_NAME = Pattern.compile("[-a-zA-Z_+ 0-9,]+")
	The Pattern that matches valid map folder names. More...

Detailed Description

Model class representing a folder of MapFiles.

A folder has a name and a base directory. The name is a unique identifier in the model; the base directory is the directory where all contained pickmaps are stored.

Author: Andreas Kirschbaum

Definition at line 47 of file MapFolder.java.

Constructor & Destructor Documentation

◆ MapFolder()

net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolder	(	@Nullable final MapFolder< G, A, R >	parent,
		@NotNull final String	name,
		@NotNull final File	baseDir,
		@NotNull final MapViewsManager< G, A, R >	mapViewsManager
	)		throws InvalidNameException

Creates a new instance.

Parameters

parent	the parent folder, or null if it is a top-level folder
name	the name
baseDir	the base directory for folder file names
mapViewsManager	the map views

Exceptions

InvalidNameException

if

name

is not valid

Definition at line 104 of file MapFolder.java.

Member Function Documentation

◆ addFolderListener()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addFolderListener ( @NotNull final MapFolderListener< G, A, R > listenerMap )

Adds a MapFolderListener to be notified of events.

Parameters

listenerMap the listener to add

Definition at line 229 of file MapFolder.java.

◆ addPickmap()

PickmapState<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addPickmap	(	@NotNull final String	name,
		@NotNull final MapReaderFactory< G, A >	mapReaderFactory,
		@NotNull final MapManager< G, A, R >	pickmapManager
	)		throws InvalidNameException

Adds a new PickmapState to this folder.

Parameters

name	the map file name
mapReaderFactory	the map reader factory instance
pickmapManager	the map manager for loading pickmaps

Returns: the newly created pickmap

Exceptions

InvalidNameException if the pickmap name is invalid

Definition at line 155 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.load().

Here is the caller graph for this function:

◆ firePickmapReverted()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.firePickmapReverted	(	@NotNull final PickmapState< G, A, R >	pickmapState,
		@NotNull final MapControl< G, A, R >	oldPickmap
	)

Notifies all listeners about a reverted pickmap.

Parameters

pickmapState	the pickmap that was reverted
oldPickmap	the map control of the pickmap before reverting

Definition at line 256 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.revert().

Here is the caller graph for this function:

◆ getDir()

File net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getDir ( )

Returns the base directory.

Returns: the base directory

Definition at line 143 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.dialog.newmap.NewPickmapFolderDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createNew(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getDir(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.getFile(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.hashCode().

Here is the caller graph for this function:

◆ getName()

String net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getName ( )

Returns the name.

Returns: the name

Definition at line 130 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTree< G, A, R >.addMapFolder(), net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getName(), and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.load().

Here is the caller graph for this function:

◆ getParent()

MapFolder<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParent ( )

Returns the parent folder.

Returns: the parent folder, or
null
if this folder is a top-level folder

Definition at line 121 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTree< G, A, R >.addMapFolder(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder().

Here is the caller graph for this function:

◆ getPickmaps()

int net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getPickmaps ( )

Returns the number of pickmaps in this folder.

Returns: the number of pickmaps

Definition at line 221 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder(), and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.load().

Here is the caller graph for this function:

◆ getUnsavedPickmaps()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getUnsavedPickmaps ( @NotNull final Collection< MapControl< G, A, R >> unsavedPickmaps )

Returns all unsaved MapFiles in this folder.

Parameters

unsavedPickmaps the collection to add the unsaved pickmaps to

Definition at line 245 of file MapFolder.java.

◆ iterator()

Iterator<PickmapState<G, A, R> > net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.iterator ( )

Returns an Iterator returning all pickmaps of this folder in arbitrary order.

Returns: the iterator

Definition at line 213 of file MapFolder.java.

◆ removeAllPickmaps()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeAllPickmaps ( final boolean deleteFile )

Removes all PickmapState from this folder.

Parameters

deleteFile if set, also remove the map file

Definition at line 194 of file MapFolder.java.

◆ removeFolderListener()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeFolderListener ( @NotNull final MapFolderListener< G, A, R > listenerMap )

Removes a MapFolderListener to be notified of events.

Parameters

listenerMap the listener to remove

Definition at line 237 of file MapFolder.java.

◆ removePickmap()

void net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removePickmap	(	@NotNull final PickmapState< G, A, R >	pickmapState,
		final boolean	deleteFile
	)

Removes a PickmapState from this folder.

Parameters

pickmapState	the pickmap to remove
deleteFile	if set, also remove the map files

Definition at line 172 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.remove(), and net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.removeAllPickmaps().

Here is the caller graph for this function:

Member Data Documentation

◆ baseDir

final File net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.baseDir

private

The base directory for folder file names.

Definition at line 82 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.MapFolder().

◆ listeners

final EventListenerList2<MapFolderListener<G, A, R> > net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.listeners = new EventListenerList2<>(MapFolderListener.class)

private

The registered event listeners.

Definition at line 58 of file MapFolder.java.

◆ mapViewsManager

final MapViewsManager<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewsManager

private

The MapViewsManager.

Definition at line 88 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.addPickmap(), and net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.MapFolder().

◆ name

final String net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.name

private

The folder's name.

Definition at line 76 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.addPickmap(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getDir(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getName(), and net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.MapFolder().

◆ parent

final MapFolder<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.parent

private

The parent folder, or.

null

if it is a top-level folder.

Definition at line 64 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getName(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.getParent(), and net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.MapFolder().

◆ PATTERN_VALID_MAP_FOLDER_NAME

final Pattern net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.PATTERN_VALID_MAP_FOLDER_NAME = Pattern.compile("[-a-zA-Z_+ 0-9,]+")

staticprivate

The Pattern that matches valid map folder names.

Definition at line 53 of file MapFolder.java.

◆ pickmapStates

final List<PickmapState<G, A, R> > net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapStates = new ArrayList<>()

private

The pickmaps of this folder.

Definition at line 93 of file MapFolder.java.

◆ sync

final Object net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.sync = new Object()

private

The synchronization object for accesses to pickmapStates.

Definition at line 70 of file MapFolder.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.addPickmap(), net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.removeAllPickmaps(), and net.sf.gridarta.gui.mapfiles.MapFolder< G, A, R >.removePickmap().

The documentation for this class was generated from the following file:

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/gui/mapfiles/MapFolder.java

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MapFolder()

Member Function Documentation

◆ addFolderListener()

◆ addPickmap()

◆ firePickmapReverted()

◆ getDir()

◆ getName()

◆ getParent()

◆ getPickmaps()

◆ getUnsavedPickmaps()

◆ iterator()

◆ removeAllPickmaps()

◆ removeFolderListener()

◆ removePickmap()

Member Data Documentation

◆ baseDir

◆ listeners

◆ mapViewsManager

◆ name

◆ parent

◆ PATTERN_VALID_MAP_FOLDER_NAME

◆ pickmapStates

◆ sync