Package net.sf.gridarta.model.resource

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

java.lang.Object

net.sf.gridarta.model.resource.AbstractResourcesReader<G>

net.sf.gridarta.model.resource.AbstractFilesResourcesReader<G,A,R>

Direct Known Subclasses:

FilesResourcesReader, FilesResourcesReader, FilesResourcesReader

public abstract class AbstractFilesResourcesReader<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends AbstractResourcesReader<G>

Abstract base class for AbstractResourcesReaders that read from individual files.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFilesResourcesReader(@NotNull java.io.File archDirectory, @NotNull ArchetypeSet<G,A,R> archetypeSet, @NotNull AbstractArchetypeParser<G,A,R,?> archetypeParser, @NotNull ArchFaceProvider archFaceProvider, @NotNull java.io.File collectedDirectory, @Nullable java.lang.String imageSet, @NotNull AnimationObjects animationObjects, @NotNull FaceObjects faceObjects, @NotNull AbstractAnimationObjectsReader animationObjectsReader)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	isValidEntry(int folderLevel, java.lang.String name)	Returns whether a file name should be processed.
@NotNull FaceProvider	read(@NotNull ErrorView errorView, @NotNull java.util.List<G> invObjects)	Reads the resources.

Methods inherited from class net.sf.gridarta.model.resource.AbstractResourcesReader

addPNGFace, loadAnimationsFromCollect, loadAnimTree

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilesResourcesReader

protected AbstractFilesResourcesReader(@NotNull
                                       @NotNull java.io.File archDirectory,
                                       @NotNull
                                       @NotNull ArchetypeSet<G,A,R> archetypeSet,
                                       @NotNull
                                       @NotNull AbstractArchetypeParser<G,A,R,?> archetypeParser,
                                       @NotNull
                                       @NotNull ArchFaceProvider archFaceProvider,
                                       @NotNull
                                       @NotNull java.io.File collectedDirectory,
                                       @Nullable
                                       @Nullable java.lang.String imageSet,
                                       @NotNull
                                       @NotNull AnimationObjects animationObjects,
                                       @NotNull
                                       @NotNull FaceObjects faceObjects,
                                       @NotNull
                                       @NotNull AbstractAnimationObjectsReader animationObjectsReader)

Creates a new instance.

Parameters:

archDirectory - the "arch" directory to read

archetypeSet - the archetype set to update

archetypeParser - the archetype parser to use

archFaceProvider - the arch face provider to use

collectedDirectory - the collected directory

imageSet - the active image set or null

animationObjects - the animation objects instance

faceObjects - the face objects instance

animationObjectsReader - the animation objects reader instance to use

Method Detail

read

@NotNull
public @NotNull FaceProvider read(@NotNull
                                  @NotNull ErrorView errorView,
                                  @NotNull
                                  @NotNull java.util.List<G> invObjects)

Description copied from class: AbstractResourcesReader

Reads the resources.

Specified by:

read in class AbstractResourcesReader<G extends GameObject<G,A,R>>

Parameters:

errorView - the error view for reporting problems

invObjects - all read archetypes are added to this list

Returns:

the face provider for accessing the read faces

isValidEntry

protected abstract boolean isValidEntry(int folderLevel,
                                        java.lang.String name)

Returns whether a file name should be processed.

Parameters:

folderLevel - the folder level

name - the base name of the file name

Returns:

whether the entry is valid and should be processed