com.google.gwt.dev.util

Class ZipEntryBackedObject<T extends Serializable>

java.lang.Object

com.google.gwt.dev.util.ZipEntryBackedObject<T>

Type Parameters:

T - the type of object serialized into the zip entry

All Implemented Interfaces:

PersistenceBackedObject<T>, Serializable

public class ZipEntryBackedObject<T extends Serializable>
extends Object
implements PersistenceBackedObject<T>

Represents an entry in a ZipFile that contains the serialized form of a Serializable object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ZipEntryBackedObject(ZipFile zipFile, String libraryPath, String resourcePath, Class<T> clazz) Constructs a read-only instance that will dynamically open the provided resourcePath in the provided zipFile when requested.
ZipEntryBackedObject(ZipOutputStream zipOutputStream, String libraryPath, String resourcePath, Class<T> clazz) Constructs a write-only instance that will write a ZipEntry and bytes to the provided zipOutputStream when requested. Cannot be used to overwrite an already existing entry.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists() Returns whether the intended persistence location is already populated.
String	getPath() Returns the path to the intended persistence location.
T	newInstance(TreeLogger logger) Constructs and returns a new instance of the object stored at the path.
void	set(TreeLogger logger, T object) Serializes the provided object to the intended path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipEntryBackedObject

public ZipEntryBackedObject(ZipFile zipFile,
                    String libraryPath,
                    String resourcePath,
                    Class<T> clazz)

Constructs a read-only instance that will dynamically open the provided resourcePath in the provided zipFile when requested.

ZipEntryBackedObject

public ZipEntryBackedObject(ZipOutputStream zipOutputStream,
                    String libraryPath,
                    String resourcePath,
                    Class<T> clazz)

Constructs a write-only instance that will write a ZipEntry and bytes to the provided zipOutputStream when requested.
Cannot be used to overwrite an already existing entry. Brand new zip files that are being built manifest as empty files which can not be probed by ZipFile but which are legal for zip output stream writing and ZipOutputStreams can't be probed about existing entries. So it is left up to the user to avoid duplicate entry errors.

Method Detail

exists

public boolean exists()

Description copied from interface: PersistenceBackedObject

Returns whether the intended persistence location is already populated. For example if persisting to a file this would be whether or not the file already exists.

Specified by:

exists in interface PersistenceBackedObject<T extends Serializable>

getPath

public String getPath()

Description copied from interface: PersistenceBackedObject

Returns the path to the intended persistence location.

Specified by:

getPath in interface PersistenceBackedObject<T extends Serializable>

newInstance

public T newInstance(TreeLogger logger)
                                   throws UnableToCompleteException

Description copied from interface: PersistenceBackedObject

Constructs and returns a new instance of the object stored at the path.

Specified by:

newInstance in interface PersistenceBackedObject<T extends Serializable>

Throws:

UnableToCompleteException - if the backing store does not contain an object of type T

set

public void set(TreeLogger logger,
       T object)
         throws IllegalStateException,
                UnableToCompleteException

Description copied from interface: PersistenceBackedObject

Serializes the provided object to the intended path. Can only be set once.

Specified by:

set in interface PersistenceBackedObject<T extends Serializable>

Throws:

UnableToCompleteException - if the object could not be serialized

IllegalStateException