org.eclipse.ecf.storage
Interface IContainerEntry

public interface IContainerEntry

Storage entry for IContainer instances.

Method Summary

IContainer	createContainer() Create an IContainer from this IContainerEntry.
void	delete() Delete this IContainerEntry from the IContainerStore.
ID	getContainerID() Get the container's ID for the stored IContainer.
java.lang.String	getFactoryName() Get the container factory name for the stored IContainer.
org.eclipse.equinox.security.storage.ISecurePreferences	getPreferences() Get the underlying ISecurePreferences node that represents this IContainerEntry in the storage.

Method Detail

getPreferences

org.eclipse.equinox.security.storage.ISecurePreferences getPreferences()

Get the underlying ISecurePreferences node that represents this IContainerEntry in the storage.

Returns:

ISecurePreferences that represents this IContainerEntry in the underlying storage. Will not return null.

getContainerID

ID getContainerID()
                  throws IDCreateException

Get the container's ID for the stored IContainer. The returned ID will be equivalent to the ID returned by the original container's IIdentifiable.getID().

Returns:

ID for the container. Will not be null.

Throws:

IDCreateException - if ID cannot be created.

getFactoryName

java.lang.String getFactoryName()
                                throws org.eclipse.equinox.security.storage.StorageException

Get the container factory name for the stored IContainer.

Returns:

String the container factory name. Will not be null.

Throws:

org.eclipse.equinox.security.storage.StorageException - if some exception reading from ISecurePreferences.

createContainer

IContainer createContainer()
                           throws ContainerCreateException

Create an IContainer from this IContainerEntry. This method may be used to create new IContainer instance from this IContainerEntry. The created IContainer will be equivalent (via ID.equals(other)) to the ID previously stored via IContainerStore.store(IStorableContainerAdapter).

Returns:

IContainer that corresponds to this previously stored IContainerEntry.

Throws:

ContainerCreateException - if the IContainer cannot be created in this environment.

delete

void delete()

Delete this IContainerEntry from the IContainerStore.