net.sf.gridarta.commands.Collector Class Reference

A Collector is capable of iterating over a collection of Collectables and collecting them in a separate. More...

Inheritance diagram for net.sf.gridarta.commands.Collector:

Collaboration diagram for net.sf.gridarta.commands.Collector:

Public Member Functions
	Collector (@NotNull final Progress progress, @NotNull final AbstractResources<?, ?, ?> resources, @NotNull final File collectedDirectory)
	Create a Collector. More...
void	run ()
void	start ()
	Starts collecting. More...
void	waitUntilFinished () throws InterruptedException
	Waits until collection has finished. More...

Private Attributes
final File	collectedDirectory
	The destination directory to write files to. More...
final Progress	progress
	The Progress to use. More...
final AbstractResources<?, ?, ?>	resources
	The Collectables. More...
Thread	thread
	The worker thread. More...

Static Private Attributes
static final ActionBuilder	ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
	Action Builder. More...

Detailed Description

A Collector is capable of iterating over a collection of Collectables and collecting them in a separate.

Thread 

with a nice GUI.

Author

Christian Hujer

Definition at line 37 of file Collector.java.

Constructor & Destructor Documentation

Collector()

net.sf.gridarta.commands.Collector.Collector	(	@NotNull final Progress	progress,
		@NotNull final AbstractResources<?, ?, ?>	resources,
		@NotNull final File	collectedDirectory
	)

Create a Collector.

Parameters

progress	the progress to use
resources	the resources to collect
collectedDirectory	the destination directory to write files to

Definition at line 75 of file Collector.java.

References net.sf.gridarta.commands.Collector.collectedDirectory, net.sf.gridarta.commands.Collector.progress, and net.sf.gridarta.commands.Collector.resources.

Member Function Documentation

run()

void net.sf.gridarta.commands.Collector.run

(

)

Definition at line 112 of file Collector.java.

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

Here is the call graph for this function:

start()

void net.sf.gridarta.commands.Collector.start

(

)

Starts collecting.

Definition at line 87 of file Collector.java.

Referenced by net.sf.gridarta.action.CollectArchesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCollectArches(), and net.sf.gridarta.commands.CollectArchesCommand.execute().

Here is the caller graph for this function:

waitUntilFinished()

void net.sf.gridarta.commands.Collector.waitUntilFinished

(

)

throws InterruptedException

Waits until collection has finished.

Exceptions

InterruptedException

if waiting was interrupted

Definition at line 96 of file Collector.java.

Referenced by net.sf.gridarta.commands.CollectArchesCommand.execute(), and net.sf.gridarta.action.CollectArchesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newExiterListener().

Here is the caller graph for this function:

Member Data Documentation

ACTION_BUILDER

final ActionBuilder net.sf.gridarta.commands.Collector.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")

staticprivate

Action Builder.

Definition at line 43 of file Collector.java.

collectedDirectory

final File net.sf.gridarta.commands.Collector.collectedDirectory

private

The destination directory to write files to.

Definition at line 55 of file Collector.java.

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

progress

final Progress net.sf.gridarta.commands.Collector.progress

private

The Progress to use.

Definition at line 61 of file Collector.java.

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

resources

final AbstractResources<?, ?, ?> net.sf.gridarta.commands.Collector.resources

private

The Collectables.

Definition at line 49 of file Collector.java.

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

thread

Thread net.sf.gridarta.commands.Collector.thread

private

The worker thread.

Definition at line 67 of file Collector.java.

---

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

• gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/commands/Collector.java