Package VASSAL.build.module.metadata

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 String	DATA_VERSION
protected VASSAL.build.module.metadata.AbstractMetaData.Attribute	nameAttr
static String	ZIP_ENTRY_NAME

Fields inherited from class VASSAL.build.module.metadata.AbstractMetaData

BUILDFILE_EXTENSION_ELEMENT, BUILDFILE_MODULE_ELEMENT1, BUILDFILE_MODULE_ELEMENT2, DATE_SAVED_ELEMENT, DESCRIPTION_ATTR, DESCRIPTION_ELEMENT, descriptionAttr, EXTENSION_ATTR, 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

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 VASSAL.build.module.metadata.AbstractMetaData

copyModuleMetadata, copyModuleMetadata, copyModuleMetadata, formatLastSaved, getDescription, getLastSaved, getLocalizedDescription, getVassalVersion, getVersion, save, save, save, save, setDescription, setDescription, setLastSaved, setVassalVersion, setVersion

Methods inherited from class java.lang.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