Package VASSAL.build.module.metadata

Class SaveMetaData

java.lang.Object

VASSAL.build.module.metadata.AbstractMetaData

VASSAL.build.module.metadata.SaveMetaData

public class SaveMetaData
extends AbstractMetaData

Class representing the metadata for a Save Game/Log File. Details about the module this saved game was created with are saved in a separate module data file in the saved game zip.

Since:

3.1.0

Author:

Brent Easton

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_VERSION
protected ModuleMetaData	moduleData
static String	PROMPT_LOG_COMMENT
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
SaveMetaData()
SaveMetaData(ZipFile zip)

Method Summary

Modifier and Type	Method	Description
protected void	addElements(Document doc, Element root)	Add Elements specific to SaveMetaData
String	getMetaDataVersion()	Return the version of the metadata structure
ModuleMetaData	getModuleData()
String	getModuleName()
String	getModuleVersion()
String	getZipEntryName()	Return the Entry name for the metadata file
void	read(ZipFile zip)	Read and validate a Saved Game/Log file.
void	save(FileArchive archive)	Write Save Game metadata to the specified Archive
void	save(ZipWriter zw)

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

copyModuleMetadata, copyModuleMetadata, copyModuleMetadata, formatLastSaved, getDescription, getLastSaved, getLocalizedDescription, getVassalVersion, getVersion, 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

PROMPT_LOG_COMMENT

public static final String PROMPT_LOG_COMMENT

See Also:

Constant Field Values

moduleData

protected ModuleMetaData moduleData

Constructor Details

SaveMetaData

public SaveMetaData()

SaveMetaData

public SaveMetaData(ZipFile zip)

Method Details

getModuleName

public String getModuleName()

getModuleVersion

public String getModuleVersion()

getModuleData

public ModuleMetaData getModuleData()

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

save

public void save(FileArchive archive)
          throws IOException

Write Save Game metadata to the specified Archive

Overrides:

save in class AbstractMetaData

Parameters:

archive - Save game Archive

Throws:

IOException - If anything goes wrong

save

public void save(ZipWriter zw)
          throws IOException

Overrides:

save in class AbstractMetaData

Throws:

IOException

addElements

protected void addElements(Document doc,
Element root)

Add Elements specific to SaveMetaData

Specified by:

addElements in class AbstractMetaData

Parameters:

doc - Document

root - Root element

read

public void read(ZipFile zip)

Read and validate a Saved Game/Log file. Check that it has a Zip Entry named saved game. If it has a metadata file, read and parse it. Closes the ZipFile

Parameters:

zip - Saved Game File