Class ModuleMetaData

java.lang.Object

VASSAL.build.module.metadata.AbstractMetaData

VASSAL.build.module.metadata.ModuleMetaData

public class ModuleMetaData
extends AbstractMetaData

Class representing the metadata for a Module or an Extension. Modules and extensions can't be differentiated until either the metadata or the buildfile is parsed, so they share the same metadata structure.

Since:

3.1.0

Author:

Brent Easton

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_VERSION
protected VASSAL.build.module.metadata.AbstractMetaData.Attribute	nameAttr
static final String	ZIP_ENTRY_NAME

Fields inherited from class AbstractMetaData

BUG_11929_VASSAL_FIX_VERSION, BUILDFILE_EXTENSION_ELEMENT, BUILDFILE_MODULE_ELEMENT1, BUILDFILE_MODULE_ELEMENT2, CHECKSUM_ELEMENT, DATE_SAVED_ELEMENT, DESCRIPTION_ATTR, DESCRIPTION_ELEMENT, descriptionAttr, EXTENSION_ATTR, extra1, EXTRA1_ELEMENT, extra2, EXTRA2_ELEMENT, FALSE, LANG_ATTR, lastSaved, MODULE_NAME_ATTR, MODULE_NAME_ELEMENT, MODULE_VERSION_ATTR, MODULE_VERSION_ELEMENT, NAME_ATTR, NAME_ELEMENT, parser, ROOT_ELEMENT, TRUE, VASSAL_VERSION_ATTR, VASSAL_VERSION_ELEMENT, vassalVersion, version, VERSION_ATTR, VERSION_ELEMENT

Modifier and Type	Field	Description
protected static final String	BUG_11929_VASSAL_FIX_VERSION
protected static final String	BUILDFILE_EXTENSION_ELEMENT
protected static final String	BUILDFILE_MODULE_ELEMENT1
protected static final String	BUILDFILE_MODULE_ELEMENT2
protected static final String	CHECKSUM_ELEMENT
protected static final String	DATE_SAVED_ELEMENT
protected static final String	DESCRIPTION_ATTR
protected static final String	DESCRIPTION_ELEMENT
protected VASSAL.build.module.metadata.AbstractMetaData.Attribute	descriptionAttr
protected static final String	EXTENSION_ATTR
protected String	extra1
protected static final String	EXTRA1_ELEMENT
protected String	extra2
protected static final String	EXTRA2_ELEMENT
protected static final String	FALSE
protected static final String	LANG_ATTR
protected String	lastSaved
protected static final String	MODULE_NAME_ATTR
protected static final String	MODULE_NAME_ELEMENT
protected static final String	MODULE_VERSION_ATTR
protected static final String	MODULE_VERSION_ELEMENT
protected static final String	NAME_ATTR
protected static final String	NAME_ELEMENT
protected static final XMLReader	parser	This is the shared parser for all subclasses of AbstractMetaData.
protected static final String	ROOT_ELEMENT
protected static final String	TRUE
protected static final String	VASSAL_VERSION_ATTR
protected static final String	VASSAL_VERSION_ELEMENT
protected String	vassalVersion
protected String	version
protected static final String	VERSION_ATTR
protected static final String	VERSION_ELEMENT

Constructor Summary

Constructors

Constructor	Description
ModuleMetaData(String name, String version)
ModuleMetaData(ZipFile zip)
ModuleMetaData(GameModule module)

Method Summary

Modifier and Type	Method	Description
protected void	addElements(Document doc, Element root)	Add elements specific to a ModuleMetaData
String	getLocalizedName()
String	getMetaDataVersion()	Return the version of the metadata structure
String	getName()
String	getZipEntryName()	Return the Entry name for the metadata file
void	read(ZipFile zip)	Read and validate a Module file

Methods inherited from class AbstractMetaData

copyModuleMetadata, copyModuleMetadata, copyModuleMetadata, formatLastSaved, getDescription, getExtra1, getExtra2, getLastSaved, getLocalizedDescription, getVassalVersion, getVersion, isPreBug11929, save, save, save, save, setDescription, setDescription, setExtra1, setExtra2, setLastSaved, setVassalVersion, setVersion

Modifier and Type	Method	Description
void	copyModuleMetadata(ArchiveWriter archive)	Copy the Module metadata from the current module into the specified archive.
void	copyModuleMetadata(FileArchive archive)
void	copyModuleMetadata(ZipWriter zw)
String	formatLastSaved()
String	getDescription()
String	getExtra1()
String	getExtra2()
String	getLastSaved()
String	getLocalizedDescription()
String	getVassalVersion()
String	getVersion()
static boolean	isPreBug11929(String version)
protected void	save(OutputStream out)
void	save(ArchiveWriter archive)	Write common metadata to the specified Archive.
void	save(FileArchive archive)
void	save(ZipWriter zw)
void	setDescription(String desc)
void	setDescription(VASSAL.build.module.metadata.AbstractMetaData.Attribute desc)
void	setExtra1(String s)
void	setExtra2(String s)
void	setLastSaved(String lastSaved)
void	setVassalVersion(String s)
void	setVersion(String s)

Methods inherited from class Object

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

Field Details

ZIP_ENTRY_NAME

public static final String ZIP_ENTRY_NAME

See Also:

• Constant Field Values

DATA_VERSION

public static final String DATA_VERSION

See Also:

• Constant Field Values

nameAttr

protected VASSAL.build.module.metadata.AbstractMetaData.Attribute nameAttr

Constructor Details

ModuleMetaData

public ModuleMetaData(ZipFile zip)

ModuleMetaData

public ModuleMetaData(GameModule module)

ModuleMetaData

public ModuleMetaData(String name,
 String version)

Method Details

getName

public String getName()

getLocalizedName

public String getLocalizedName()

getZipEntryName

public String getZipEntryName()

Description copied from class: AbstractMetaData

Return the Entry name for the metadata file

Specified by:

getZipEntryName in class AbstractMetaData

Returns:

Zip Entry name

getMetaDataVersion

public String getMetaDataVersion()

Description copied from class: AbstractMetaData

Return the version of the metadata structure

Specified by:

getMetaDataVersion in class AbstractMetaData

Returns:

version

addElements

protected void addElements(Document doc,
 Element root)

Add elements specific to a ModuleMetaData

Specified by:

addElements in class AbstractMetaData

Parameters:

doc - Document

root - Root element

read

public void read(ZipFile zip)

Read and validate a Module file. - Check it has a Zip Entry named buildfile - If it has a metadata file, read and parse it. Closes the ZipFile.

Parameters:

zip - Module File