Package com.inductiveautomation.ignition.common.util

Class ZipMap

java.lang.Object

com.inductiveautomation.ignition.common.util.ZipMap

All Implemented Interfaces:

Map<String,ZipMapFile>

public class ZipMap
extends Object
implements Map<String,ZipMapFile>

The ZipMap provides a convenient way of working with zip files by providing a Map that is backed by a zip file.

A variety of constructors are available for creating the ZipMap. Once loaded, you can work with file objects as you would work with any normal map. To save changes, you must call writeToFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ZipMap.ZipMapFileImpl

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
ZipMap()	Creates an empty ZipMap.
ZipMap(File zipFile)	Create a ZipMap with the contents of the given zip file.
ZipMap(InputStream zipFile)	Create a ZipMap with the contents of the given zip file.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected void	ensureAllLoaded()
Set<Map.Entry<String,ZipMapFile>>	entrySet()
ZipMapFile	get(Object key)
boolean	isEmpty()
Set<String>	keySet()
protected byte[]	loadEntry(ZipEntry e)
ZipMapFile	put(String key, byte[] value)	Convenience method for putting a file into the ZipMap.
ZipMapFile	put(String key, ZipMapFile value)	Puts an entry into the ZipMap.
ZipMapFile	put(String key, File value)	Convenience method for putting a file into the ZipMap.
void	putAll(Map<? extends String,? extends ZipMapFile> t)
ZipMapFile	remove(Object key)
int	size()
Collection<ZipMapFile>	values()
void	writeToFile(File outputFile)	Write the contents of this ZipMap to a zip file using the supplied File.
void	writeToFile(OutputStream outputStream)	Write the contents of this ZipMap to a zip file using the supplied OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

ZipMap

public ZipMap()

Creates an empty ZipMap. Changes need to be explicitly written using writeToFile(File) or writeToFile(OutputStream).

ZipMap

public ZipMap(File zipFile)
       throws IOException

Create a ZipMap with the contents of the given zip file. Changes need to be explicitly written using writeToFile(File) or writeToFile(OutputStream).

Throws:

IOException

ZipMap

public ZipMap(InputStream zipFile)
       throws IOException

Create a ZipMap with the contents of the given zip file. Changes need to be explicitly written using writeToFile(File) or writeToFile(OutputStream).

Throws:

IOException

Method Details

loadEntry

protected byte[] loadEntry(ZipEntry e)

ensureAllLoaded

protected void ensureAllLoaded()
                        throws IOException

Throws:

IOException

writeToFile

public void writeToFile(File outputFile)
                 throws IOException

Write the contents of this ZipMap to a zip file using the supplied File.

Parameters:

outputFile - the file to write to

Throws:

IOException - on failure to write

writeToFile

public void writeToFile(OutputStream outputStream)
                 throws IOException

Write the contents of this ZipMap to a zip file using the supplied OutputStream.

Throws:

IOException

clear

public void clear()

Specified by:

clear in interface Map<String,ZipMapFile>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,ZipMapFile>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,ZipMapFile>

entrySet

@Nonnull
public Set<Map.Entry<String,ZipMapFile>> entrySet()

Specified by:

entrySet in interface Map<String,ZipMapFile>

get

public ZipMapFile get(Object key)

Specified by:

get in interface Map<String,ZipMapFile>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,ZipMapFile>

keySet

@Nonnull
public Set<String> keySet()

Specified by:

keySet in interface Map<String,ZipMapFile>

put

public ZipMapFile put(String key,
 ZipMapFile value)

Puts an entry into the ZipMap. Directory names should end with a "/".

Specified by:

put in interface Map<String,ZipMapFile>

put

public ZipMapFile put(String key,
 File value)

Convenience method for putting a file into the ZipMap.

Parameters:

key - Name of the file. Example: "hello.txt" or "dir/world.txt".

value - The file itself. A ZipMapFile will be created from this File.

Returns:

The ZipMapFile added to the ZipMap.

put

public ZipMapFile put(String key,
 byte[] value)

Convenience method for putting a file into the ZipMap.

Parameters:

key - Name of the file. Example: "hello.txt" or "dir/world.txt".

value - The byte[] itself. A ZipMapFile will be created from this byte[] with directory=false.

Returns:

The ZipMapFile added to the ZipMap.

putAll

public void putAll(Map<? extends String,? extends ZipMapFile> t)

Specified by:

putAll in interface Map<String,ZipMapFile>

remove

public ZipMapFile remove(Object key)

Specified by:

remove in interface Map<String,ZipMapFile>

size

public int size()

Specified by:

size in interface Map<String,ZipMapFile>

values

@Nonnull
public Collection<ZipMapFile> values()

Specified by:

values in interface Map<String,ZipMapFile>