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.

Field Summary

Fields inherited from class VASSAL.tools.DataArchive
archive, 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(ZipFile archive)`	Deprecated.
`ArchiveWriter(FileArchive archive)`

Method Summary

Modifier and Type	Method	Description
`void`	`addFile(String fileName, byte[] content)`
`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.
`void`	`removeImage(String name)`
`void`	`save()`
`void`	`save(boolean notifyModuleManager)`
`void`	`saveAs()`
`void`	`saveAs(boolean notifyModuleManager)`
`void`	`write()`	Deprecated.
`void`	`write(boolean notifyModuleManager)`	Deprecated.
`protected void`	`write(FileArchive fa, boolean notifyModuleManager)`

Methods inherited from class VASSAL.tools.DataArchive

addExtension, clearScaledImageCache, clearTransformedImageCache, close, contains, findClass, findImage, findImage, getArchive, getArchiveURL, getBytes, getCachedAudioClip, getCachedImage, getFileStream, getFileStream, getFileStream, getImage, getImage, getImageBounds, getImageInputStream, getImageNames, getImageNameSet, getImageNamesRecursively, getImagePrefix, getImageSize, getImageURL, getInputStream, getLocalImageNames, getName, getPermissions, getScaledImage, getScaledImage, getTransformedImage, getTransformedImage, getURL, getURL, getWriter, improvedScaling, isNameCacheStale, listImageNames, loadClass, 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)
  
  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 public ArchiveWriter(ZipFile archive)
  
  Deprecated.
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 public boolean isImageAdded(String name)
  
  Deprecated.
- removeImage
  
  public void removeImage(String name)
- 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)
- 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
- write
  
  protected void write(FileArchive fa, boolean notifyModuleManager) throws IOException
  
  Throws:
  
  IOException
- saveAs
  
  public void saveAs(boolean notifyModuleManager) throws IOException
  
  Throws:
  
  IOException
- write
  
  @Deprecated public void write() throws IOException
  
  Deprecated.
  
  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 public void write(boolean notifyModuleManager) throws IOException
  
  Deprecated.
  
  Throws:
  
  IOException

Class ArchiveWriter

Field Summary

Fields inherited from class VASSAL.tools.DataArchive