com.google.gwt.dev.util

Interface PersistenceBackedObject<T>

Type Parameters:

T - the type of object being serialized

All Superinterfaces:

Serializable

All Known Implementing Classes:

FileBackedObject, MemoryBackedObject, ZipEntryBackedObject

public interface PersistenceBackedObject<T>
extends Serializable

A handle for interacting with a persisted or to be persisted object.

Method Summary

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.

Method Detail

exists

boolean exists()

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.

getPath

String getPath()

Returns the path to the intended persistence location.

newInstance

T newInstance(TreeLogger logger)
       throws UnableToCompleteException

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

Throws:

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

set

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

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

Throws:

UnableToCompleteException - if the object could not be serialized

IllegalStateException