net.sf.gridarta.model.collectable

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

java.lang.Object

net.sf.gridarta.model.collectable.AbstractArchetypeSetCollectable<G,A,R>

All Implemented Interfaces:

Collectable

Direct Known Subclasses:

AtrinikArchetypeSetCollectable, CrossfireArchetypeSetCollectable, DaimoninArchetypeSetCollectable

public abstract class AbstractArchetypeSetCollectable<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements Collectable

Abstract base class for Collectables that create the "archetypes" file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArchetypeSetCollectable(@NotNull ArchetypeSet<G,A,R> archetypeSet, @NotNull java.lang.String archFile) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	collect(@NotNull net.sf.japi.swing.misc.Progress progress, @NotNull java.io.File collectedDirectory) Collects information.
protected abstract int	collectArchetype(R archetype, @NotNull java.io.Writer out) Collects an Archetype: writes its definition into a writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArchetypeSetCollectable

protected AbstractArchetypeSetCollectable(@NotNull
                                          @NotNull ArchetypeSet<G,A,R> archetypeSet,
                                          @NotNull
                                          @NotNull java.lang.String archFile)

Creates a new instance.

Parameters:

archetypeSet - the archetype set to collect

archFile - the collected archetypes file name

Method Detail

collect

public void collect(@NotNull
                    @NotNull net.sf.japi.swing.misc.Progress progress,
                    @NotNull
                    @NotNull java.io.File collectedDirectory)
             throws java.io.IOException

Description copied from interface: Collectable

Collects information.

Specified by:

collect in interface Collectable

Parameters:

progress - the progress to report progress to

collectedDirectory - the destination directory to collect data to

Throws:

java.io.IOException - in case of I/O problems during collection

collectArchetype

protected abstract int collectArchetype(@NotNull
                                        R archetype,
                                        @NotNull
                                        @NotNull java.io.Writer out)
                                 throws java.io.IOException

Collects an Archetype: writes its definition into a writer.

Parameters:

archetype - the archetype

out - the writer

Returns:

the number of archetype parts written

Throws:

java.io.IOException - if an I/O error occurs