Gridarta Editor
Public Member Functions | Private Member Functions | Private Attributes | List of all members
net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

Loader for pickmaps from a directory. More...

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

Public Member Functions

void load ()
 Loads all pickmap files from a directory and its sub-directories. More...
 
 Loader (@NotNull final ErrorView errorView, @NotNull final MapFolderTree< G, A, R > mapFolderTree, @NotNull final MapReaderFactory< G, A > mapReaderFactory, @NotNull final MapManager< G, A, R > pickmapManager, @NotNull final MapViewsManager< G, A, R > mapViewsManager)
 Creates a new instance. More...
 

Private Member Functions

MapFolder< G, A, R > load (@Nullable final MapFolder< G, A, R > parent, @NotNull final String folderName)
 Loads all pickmap files from a directory and its sub-directories. More...
 

Private Attributes

final ErrorView errorView
 The ErrorView for reporting errors. More...
 
final MapFolderTree< G, A, R > mapFolderTree
 The model to add the loaded pickmaps to. More...
 
final MapReaderFactory< G, A > mapReaderFactory
 The MapReaderFactory for loading map files. More...
 
final MapViewsManager< G, A, R > mapViewsManager
 The MapViewsManager. More...
 
final MapManager< G, A, R > pickmapManager
 The MapManager for loading pickmaps. More...
 

Detailed Description

Loader for pickmaps from a directory.

Author
Andreas Kirschbaum

Definition at line 40 of file Loader.java.

Constructor & Destructor Documentation

◆ Loader()

net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.Loader ( @NotNull final ErrorView  errorView,
@NotNull final MapFolderTree< G, A, R >  mapFolderTree,
@NotNull final MapReaderFactory< G, A >  mapReaderFactory,
@NotNull final MapManager< G, A, R >  pickmapManager,
@NotNull final MapViewsManager< G, A, R >  mapViewsManager 
)

Creates a new instance.

Parameters
errorViewthe error view for reporting error messages
mapFolderTreethe model to add the loaded pickmaps to
mapReaderFactorythe map reader factory to loading map files
pickmapManagerthe map manager for loading pickmaps
mapViewsManagerthe map views manager

Definition at line 80 of file Loader.java.

References net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.errorView, net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTree, net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapReaderFactory, net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewsManager, and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapManager.

Member Function Documentation

◆ load() [1/2]

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

Loads all pickmap files from a directory and its sub-directories.

Definition at line 91 of file Loader.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTree< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setActiveMapFolder().

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 call graph for this function:
+ Here is the caller graph for this function:

◆ load() [2/2]

MapFolder<G, A, R> net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.load ( @Nullable final MapFolder< G, A, R >  parent,
@NotNull final String  folderName 
)
private

Loads all pickmap files from a directory and its sub-directories.

Parameters
parentthe parent folder, or
null
folderNamethe folder name of
dir
Returns
the default
Folder
, or
null
if this directory is empty

Definition at line 106 of file Loader.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTree< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addMapFolder(), net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addPickmap(), net.sf.gridarta.gui.mapfiles.MapFolderTree< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getBaseDir(), net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getName(), net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getPickmaps(), net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.load(), net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapReaderFactory, net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewsManager, net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapManager, net.sf.gridarta.model.errorview.ErrorViewCategory.PICKMAPS_DIR_INVALID, and net.sf.gridarta.model.errorview.ErrorViewCategory.PICKMAPS_FILE_INVALID.

+ Here is the call graph for this function:

Member Data Documentation

◆ errorView

final ErrorView net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.errorView
private

The ErrorView for reporting errors.

Definition at line 46 of file Loader.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 >.Loader().

◆ mapFolderTree

final MapFolderTree<G, A, R> net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTree
private

The model to add the loaded pickmaps to.

Definition at line 52 of file Loader.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 >.Loader().

◆ mapReaderFactory

final MapReaderFactory<G, A> net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapReaderFactory
private

The MapReaderFactory for loading map files.

Definition at line 58 of file Loader.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(), and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.Loader().

◆ mapViewsManager

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

The MapViewsManager.

Definition at line 70 of file Loader.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(), and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.Loader().

◆ pickmapManager

final MapManager<G, A, R> net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapManager
private

The MapManager for loading pickmaps.

Definition at line 64 of file Loader.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(), and net.sf.gridarta.gui.mapfiles.Loader< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.Loader().

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