Package VASSAL.tools

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 String	ICON_DIR
static String	IMAGE_DIR
protected String	imageDir
protected String[]	imageNames	Deprecated, for removal: This API element is subject to removal in a future version.
protected SortedSet<String>	localImages
static String	SOUND_DIR
protected String	soundDir
static String	SOUNDS_DIR	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	soundsDir	Deprecated, for removal: This API element is subject to removal in a future version.

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.
boolean	addImageSource(String name, org.apache.xmlgraphics.image.loader.ImageSource src)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	buildLocalizedDirectoryList(List<String> list)
void	clearScaledImageCache()	Deprecated, for removal: This API element is subject to removal in a future version.
void	clearTransformedImageCache()	Deprecated, for removal: This API element is subject to removal in a future version.
void	close()
boolean	contains(String fileName)
protected Class<?>	findClass(String name)
static Image	findImage(File zip, String file)	Deprecated, for removal: This API element is subject to removal in a future version. Use getImage(java.lang.String) instead.
static Image	findImage(File dir, String zip, String file)	Deprecated, for removal: This API element is subject to removal in a future version. Use getImage(java.lang.String) instead.
protected SortedSet<String>	getAllLocalImageNames(boolean localized, boolean fullPath)
protected void	getAllLocalImageNamesForDirectory(SortedSet<String> s, String directory, boolean fullPath)
FileArchive	getArchive()
String	getArchiveURL()	Deprecated, for removal: This API element is subject to removal in a future version. Use getURL() instead.
static byte[]	getBytes(InputStream in)	Deprecated, for removal: This API element is subject to removal in a future version. Use InputStream.readAllBytes() instead.
AudioClip	getCachedAudioClip(String name)
Image	getCachedImage(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageOps instead.
static InputStream	getFileStream(File zip, String file)	Deprecated, for removal: This API element is subject to removal in a future version. Use getFileStream(String) instead.
static InputStream	getFileStream(File dir, String zipName, String file)	Deprecated, for removal: This API element is subject to removal in a future version. Use getFileStream(String) instead.
InputStream	getFileStream(String fileName)	Deprecated, for removal: This API element is subject to removal in a future version. Use getInputStream(String) instead.
static Image	getImage(InputStream in)	Deprecated, for removal: This API element is subject to removal in a future version.
BufferedImage	getImage(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageUtils.getImage(String, InputStream) or SVGImageUtils.getImageSize(String, InputStream) instead.
static Rectangle	getImageBounds(Image im)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageUtils.getBounds(BufferedImage) instead.
InputStream	getImageInputStream(String fileName)	Deprecated, for removal: This API element is subject to removal in a future version. Use getInputStream(String) instead.
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()
Dimension	getImageSize(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageUtils.getImageSize(String, InputStream) or SVGImageUtils.getImageSize(String, InputStream) instead.
URL	getImageURL(String fileName)	Deprecated, for removal: This API element is subject to removal in a future version. Use getURL(String) instead.
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)
Image	getScaledImage(Image base, double scale)	Deprecated, for removal: This API element is subject to removal in a future version. Use ScaleOp instead.
Image	getScaledImage(Image base, double scale, boolean reversed, boolean forceSmoothing)	Deprecated, for removal: This API element is subject to removal in a future version. Use ScaleOp instead.
Image	getTransformedImage(Image base, double scale, double theta)	Deprecated, for removal: This API element is subject to removal in a future version. Use RotateScaleOp instead.
Image	getTransformedImage(Image base, double scale, double theta, boolean forceSmoothing)	Deprecated, for removal: This API element is subject to removal in a future version. Use RotateScaleOp instead.
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.
Image	improvedScaling(Image img, int width, int height)	Deprecated, for removal: This API element is subject to removal in a future version. Don't use this.
protected boolean	isNameCacheStale()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	listImageNames(Collection l)	Deprecated, for removal: This API element is subject to removal in a future version. Use getImageNameSet() )} instead.
Class<?>	loadClass(String name, boolean resolve)
void	removeImageSource(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
protected SortedSet<String>	setOfImageNames()	Deprecated, for removal: This API element is subject to removal in a future version. Use getImageNameSet() instead.
void	unCacheImage(Image im)	Deprecated, for removal: This API element is subject to removal in a future version.
void	unCacheImage(String file)	Deprecated, for removal: This API element is subject to removal in a future version.

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

SOUNDS_DIR

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static final String SOUNDS_DIR

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

See Also:

Constant Field Values

soundsDir

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected String soundsDir

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

imageNames

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected String[] imageNames

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

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

getImageInputStream

@Deprecated(since="2020-08-06",
            forRemoval=true)
public InputStream getImageInputStream(String fileName)
                                throws IOException,
FileNotFoundException

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

Use getInputStream(String) instead.

Get an InputStream for the given image file in the archive.

Parameters:

fileName - the name of the image file

Returns:

an InputStream which contains the image file

Throws:

IOException - if there is a problem reading the image file

FileNotFoundException - if the image file doesn't exist

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

getImageURL

@Deprecated(since="2020-08-06",
            forRemoval=true)
public URL getImageURL(String fileName)
                throws IOException,
FileNotFoundException

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

Use getURL(String) instead.

Returns a URL pointing to the named image file.

Parameters:

fileName - the name of the image file

Returns:

a URL corresponding to the image 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

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

addImageSource

@Deprecated(since="2020-08-06",
            forRemoval=true)
public boolean addImageSource(String name,
 org.apache.xmlgraphics.image.loader.ImageSource src)

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

Add an ImageSource under the given name, but only if no source is yet registered under this name.

Parameters:

name - name

src - source

Returns:

true if the ImageSource was added, false if it existed already

removeImageSource

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

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

getImageSize

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Dimension getImageSize(String name)
                       throws IOException

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

Use ImageUtils.getImageSize(String, InputStream) or SVGImageUtils.getImageSize(String, InputStream) instead.

Get the size of an image without loading and decoding it.

Parameters:

name - filename of the image

Returns:

the size of the image

Throws:

IOException

getImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public BufferedImage getImage(String name)
                       throws IOException

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

Use ImageUtils.getImage(String, InputStream) or SVGImageUtils.getImageSize(String, InputStream) instead.

Returns an Image from the archive.

Parameters:

name - the name of the image file

Returns:

the Image contained in the image file

Throws:

IOException - if there is a problem reading the image file

isNameCacheStale

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected boolean isNameCacheStale()

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

setOfImageNames

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected SortedSet<String> setOfImageNames()

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

Use getImageNameSet() instead.

Returns:

the names of the image files stored in this DataArchive and its extensions

unCacheImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void unCacheImage(String file)

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

unCacheImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void unCacheImage(Image im)

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

clearTransformedImageCache

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

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

clearScaledImageCache

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

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

getCachedImage

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

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

Use ImageOps instead.

Find an image from the archive Once an image is found, cache it in our HashMap.

getTransformedImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getTransformedImage(Image base,
 double scale,
 double theta)

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

Use RotateScaleOp instead.

Return a transformed instance of the image. The image will be retrieved from the cache if available, and cached after retrieval if not.

Parameters:

base - the untransformed Image

scale - the scaling factor

theta - the angle of rotation (in degrees) about the Image center

getTransformedImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getTransformedImage(Image base,
 double scale,
 double theta,
 boolean forceSmoothing)

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

Use RotateScaleOp instead.

Parameters:

base - base

scale - scale

theta - theta

forceSmoothing - forceSmoothing

Returns:

transformed image

getScaledImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getScaledImage(Image base,
 double scale,
 boolean reversed,
 boolean forceSmoothing)

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

Use ScaleOp instead. The image will be retrieved from cache if available, cached otherwise

Parameters:

base - base

scale - scale

reversed - reversed

forceSmoothing - If true, force smoothing. This usually yields better results, but can be slow for large images

Returns:

Scaled image

getScaledImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getScaledImage(Image base,
 double scale)

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

Use ScaleOp instead.

Return a scaled instance of the image. The image will be retrieved from cache if available, cached otherwise

Parameters:

base - base

scale - scale

Returns:

Scaled image

findImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Image findImage(File zip,
 String file)
                       throws IOException

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

Use getImage(java.lang.String) instead.

Throws:

IOException

findImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Image findImage(File dir,
 String zip,
 String file)
                       throws IOException

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

Use getImage(java.lang.String) instead.

Throws:

IOException

getFileStream

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static InputStream getFileStream(File zip,
 String file)
                                 throws IOException

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

Use getFileStream(String) instead.

Throws:

IOException

getFileStream

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static InputStream getFileStream(File dir,
 String zipName,
 String file)

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

Use getFileStream(String) instead.

getFileStream

@Deprecated(since="2020-08-06",
            forRemoval=true)
public InputStream getFileStream(String fileName)
                          throws IOException

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

Use getInputStream(String) instead.

Get an InputStream for the given filename in the archive.

Throws:

IOException

getImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Image getImage(InputStream in)
                      throws IOException

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

Use ImageUtils.getImage(String, InputStream) instead.

Throws:

IOException

getArchiveURL

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

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

Use getURL() instead.

getBytes

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static byte[] getBytes(InputStream in)
                       throws IOException

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

Use InputStream.readAllBytes() instead.

Read all available bytes from the given InputStream.

Throws:

IOException

listImageNames

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void listImageNames(Collection l)

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

Use getImageNameSet() )} instead.

Place the names of the image files stored in this DataArchive into the argument Collection

Parameters:

l - l

getImageBounds

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Rectangle getImageBounds(Image im)

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

Use ImageUtils.getBounds(BufferedImage) instead.

Parameters:

im - image

Returns:

the boundaries of this image, where (0,0) is the center of the image

improvedScaling

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image improvedScaling(Image img,
 int width,
 int height)

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

Don't use this. We've switched to Lanczos scaling.