Gridarta Editor
net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Referenceabstract

Maintains resources. More...

+ Inheritance diagram for net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
+ Collaboration diagram for net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions

boolean canWriteCollected ()
 Whether the resources can be written in collected form. More...
 
void readCollected (@NotNull final ProjectSettings projectSettings, @NotNull final ErrorView errorView)
 Reads the resources from a collection. More...
 
void readFiles (@NotNull final ProjectSettings projectSettings, @NotNull final ErrorView errorView)
 Reads the resources from individual files. More...
 
void writeCollected (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
 Writes the resources in collected form. More...
 

Protected Member Functions

 AbstractResources (@NotNull final GameObjectParser< G, A, R > gameObjectParser, @NotNull final ArchetypeSet< G, A, R > archetypeSet)
 Creates a new instance. More...
 
abstract List< G > readCollectedInt (@NotNull ProjectSettings projectSettings, @NotNull ErrorView errorView)
 Reads the resources from a collection. More...
 
abstract void readFilesInt (@NotNull ProjectSettings projectSettings, @NotNull ErrorView errorView, @NotNull List< G > invObjects)
 Reads the resources from individual files. More...
 
abstract void writeCollectedInt (@NotNull Progress progress, @NotNull File collectedDirectory) throws IOException
 Writes the resources in collected form. More...
 

Private Member Functions

void finishRead (@NotNull final List< G > invObjects)
 Common code to be executed after reading resources. More...
 

Private Attributes

final ArchetypeSet< G, A, R > archetypeSet
 The ArchetypeSet to update. More...
 
final GameObjectParser< G, A, R > gameObjectParser
 The GameObjectParser to use. More...
 
boolean loaded
 Whether the resources have been loaded. More...
 
boolean loadedFromFiles
 Whether the resources have been loaded from individual files. More...
 

Detailed Description

Maintains resources.

Author
Andreas Kirschbaum

Definition at line 40 of file AbstractResources.java.

Constructor & Destructor Documentation

◆ AbstractResources()

net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.AbstractResources ( @NotNull final GameObjectParser< G, A, R >  gameObjectParser,
@NotNull final ArchetypeSet< G, A, R >  archetypeSet 
)
protected

Creates a new instance.

Parameters
gameObjectParserthe game object parser to use
archetypeSetthe archetype set to update

Definition at line 69 of file AbstractResources.java.

Member Function Documentation

◆ canWriteCollected()

boolean net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.canWriteCollected ( )

◆ finishRead()

void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.finishRead ( @NotNull final List< G >  invObjects)
private

Common code to be executed after reading resources.

Parameters
invObjectsall archetypes

Definition at line 78 of file AbstractResources.java.

Referenced by net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.readCollected(), and net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.readFiles().

+ Here is the caller graph for this function:

◆ readCollected()

void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.readCollected ( @NotNull final ProjectSettings  projectSettings,
@NotNull final ErrorView  errorView 
)

Reads the resources from a collection.

Parameters
projectSettingsthe project settings to read from
errorViewthe error view for reporting problems

Definition at line 104 of file AbstractResources.java.

◆ readCollectedInt()

abstract List<G> net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.readCollectedInt ( @NotNull ProjectSettings  projectSettings,
@NotNull ErrorView  errorView 
)
abstractprotected

Reads the resources from a collection.

Parameters
projectSettingsthe project settings to read from
errorViewthe error view for reporting problems
Returns
all read archetypes

Referenced by net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.readCollected(), and net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.writeCollected().

+ Here is the caller graph for this function:

◆ readFiles()

void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.readFiles ( @NotNull final ProjectSettings  projectSettings,
@NotNull final ErrorView  errorView 
)

Reads the resources from individual files.

Parameters
projectSettingsthe project settings to read from
errorViewthe error view for reporting problems

Definition at line 88 of file AbstractResources.java.

◆ readFilesInt()

abstract void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.readFilesInt ( @NotNull ProjectSettings  projectSettings,
@NotNull ErrorView  errorView,
@NotNull List< G >  invObjects 
)
abstractprotected

Reads the resources from individual files.

Parameters
projectSettingsthe project settings to read from
errorViewthe error view for reporting problems
invObjectsall read archetypes

Referenced by net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.readFiles(), and net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.writeCollected().

+ Here is the caller graph for this function:

◆ writeCollected()

void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.writeCollected ( @NotNull final Progress  progress,
@NotNull final File  collectedDirectory 
) throws IOException

Writes the resources in collected form.

Parameters
progressthe progress to use
collectedDirectorythe collected directory to write to
Exceptions
IOExceptionif collection fails
IllegalStateExceptionif returns
false

Definition at line 131 of file AbstractResources.java.

Referenced by net.sf.gridarta.commands.Collector.run().

+ Here is the caller graph for this function:

◆ writeCollectedInt()

abstract void net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.writeCollectedInt ( @NotNull Progress  progress,
@NotNull File  collectedDirectory 
) throws IOException
abstractprotected

Writes the resources in collected form.

Parameters
progressthe progress to use
collectedDirectorythe collected directory to write to
Exceptions
IOExceptionif collection fails

Referenced by net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.writeCollected().

+ Here is the caller graph for this function:

Member Data Documentation

◆ archetypeSet

final ArchetypeSet<G, A, R> net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.archetypeSet
private

◆ gameObjectParser

final GameObjectParser<G, A, R> net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.gameObjectParser
private

◆ loaded

boolean net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.loaded
private

Whether the resources have been loaded.

Definition at line 57 of file AbstractResources.java.

◆ loadedFromFiles

boolean net.sf.gridarta.model.resource.AbstractResources< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.loadedFromFiles
private

Whether the resources have been loaded from individual files.

Definition at line 62 of file AbstractResources.java.

Referenced by net.sf.gridarta.model.resource.AbstractResources<?, ?, ?>.canWriteCollected().


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