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 final String	DATA_VERSION
protected ModuleMetaData	moduleData
static final String	PROMPT_LOG_COMMENT
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
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 AbstractMetaData

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

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