Package VASSAL.build.module.metadata

Class ExtensionMetaData

java.lang.Object

VASSAL.build.module.metadata.AbstractMetaData

VASSAL.build.module.metadata.ExtensionMetaData

public class ExtensionMetaData
extends AbstractMetaData

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_VERSION
protected ModuleMetaData	moduleData
protected boolean	universal
protected static String	UNIVERSAL_ATTR
protected static String	UNIVERSAL_ELEMENT
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, 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
ExtensionMetaData(ZipFile zip)	Read Extension metadata from specified zip archive
ExtensionMetaData(ModuleExtension ext)	Build an ExtensionMetaData for the given extension

Method Summary

Modifier and Type	Method	Description
protected void	addElements(Document doc, Element root)	Add elements specific to an ExtensionMetaData
String	getMetaDataVersion()	Return the version of the metadata structure
String	getModuleName()
String	getModuleVersion()
String	getZipEntryName()	Return the Entry name for the metatdata file
void	read(ZipFile zip)	Read and validate an Extension file.
void	save(ArchiveWriter archive)	Write Extension metadata to the specified Archive

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

copyModuleMetadata, copyModuleMetadata, getDescription, getLocalizedDescription, getVassalVersion, getVersion, save, save, setDescription, setDescription, 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

UNIVERSAL_ELEMENT

protected static final String UNIVERSAL_ELEMENT

See Also:

Constant Field Values

UNIVERSAL_ATTR

protected static final String UNIVERSAL_ATTR

See Also:

Constant Field Values

moduleData

protected ModuleMetaData moduleData

universal

protected boolean universal

Constructor Details

ExtensionMetaData

public ExtensionMetaData(ModuleExtension ext)

Build an ExtensionMetaData for the given extension

Parameters:

ext - Extension

ExtensionMetaData

public ExtensionMetaData(ZipFile zip)

Read Extension metadata from specified zip archive

Parameters:

zip - the archive

Method Details

getModuleName

public String getModuleName()

getModuleVersion

public String getModuleVersion()

getZipEntryName

public String getZipEntryName()

Description copied from class: AbstractMetaData

Return the Entry name for the metatdata 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

save

public void save(ArchiveWriter archive)
          throws IOException

Write Extension metadata to the specified Archive

Overrides:

save in class AbstractMetaData

Parameters:

archive - Save game Archive

Throws:

IOException - If anything goes wrong

addElements

protected void addElements(Document doc,
Element root)

Add elements specific to an ExtensionMetaData

Specified by:

addElements in class AbstractMetaData

Parameters:

doc - Document

root - Root element

read

public void read(ZipFile zip)

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

Parameters:

zip - Module File