io.divide.shared.transitory

Class TransientObject

java.lang.Object

io.divide.shared.transitory.TransientObject

Direct Known Subclasses:

BackendObject, Count, Credentials, ServerObject, TestObject1, TestObject2

public class TransientObject
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransientObject.MetaKey

Field Summary

Fields

Modifier and Type	Field and Description
static TransientObject.MetaKey	CREATE_DATE_KEY
protected java.util.Map<java.lang.String,java.lang.String>	meta_data
static java.lang.String	META_DATA
static TransientObject.MetaKey	MODIFIED_DATE_KEY
static TransientObject.MetaKey	OBJECT_KEY
static TransientObject.MetaKey	OBJECT_TYPE_KEY
static TransientObject.MetaKey	OWNER_ID_KEY
protected java.util.Map<java.lang.String,java.lang.Object>	user_data
static java.lang.String	USER_DATA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransientObject(java.lang.Class<T> objectType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
<O> O	get(java.lang.Class<O> clazz, java.lang.String key) Retrieve a specific element from this object.
<O> O	get(java.lang.Class<O> clazz, java.lang.String key, boolean deserialize) Retrieve a specific element from this object.
java.lang.Long	getCreateDate()
FilePermissions	getFilePermissions() Retrieves the file permissions for this object.
protected Credentials	getLoggedInUser()
java.util.Map<java.lang.String,java.lang.String>	getMetaData()
java.lang.Long	getModifiedDate()
java.lang.String	getObjectKey()
java.lang.String	getObjectType()
java.lang.Integer	getOwnerId() Owner Id representing the owner id of ther user who created this object
java.util.Map<java.lang.String,java.lang.Object>	getUserData()
int	hashCode()
boolean	isReadable()
boolean	isWritable()
protected <O> O	meta_get(java.lang.Class<O> clazz, TransientObject.MetaKey key)
protected void	meta_put(TransientObject.MetaKey key, java.lang.Object object)
protected boolean	meta_remove(TransientObject.MetaKey key)
void	put(java.lang.String key, java.lang.Object object) Add a specific key value pair to this object.
void	put(java.lang.String key, java.lang.Object object, boolean serialize) Add a specific key value pair to this object.
void	putAll(java.util.Map<? extends java.lang.String,?> map) Add a map to this object.
boolean	remove(java.lang.String key) Remove a specific user data element corrosponding to the given key.
void	removeAll() Removes all user data.
void	setFilePermissions(FilePermissions filePermissions) Sets new file permissions for this object.
protected void	setOwnerId(java.lang.Integer id)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

USER_DATA

public static final java.lang.String USER_DATA

See Also:

Constant Field Values

META_DATA

public static final java.lang.String META_DATA

See Also:

Constant Field Values

OBJECT_TYPE_KEY

public static final TransientObject.MetaKey OBJECT_TYPE_KEY

OWNER_ID_KEY

public static final TransientObject.MetaKey OWNER_ID_KEY

OBJECT_KEY

public static final TransientObject.MetaKey OBJECT_KEY

CREATE_DATE_KEY

public static final TransientObject.MetaKey CREATE_DATE_KEY

MODIFIED_DATE_KEY

public static final TransientObject.MetaKey MODIFIED_DATE_KEY

user_data

protected java.util.Map<java.lang.String,java.lang.Object> user_data

meta_data

protected java.util.Map<java.lang.String,java.lang.String> meta_data

Constructor Detail

TransientObject

protected TransientObject(java.lang.Class<T> objectType)

Method Detail

getLoggedInUser

protected Credentials getLoggedInUser()

isReadable

public boolean isReadable()

Returns:

whether this object is readable for the currently logged in user.

isWritable

public boolean isWritable()

Returns:

whether this object is writable for the currently logged in user.

setFilePermissions

public void setFilePermissions(FilePermissions filePermissions)

Sets new file permissions for this object.

Parameters:

filePermissions - file permissions to be used for this object.

getFilePermissions

public FilePermissions getFilePermissions()

Retrieves the file permissions for this object. This not a direct reference. If changes are made they must be stored with setFilePermissions().

Returns:

meta_put

protected final void meta_put(TransientObject.MetaKey key,
            java.lang.Object object)

meta_get

protected final <O> O meta_get(java.lang.Class<O> clazz,
             TransientObject.MetaKey key)

meta_remove

protected final boolean meta_remove(TransientObject.MetaKey key)

put

public void put(java.lang.String key,
       java.lang.Object object,
       boolean serialize)

Add a specific key value pair to this object.

Parameters:

key - key to identify this element by.

object - object to be added.

serialize - whether to manually serialize this object and store it as a json blob.

put

public void put(java.lang.String key,
       java.lang.Object object)

Add a specific key value pair to this object.

Parameters:

key - key to identify this element by.

object - object to be added.

putAll

public void putAll(java.util.Map<? extends java.lang.String,?> map)

Add a map to this object. Must be of type

Parameters:

map -

get

public <O> O get(java.lang.Class<O> clazz,
        java.lang.String key,
        boolean deserialize)

Retrieve a specific element from this object.

Parameters:

clazz - type of object to be retrieved. If type given does not match a classcast exception will be thrown.

key - key of object to be retrieved.

deserialize - specify of whether or not this object needs to be manually deserialized(stored as a json string).

Returns:

element of type specified corrosponding to the given key.

get

public <O> O get(java.lang.Class<O> clazz,
        java.lang.String key)

Retrieve a specific element from this object.

Parameters:

clazz - type of object to be retrieved. If type given does not match a classcast exception will be thrown.

key - key of object to be retrieved.

Returns:

element of type specified corrosponding to the given key.

remove

public final boolean remove(java.lang.String key)

Remove a specific user data element corrosponding to the given key.

Parameters:

key - key of object to be removed.

Returns:

removeAll

public final void removeAll()

Removes all user data. This can not be undone.

getUserData

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

Returns:

map representing this objects total user data. This is a new map, not a direct reference.

getMetaData

public java.util.Map<java.lang.String,java.lang.String> getMetaData()

Returns:

map representing this objects total metadata. This is a new map, not a direct reference.

getObjectKey

public java.lang.String getObjectKey()

Returns:

UUID key for this object.

getCreateDate

public java.lang.Long getCreateDate()

Returns:

this objects creation date.

getModifiedDate

public java.lang.Long getModifiedDate()

Returns:

last modified date for this object.

getObjectType

public java.lang.String getObjectType()

Returns:

this objects type, package + class name.

setOwnerId

protected void setOwnerId(java.lang.Integer id)

getOwnerId

public java.lang.Integer getOwnerId()

Owner Id representing the owner id of ther user who created this object

Returns:

Owner Id of user who created this object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object