Package VASSAL.tools

Class ArchiveWriter

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

VASSAL.tools.DataArchive

VASSAL.tools.ArchiveWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class ArchiveWriter
extends DataArchive

An ArchiveWriter is a writeable DataArchive. New files may be added with the addFile(java.lang.String, java.lang.String) and addImage(java.lang.String, java.lang.String) methods. save() and saveAs() will cause the archive to be written out, with FileChooser invoked if appropriate.

Field Summary

Fields inherited from class VASSAL.tools.DataArchive

archive, cachedLocalImages, extensions, ICON_DIR, IMAGE_DIR, imageDir, imageNames, localImages, SOUND_DIR, soundDir, SOUNDS_DIR, soundsDir

Constructor Summary

Constructors

Constructor	Description
ArchiveWriter(String zipName)	Create a new writeable archive.
ArchiveWriter(String zipName, String defaultExtension)	Create a new writeable archive.
ArchiveWriter(ZipFile archive)	Deprecated, for removal: This API element is subject to removal in a future version.
ArchiveWriter(FileArchive archive)
ArchiveWriter(FileArchive archive, String defaultExtension)

Method Summary

Modifier and Type	Method	Description
void	addFile(String fileName, byte[] content)	Copy am array of bytes into the archive
void	addFile(String fileName, InputStream in)	Copy an InputStream into the archive
void	addFile(String path, String fileName)	Copy a file from the user's filesystem to the archive.
void	addImage(String name, byte[] contents)
void	addImage(String path, String name)	Add an image file to the archive.
void	addSound(String path, String fileName)
boolean	isImageAdded(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
void	removeFile(String name)	Removes a file in the archive
void	removeImage(String name)
void	save()
void	save(boolean notifyModuleManager)
void	saveAs()
void	saveAs(boolean notifyModuleManager)
boolean	saveAsButVerify()	Saves the archive, always prompting for a new filename.
boolean	saveAsButVerify(boolean notifyModuleManager)	Saves the archive, always prompting for a new filename.
boolean	saveButVerify()	Saves the archive, prompting for a name only if none has ever been provided.
boolean	saveButVerify(boolean notifyModuleManager)	Saves the archive, prompting for a name only if none has ever been provided.
void	write()	Deprecated, for removal: This API element is subject to removal in a future version.
void	write(boolean notifyModuleManager)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	write(FileArchive fa, boolean notifyModuleManager)	Writes the file archive.

Methods inherited from class VASSAL.tools.DataArchive

addExtension, addImageSource, buildLocalizedDirectoryList, clearScaledImageCache, clearTransformedImageCache, close, contains, findClass, findImage, findImage, getAllLocalImageNames, getAllLocalImageNamesForDirectory, getArchive, getArchiveURL, getBytes, getCachedAudioClip, getCachedImage, getFileStream, getFileStream, getFileStream, getImage, getImage, getImageBounds, getImageInputStream, getImageNames, getImageNameSet, getImageNameSet, getImageNamesRecursively, getImageNamesRecursively, getImagePrefix, getImageSize, getImageURL, getInputStream, getLocalImageNames, getName, getPermissions, getScaledImage, getScaledImage, getTransformedImage, getTransformedImage, getURL, getURL, getWriter, improvedScaling, isNameCacheStale, listImageNames, loadClass, removeImageSource, setOfImageNames, unCacheImage, unCacheImage

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findResource, findResources, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getPackage, getPackages, getParent, getPlatformClassLoader, getResource, getResourceAsStream, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveWriter

public ArchiveWriter(String zipName,
 String defaultExtension)

Create a new writeable archive.

Parameters:

zipName - the name of the archive. If null, the user will be prompted for a filename when saving. If not null, new entries will be added to the named archive. If the file exists and is not a zip archive, it will be overwritten.

defaultExtension - the default file extension for the archive. If non-null, and the user needs to be prompted for a filename, this will be the default file extension added automatically.

ArchiveWriter

public ArchiveWriter(FileArchive archive,
 String defaultExtension)

ArchiveWriter

public ArchiveWriter(String zipName)

Create a new writeable archive.

Parameters:

zipName - the name of the archive. If null, the user will be prompted for a filename when saving. If not null, new entries will be added to the named archive. If the file exists and is not a zip archive, it will be overwritten.

ArchiveWriter

public ArchiveWriter(FileArchive archive)

ArchiveWriter

@Deprecated(since="2020-08-06",
            forRemoval=true)
public ArchiveWriter(ZipFile archive)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

addImage

public void addImage(String path,
 String name)

Add an image file to the archive. The file will be copied into an "images" directory in the archive. Storing another image with the same name will overwrite the previous image.

Parameters:

path - the full path of the image file on the user's filesystem

name - the name under which to store the image in the archive

addImage

public void addImage(String name,
 byte[] contents)

addSound

public void addSound(String path,
 String fileName)

isImageAdded

@Deprecated(since="2020-08-06",
            forRemoval=true)
public boolean isImageAdded(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

removeImage

public void removeImage(String name)

removeFile

public void removeFile(String name)

Removes a file in the archive

Parameters:

name - file in the archive to be removed

addFile

public void addFile(String path,
 String fileName)

Copy a file from the user's filesystem to the archive.

Parameters:

path - the full path of the file on the user's filesystem

fileName - the name under which to store the file in the archive

addFile

public void addFile(String fileName,
 InputStream in)

Copy an InputStream into the archive

Parameters:

fileName - the name under which to store the contents of the stream

in - the stream to copy

addFile

public void addFile(String fileName,
 byte[] content)

Copy am array of bytes into the archive

Parameters:

fileName - the name under which to store the contents of the stream

content - array of bytes to copy

save

public void save()
          throws IOException

Throws:

IOException

save

public void save(boolean notifyModuleManager)
          throws IOException

Throws:

IOException

saveAs

public void saveAs()
            throws IOException

Throws:

IOException

saveAs

public void saveAs(boolean notifyModuleManager)
            throws IOException

Throws:

IOException

saveButVerify

public boolean saveButVerify()
                      throws IOException

Saves the archive, prompting for a name only if none has ever been provided.

Throws:

IOException - IOException

saveButVerify

public boolean saveButVerify(boolean notifyModuleManager)
                      throws IOException

Saves the archive, prompting for a name only if none has ever been provided.

Parameters:

notifyModuleManager - If true, notifies Module Manager that the save has occurred

Throws:

IOException - IOException

saveAsButVerify

public boolean saveAsButVerify()
                        throws IOException

Saves the archive, always prompting for a new filename.

Throws:

IOException - IOException

write

protected void write(FileArchive fa,
 boolean notifyModuleManager)
              throws IOException

Writes the file archive.

Parameters:

fa - File archive

notifyModuleManager - if true, notifies the module manager that a file has been saved.

Throws:

IOException - IOException

saveAsButVerify

public boolean saveAsButVerify(boolean notifyModuleManager)
                        throws IOException

Saves the archive, always prompting for a new filename. If a defaultExtension has been provided, it will be added to the filename unless the user specifies a different one explicitly.

Parameters:

notifyModuleManager - If true, notifies Module Manager that the save has occurred

Returns:

true if operation proceeded, false if it was cancelled by user at file chooser or confirmation dialog

Throws:

IOException - IOException

write

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void write()
           throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

If the ArchiveWriter was initialized with non-null file name, then write the contents of the archive to the named archive. If it was initialized with a null name, prompt the user to select a new file into which to write archive.

Throws:

IOException

write

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void write(boolean notifyModuleManager)
           throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException