Package net.mtrop.doom.text

Class HexenMapInfo

java.lang.Object

net.mtrop.doom.text.HexenMapInfo

All Implemented Interfaces:

TextObject

public class HexenMapInfo
extends Object
implements TextObject

Parser for Hexen-style MAPINFO data (also called "old MAPINFO" in ZDoom). This parser provides a means for scanning through a MAPINFO definition, line by line, tokenized, as its data is procedural and not serializable. All data is buffered into memory on read through readText(Reader).

Since:

2.19.0

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface net.mtrop.doom.object.TextObject

TextObject.ParseException, TextObject.Reflect, TextObject.Transformer<TO extends TextObject>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SETTYPE_ADDDEFAULTMAP
static final String	SETTYPE_CLEAREPISODES
static final String	SETTYPE_CLEARSKILLS
static final String	SETTYPE_CLUSTERDEF
static final String	SETTYPE_DEFAULTMAP
static final String	SETTYPE_EPISODE
static final String	SETTYPE_GAMEDEFAULTS
static final String	SETTYPE_MAP
static final String	SETTYPE_SKILL

Constructor Summary

Constructors

Constructor	Description
HexenMapInfo()	Creates a blank Hexen MAPINFO parser that reads from a blank definition.
HexenMapInfo(CharSequence sequence)	Creates a Hexen MAPINFO parser that reads from text.

Method Summary

Modifier and Type	Method	Description
StringBuilder	getBuilder()	Gets the underlying StringBuilder for this info parser.
String[]	nextTokens()	Parses the next significant line in the MAPINFO and returns it as a set of tokens.
void	readText(Reader reader)	Reads from an Reader and sets this object's fields.
void	refreshParser()	Refreshes the internal parser if changes were made to the internal text.
String[]	scanTo(String property)	Scans the MAPINFO to the next property and returns its line, tokenized.
void	writeText(Writer writer)	Writes this object to a Writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mtrop.doom.object.TextObject

fromText, readFile, readFile, toText, writeFile, writeFile, writeFile, writeFile

Field Details

SETTYPE_CLEAREPISODES

public static final String SETTYPE_CLEAREPISODES

See Also:

• Constant Field Values

SETTYPE_EPISODE

public static final String SETTYPE_EPISODE

See Also:

• Constant Field Values

SETTYPE_MAP

public static final String SETTYPE_MAP

See Also:

• Constant Field Values

SETTYPE_DEFAULTMAP

public static final String SETTYPE_DEFAULTMAP

See Also:

• Constant Field Values

SETTYPE_ADDDEFAULTMAP

public static final String SETTYPE_ADDDEFAULTMAP

See Also:

• Constant Field Values

SETTYPE_GAMEDEFAULTS

public static final String SETTYPE_GAMEDEFAULTS

See Also:

• Constant Field Values

SETTYPE_CLUSTERDEF

public static final String SETTYPE_CLUSTERDEF

See Also:

• Constant Field Values

SETTYPE_CLEARSKILLS

public static final String SETTYPE_CLEARSKILLS

See Also:

• Constant Field Values

SETTYPE_SKILL

public static final String SETTYPE_SKILL

See Also:

• Constant Field Values

Constructor Details

HexenMapInfo

public HexenMapInfo()

Creates a blank Hexen MAPINFO parser that reads from a blank definition. You should probably use readText(Reader) or TextObject.readFile(java.io.File) to construct this.

HexenMapInfo

public HexenMapInfo(CharSequence sequence)

Creates a Hexen MAPINFO parser that reads from text.

Parameters:

sequence - the MAPINFO data to read.

Method Details

getBuilder

public StringBuilder getBuilder()

Gets the underlying StringBuilder for this info parser. If the data is changed, call refreshParser() to reset the parser.

Returns:

a reference to the underlying builder.

refreshParser

public void refreshParser()

Refreshes the internal parser if changes were made to the internal text.

nextTokens

public String[] nextTokens()
                    throws TextObject.ParseException

Parses the next significant line in the MAPINFO and returns it as a set of tokens.

Returns:

the set of tokens as a string array, or null if end of MAPINFO.

Throws:

TextObject.ParseException - if a parse error occurs during read.

scanTo

public String[] scanTo(String property)
                throws TextObject.ParseException

Scans the MAPINFO to the next property and returns its line, tokenized.

Parameters:

property - the property to scan to, case-insensitive check.

Returns:

the set of tokens as a string array, or null if end of MAPINFO.

Throws:

TextObject.ParseException - if a parse error occurs during read.

readText

public void readText(Reader reader)
              throws IOException

Description copied from interface: TextObject

Reads from an Reader and sets this object's fields.

Specified by:

readText in interface TextObject

Parameters:

reader - the Reader to read from.

Throws:

IOException - if a read error occurs.

writeText

public void writeText(Writer writer)
               throws IOException

Description copied from interface: TextObject

Writes this object to a Writer.

Specified by:

writeText in interface TextObject

Parameters:

writer - the Writer to write to.

Throws:

IOException - if a write error occurs.