net.sf.gridarta.var.atrinik.model.io

Class ArchetypeParser

java.lang.Object

net.sf.gridarta.model.io.AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

net.sf.gridarta.var.atrinik.model.io.ArchetypeParser

All Implemented Interfaces:

ArchetypeParser<GameObject,MapArchObject,Archetype>

public class ArchetypeParser
extends AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Handles the parsing of arches. It is a class separated from ArchetypeSet because it is also involved in loading arches in map files.

Field Summary

Fields inherited from interface net.sf.gridarta.model.io.ArchetypeParser

START_ARCH_NAME

Constructor Summary

Constructors

Constructor and Description
ArchetypeParser(@NotNull GameObjectParser<GameObject,MapArchObject,Archetype> gameObjectParser, @NotNull AnimationObjects animationObjects, @NotNull ArchetypeSet<GameObject,MapArchObject,Archetype> archetypeSet, @NotNull GameObjectFactory<GameObject,MapArchObject,Archetype> gameObjectFactory, @NotNull MultiPositionData multiPositionData) Creates an ArchetypeParser.

Method Summary

Modifier and Type	Method and Description
protected boolean	addToPanel(boolean isInternPath, @NotNull java.lang.String editorFolder, @NotNull Archetype archetype) Returns whether an archetype should be added to the archetype chooser.
protected void	finishParseArchetype(@NotNull Archetype archetype) Called after all parts of an archetype have been processed.
protected void	finishParseArchetypePart(@Nullable Archetype firstArch, @NotNull Archetype archetype, @NotNull ErrorViewCollector errorViewCollector) Called after the "end" line of a part has been read.
protected void	initParseArchetype() Called when a new archetype starts.
protected boolean	isStartLine(@NotNull java.lang.String line) Returns whether a give input line denotes the start of a new archetype.
protected boolean	processLine(@NotNull java.io.BufferedReader in, @NotNull java.lang.String line, @NotNull java.lang.String line2, @NotNull DefaultArchetypeBuilder archetypeBuilder, @NotNull ErrorViewCollector errorViewCollector, @NotNull java.util.List<GameObject> invObjects) Called for each processed line.

Methods inherited from class net.sf.gridarta.model.io.AbstractArchetypeParser

parseArchetypeFromStream

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchetypeParser

public ArchetypeParser(@NotNull
                       @NotNull GameObjectParser<GameObject,MapArchObject,Archetype> gameObjectParser,
                       @NotNull
                       @NotNull AnimationObjects animationObjects,
                       @NotNull
                       @NotNull ArchetypeSet<GameObject,MapArchObject,Archetype> archetypeSet,
                       @NotNull
                       @NotNull GameObjectFactory<GameObject,MapArchObject,Archetype> gameObjectFactory,
                       @NotNull
                       @NotNull MultiPositionData multiPositionData)

Creates an ArchetypeParser.

Parameters:

gameObjectParser - the game object parser instance to use

animationObjects - the animation objects instance to use

archetypeSet - the archetype set

gameObjectFactory - the factory for creating game objects

multiPositionData - the multi position data to query for multi-part objects

Method Detail

initParseArchetype

protected void initParseArchetype()

Description copied from class: AbstractArchetypeParser

Called when a new archetype starts.

Specified by:

initParseArchetype in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

isStartLine

protected boolean isStartLine(@NotNull
                              @NotNull java.lang.String line)

Description copied from class: AbstractArchetypeParser

Returns whether a give input line denotes the start of a new archetype.

Specified by:

isStartLine in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Parameters:

line - the input line

Returns:

whether the line is a start line

processLine

protected boolean processLine(@NotNull
                              @NotNull java.io.BufferedReader in,
                              @NotNull
                              @NotNull java.lang.String line,
                              @NotNull
                              @NotNull java.lang.String line2,
                              @NotNull
                              @NotNull DefaultArchetypeBuilder archetypeBuilder,
                              @NotNull
                              @NotNull ErrorViewCollector errorViewCollector,
                              @NotNull
                              @NotNull java.util.List<GameObject> invObjects)
                       throws java.io.IOException

Description copied from class: AbstractArchetypeParser

Called for each processed line.

Specified by:

processLine in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Parameters:

in - the reader reading the archetype definition

line - the input line

line2 - the tripped input line

archetypeBuilder - the archetype builder for the current archetype

errorViewCollector - the error view collector for reporting errors

invObjects - the inventory objects of the current archetype

Returns:

whether the line has been consumed

Throws:

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

finishParseArchetypePart

protected void finishParseArchetypePart(@Nullable
                                        @Nullable Archetype firstArch,
                                        @NotNull
                                        @NotNull Archetype archetype,
                                        @NotNull
                                        @NotNull ErrorViewCollector errorViewCollector)

Description copied from class: AbstractArchetypeParser

Called after the "end" line of a part has been read.

Specified by:

finishParseArchetypePart in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Parameters:

firstArch - the head part or null if archetype is the head part

archetype - the tail part

errorViewCollector - the error view collector for reporting errors

finishParseArchetype

protected void finishParseArchetype(@NotNull
                                    @NotNull Archetype archetype)

Description copied from class: AbstractArchetypeParser

Called after all parts of an archetype have been processed.

Specified by:

finishParseArchetype in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Parameters:

archetype - the archetype

addToPanel

protected boolean addToPanel(boolean isInternPath,
                             @NotNull
                             @NotNull java.lang.String editorFolder,
                             @NotNull
                             @NotNull Archetype archetype)

Description copied from class: AbstractArchetypeParser

Returns whether an archetype should be added to the archetype chooser.

Specified by:

addToPanel in class AbstractArchetypeParser<GameObject,MapArchObject,Archetype,DefaultArchetypeBuilder>

Parameters:

isInternPath - whether the archetype's path contains "/intern/"

editorFolder - the editor_folder attribute

archetype - the archetype to add

Returns:

whether the archetype should be added