Class DataArchive

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

VASSAL.tools.DataArchive

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ArchiveWriter, JarArchive

public class DataArchive
extends SecureClassLoader
implements Closeable

Wrapper around a Zip archive with methods to cache images

Field Summary

Fields

Modifier and Type	Field	Description
protected FileArchive	archive
protected SortedSet<String>[]	cachedLocalImages
protected List<DataArchive>	extensions
static final String	ICON_DIR
static final String	IMAGE_DIR
protected String	imageDir
protected SortedSet<String>	localImages
static final String	SOUND_DIR
protected String	soundDir

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataArchive()
	DataArchive(String zipName)
	DataArchive(String zipName, String imageDir)

Method Summary

Modifier and Type	Method	Description
void	addExtension(DataArchive ext)	DataArchives can extend other archives.
protected void	buildLocalizedDirectoryList(List<String> list)
void	close()
boolean	contains(String fileName)
boolean	contains(String fileName, boolean checkExtensions)
protected Class<?>	findClass(String name)
protected SortedSet<String>	getAllLocalImageNames(boolean localized, boolean fullPath)
protected void	getAllLocalImageNamesForDirectory(SortedSet<String> s, String directory, boolean fullPath)
FileArchive	getArchive()
AudioClip	getCachedAudioClip(String name)
String[]	getImageNames()
SortedSet<String>	getImageNameSet()
SortedSet<String>	getImageNameSet(boolean localized, boolean fullPath)
protected void	getImageNamesRecursively(SortedSet<String> s)
protected void	getImageNamesRecursively(SortedSet<String> s, boolean localized, boolean fullPath)
String	getImagePrefix()
InputStream	getInputStream(String fileName)	Get an InputStream for the given file in the archive.
protected SortedSet<String>	getLocalImageNames()
String	getName()
protected PermissionCollection	getPermissions(CodeSource codesource)
URL	getURL()	Returns a URL pointing to the archive.
URL	getURL(String fileName)	Returns a URL pointing to the named file.
ArchiveWriter	getWriter()	Return the writeable instance of DataArchive, either this or one of its extensions.
Class<?>	loadClass(String name, boolean resolve)	//////////////////////////////////////////////////////////////////

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

Field Details

archive

protected FileArchive archive

extensions

protected List<DataArchive> extensions

localImages

protected SortedSet<String> localImages

cachedLocalImages

protected SortedSet<String>[] cachedLocalImages

IMAGE_DIR

public static final String IMAGE_DIR

See Also:

• Constant Field Values

imageDir

protected String imageDir

SOUND_DIR

public static final String SOUND_DIR

See Also:

• Constant Field Values

soundDir

protected String soundDir

ICON_DIR

public static final String ICON_DIR

See Also:

• Constant Field Values

Constructor Details

DataArchive

protected DataArchive()

DataArchive

public DataArchive(String zipName,
 String imageDir)
            throws IOException

Throws:

IOException

DataArchive

public DataArchive(String zipName)
            throws IOException

Throws:

IOException

Method Details

getName

public String getName()

Overrides:

getName in class ClassLoader

getArchive

public FileArchive getArchive()

getImagePrefix

public String getImagePrefix()

getCachedAudioClip

public AudioClip getCachedAudioClip(String name)
                             throws IOException

Throws:

IOException

getInputStream

public InputStream getInputStream(String fileName)
                           throws IOException,
FileNotFoundException

Get an InputStream for the given file in the archive.

Parameters:

fileName - the name of the file

Returns:

an InputStream which contains the file

Throws:

IOException - if there is a problem reading the file

FileNotFoundException - if the file doesn't exist

getURL

public URL getURL()
           throws IOException

Returns a URL pointing to the archive.

Returns:

a URL corresponding to this archive

Throws:

IOException - if the archive has not yet been saved

getURL

public URL getURL(String fileName)
           throws IOException,
FileNotFoundException

Returns a URL pointing to the named file.

Parameters:

fileName - the name of the file

Returns:

a URL corresponding to the file

Throws:

FileNotFoundException - if the file doesn't exist

IOException - if some other problem occurs

contains

public boolean contains(String fileName)
                 throws IOException

Throws:

IOException

contains

public boolean contains(String fileName,
 boolean checkExtensions)
                 throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getImageNames

public String[] getImageNames()

getImageNameSet

public SortedSet<String> getImageNameSet()

getImageNameSet

public SortedSet<String> getImageNameSet(boolean localized,
 boolean fullPath)

getImageNamesRecursively

protected void getImageNamesRecursively(SortedSet<String> s,
 boolean localized,
 boolean fullPath)

getImageNamesRecursively

protected void getImageNamesRecursively(SortedSet<String> s)

getLocalImageNames

protected SortedSet<String> getLocalImageNames()

buildLocalizedDirectoryList

protected void buildLocalizedDirectoryList(List<String> list)

getAllLocalImageNamesForDirectory

protected void getAllLocalImageNamesForDirectory(SortedSet<String> s,
 String directory,
 boolean fullPath)

getAllLocalImageNames

protected SortedSet<String> getAllLocalImageNames(boolean localized,
 boolean fullPath)

addExtension

public void addExtension(DataArchive ext)

DataArchives can extend other archives. The extensions will be searched for data if not found in the parent archive.

Parameters:

ext - the extension

getWriter

public ArchiveWriter getWriter()

Return the writeable instance of DataArchive, either this or one of its extensions. (At most one archive should be edited at a time.)

Returns:

writer

loadClass

public Class<?> loadClass(String name,
 boolean resolve)
                   throws ClassNotFoundException

//////////////////////////////////////////////////////////////////

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

getPermissions

protected PermissionCollection getPermissions(CodeSource codesource)

Overrides:

getPermissions in class SecureClassLoader

findClass

protected Class<?> findClass(String name)
                      throws ClassNotFoundException

Overrides:

findClass in class ClassLoader

Throws:

ClassNotFoundException