Class SymbolSet

java.lang.Object

VASSAL.tools.imports.Importer

VASSAL.tools.imports.adc2.SymbolSet

public class SymbolSet
extends Importer

ADC2 game piece and terrain symbols.

Author:

Michael Kiefte

Field Summary

Fields inherited from class Importer

action, file

Modifier and Type	Field	Description
protected ImportAction	action
protected File	file

Constructor Summary

Constructors

Constructor	Description
SymbolSet()

Method Summary

Modifier and Type	Method	Description
Dimension	getMaxSize()
Dimension	getMaxSize(Dimension max)
Dimension	getModalSize()
boolean	isValidImportFile(File f)	Determine whether the file is valid for the given importer.
protected void	load(File f)	Read a symbol set from the specified file.
protected void	readPermutationFile(File f)	Read an SDX file if one exists.
void	writeToArchive()	Write all of the game pieces to the archive.

Methods inherited from class Importer

forceExtension, getExtension, getFileName, getLayeredPieceCollection, getMainMap, getUniqueImageFileName, getUniqueImageFileName, importFile, insertComponent, readNullTerminatedString, readNullTerminatedString, readWindowsFileName, stripExtension

Modifier and Type	Method	Description
static String	forceExtension(String s, String ext)	Strip the extension from a filename and replace with the given extension.
static String	getExtension(String s)	Get the extension from a file name.
static String	getFileName(String s)	Get the file name without the qualifying path.
protected LayeredPieceCollection	getLayeredPieceCollection()
protected Map	getMainMap()
static String	getUniqueImageFileName(String s)
static String	getUniqueImageFileName(String s, String ext)	Get a unique file name for an image in the game module archive.
void	importFile(ImportAction action, File f)	Two methods are needed to import a file.
protected static void	insertComponent(Buildable child, Buildable parent)
static String	readNullTerminatedString(InputStream in)	Return a null-terminated string from an input stream.
static String	readNullTerminatedString(InputStream in, int maxLen)	Read a null-terminated string from a file up to a maximum length which includes the null termination.
static String	readWindowsFileName(InputStream in)	Read a null-terminated string representing a Windows file name and convert Windows separator characters '\\' to the local separator character.
static String	stripExtension(String s)	Return a file name without the extension.

Methods inherited from class Object

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

Constructor Details

SymbolSet

public SymbolSet()

Method Details

getMaxSize

public Dimension getMaxSize(Dimension max)

getMaxSize

public Dimension getMaxSize()

getModalSize

public Dimension getModalSize()

Returns:

The most frequently occuring dimension for game pieces in this module.

load

protected void load(File f)
             throws IOException

Read a symbol set from the specified file.

Overrides:

load in class Importer

Parameters:

f - The base file to be imported.

Throws:

IOException - oops

readPermutationFile

protected void readPermutationFile(File f)
                            throws IOException

Read an SDX file if one exists. This is a list of image indeces starting with terrain separated by newlines. Only piece images are actually permuted.

Parameters:

f - - Set file.

Throws:

IOException

writeToArchive

public void writeToArchive()
                    throws IOException

Write all of the game pieces to the archive. Mainly for testing or if only the symbol set is imported.

Specified by:

writeToArchive in class Importer

Throws:

IOException - oops

isValidImportFile

public boolean isValidImportFile(File f)
                          throws IOException

Description copied from class: Importer

Determine whether the file is valid for the given importer.

Specified by:

isValidImportFile in class Importer

Parameters:

f - File

Returns:

true if f is a valid file for this type.

Throws:

IOException - oops