Package com.iizix.api

Interface IPrivateStorage

All Known Subinterfaces:

IAppSessionGyro, IClientSessionGyro

All Known Implementing Classes:

AppSessionGyro, ClientSessionGyro, EditorVirtualSpace, VirtualSpace

public interface IPrivateStorage

The private storage interface is used in components in order to provide a programmatic storage that lives with the component it is attached to. An example would be the VirtualSpace that implements this interface enabling VirtualSpace instances to share data between client sessions.

Author:

Christopher Mindus

Method Summary

Modifier and Type	Method	Description
default java.lang.Object	getPrivateData(java.lang.String key)	Gets an Object in the private storage map.
java.util.Map<java.lang.String,java.lang.Object>	getPrivateStorageMap()	Gets the synchronized map used to store the private data.
default java.lang.Object	setPrivateData(java.lang.String key, java.lang.Object data)	Adds a new Object to the private storage map, overwriting existing objects.

Method Detail

getPrivateStorageMap

java.util.Map<java.lang.String,java.lang.Object> getPrivateStorageMap()

Gets the synchronized map used to store the private data.

setPrivateData

default java.lang.Object setPrivateData(java.lang.String key,
                                        java.lang.Object data)

Adds a new Object to the private storage map, overwriting existing objects.

Parameters:

key - The key for the data, not null.

data - The data Object, null to remove the key.

Returns:

A previously overwritten or removed object, or null if none were present.

Throws:

java.lang.NullPointerException - If the key is null.

getPrivateData

default java.lang.Object getPrivateData(java.lang.String key)

Gets an Object in the private storage map.

Parameters:

key - The key for the data, not null.

Returns:

The object for the key, null if none is present.

Throws:

java.lang.NullPointerException - If the key is null.