CloudObject (codenameone-core 7.0.8-b3 API)

java.lang.Object
- com.codename1.cloud.CloudObject

All Implemented Interfaces:

Externalizable

Deprecated.
the cloud storage API is no longer supported, we recommend switching to a solution such as parse4cn1
```
public final class CloudObject
extends Object
implements Externalizable
```
A cloud object can be persisted to the cloud or locally it is a set of key/value pairs that can be either strings or numbers. There is a 512 character limit on string length! Notice: keys starting with CN1 are reserved for internal usage!

Author:

Shai Almog

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS_APPLICATION` Deprecated. An application visible/modifiable object!
`static int`	`ACCESS_APPLICATION_READ_ONLY` Deprecated. An application scope readable object! Can only be modified by its creator
`static int`	`ACCESS_PRIVATE` Deprecated. An object that can only be viewed or modified by its creator
`static int`	`ACCESS_PUBLIC` Deprecated. A world visible/modifiable object!
`static int`	`ACCESS_PUBLIC_READ_ONLY` Deprecated. A world visible object! Can only be modified by its creator.
`static int`	`BINDING_AUTO_SAVE` Deprecated. Changes to the bound property will be reflected instantly into the cloud object and the object would be saved immediately (not committed!).
`static int`	`BINDING_DEFERRED` Deprecated. Changes to the bound property won't be reflected into the bound cloud object until commit binding is invoked
`static int`	`BINDING_IMMEDIATE` Deprecated. Changes to the bound property will be reflected instantly into the cloud object
`static int`	`STATUS_COMMIT_IN_PROGRESS` Deprecated. Indicates the state of the current object, an object in the process of committing
`static int`	`STATUS_COMMITTED` Deprecated. Indicates the state of the current object, an object that is in sync with the database as far as the client code is aware (the client code doesn't check!)
`static int`	`STATUS_DELETE_IN_PROGRESS` Deprecated. Indicates the state of the current object, an object that is in the process of deletion
`static int`	`STATUS_DELETED` Deprecated. Indicates the state of the current object, a deleted object
`static int`	`STATUS_MODIFIED` Deprecated. Indicates the state of the current object, a locally modified object that wasn't committed yet
`static int`	`STATUS_NEW` Deprecated. Indicates the state of the current object, a new object never persisted
`static int`	`STATUS_REFRESH_IN_PROGRESS` Deprecated. Indicates the state of the current object, an object in the process of refresh

Constructor Summary

Constructors
Constructor and Description
`CloudObject()` Deprecated. Default constructor for externalization purposes only!
`CloudObject(String type)` Deprecated. Constructor
`CloudObject(String type, int permissions)` Deprecated. Create an object with different permissions settings

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`bindProperty(Component cmp, String propertyName, String attributeName, int defer, boolean objectLead)` Deprecated. Binds a property value within the given component to this cloud object, this means that when the component changes the cloud object changes unless deferred.
`void`	`bindTree(Container ui, int defer, boolean objectLead)` Deprecated. Binds a UI tree to the cloud object so its values automatically update in the cloud object
`void`	`cancelBinding()` Deprecated. If deferred changes exist this method discards such values
`void`	`commitBinding()` Deprecated. If deferred changes exist this method applies these changes to the data
`boolean`	`equals(Object o)` Deprecated.
`void`	`externalize(DataOutputStream out)` Deprecated. Allows us to store an object state, this method must be implemented in order to save the state of an object
`int`	`getAccessPermissions()` Deprecated. The access permissions for an object can only be changed for an object in which the current user is the owner
`Boolean`	`getBoolean(String key)` Deprecated. Returns the value for the given key
`String`	`getCloudId()` Deprecated. The object id is a unique key that allows you to find an object that was persisted in the store (a primary key).
`Double`	`getDouble(String key)` Deprecated. Returns the value for the given key
`Float`	`getFloat(String key)` Deprecated. Returns the value for the given key
`Double`	`getIndexDouble(int index)` Deprecated. Returns the index value for the given index number
`Long`	`getIndexLong(int index)` Deprecated. Returns the index value for the given index number
`String`	`getIndexString(int index)` Deprecated. Returns the index value for the given index number
`Integer`	`getInteger(String key)` Deprecated. Returns the value for the given key
`long`	`getLastModified()` Deprecated. Indicates the last modification date for the object
`Long`	`getLong(String key)` Deprecated. Returns the value for the given key
`Object`	`getObject(String key)` Deprecated. Allows us to extract an object from the cloud object without knowing its type in advance or whether it exists
`String`	`getObjectId()` Deprecated. The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
`int`	`getStatus()` Deprecated. Returns one of the status constants in this class
`String`	`getString(String key)` Deprecated. Returns the value for the given key
`String`	`getType()` Deprecated. Returns the type of the object
`int`	`getVersion()` Deprecated. Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
`int`	`hashCode()` Deprecated.
`void`	`internalize(int version, DataInputStream in)` Deprecated. Loads the object from the input stream and allows deserialization
`boolean`	`isOwner()` Deprecated. Returns true if this object is owned by me or is world writeable
`void`	`remove(String key)` Deprecated. Delete an entry within the object
`void`	`setBoolean(String key, boolean value)` Deprecated. Sets a value
`void`	`setBoolean(String key, Boolean value)` Deprecated. Sets a value
`static void`	`setCustomProperty(String key, CustomProperty cp)` Deprecated. Install a custom property on the given property name
`void`	`setDouble(String key, double value)` Deprecated. Sets a value
`void`	`setDouble(String key, Double value)` Deprecated. Sets a value
`void`	`setFloat(String key, float value)` Deprecated. Sets a value
`void`	`setFloat(String key, Float value)` Deprecated. Sets a value
`void`	`setIndexDouble(int index, double value)` Deprecated. Only indexed values can be queried and sorted
`void`	`setIndexLong(int index, long value)` Deprecated. Only indexed values can be queried and sorted
`void`	`setIndexString(int index, String value)` Deprecated. Only indexed values can be queried and sorted
`void`	`setInteger(String key, int value)` Deprecated. Sets a value
`void`	`setInteger(String key, Integer value)` Deprecated. Sets a value
`void`	`setLong(String key, long value)` Deprecated. Sets a value
`void`	`setLong(String key, Long value)` Deprecated. Sets a value
`void`	`setString(String key, String value)` Deprecated. Sets a value that can be no more than 512 characters
`void`	`setType(String type)` Deprecated. Set the type of the object
`void`	`unbindProperty(Component cmp, String propertyName)` Deprecated. Releases the binding for the specific property name
`void`	`unbindTree(Container ui)` Deprecated. Clears the binding to this component tree

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATUS_NEW
```
public static final int STATUS_NEW
```
    Deprecated.
    
    Indicates the state of the current object, a new object never persisted
    
    See Also:
    
    Constant Field Values
  - STATUS_COMMITTED
```
public static final int STATUS_COMMITTED
```
    Deprecated.
    
    Indicates the state of the current object, an object that is in sync with the database as far as the client code is aware (the client code doesn't check!)
    
    See Also:
    
    Constant Field Values
  - STATUS_MODIFIED
```
public static final int STATUS_MODIFIED
```
    Deprecated.
    
    Indicates the state of the current object, a locally modified object that wasn't committed yet
    
    See Also:
    
    Constant Field Values
  - STATUS_COMMIT_IN_PROGRESS
```
public static final int STATUS_COMMIT_IN_PROGRESS
```
    Deprecated.
    
    Indicates the state of the current object, an object in the process of committing
    
    See Also:
    
    Constant Field Values
  - STATUS_DELETE_IN_PROGRESS
```
public static final int STATUS_DELETE_IN_PROGRESS
```
    Deprecated.
    
    Indicates the state of the current object, an object that is in the process of deletion
    
    See Also:
    
    Constant Field Values
  - STATUS_DELETED
```
public static final int STATUS_DELETED
```
    Deprecated.
    
    Indicates the state of the current object, a deleted object
    
    See Also:
    
    Constant Field Values
  - STATUS_REFRESH_IN_PROGRESS
```
public static final int STATUS_REFRESH_IN_PROGRESS
```
    Deprecated.
    
    Indicates the state of the current object, an object in the process of refresh
    
    See Also:
    
    Constant Field Values
  - ACCESS_PUBLIC
```
public static final int ACCESS_PUBLIC
```
    Deprecated.
    
    A world visible/modifiable object!
    
    See Also:
    
    Constant Field Values
  - ACCESS_PUBLIC_READ_ONLY
```
public static final int ACCESS_PUBLIC_READ_ONLY
```
    Deprecated.
    
    A world visible object! Can only be modified by its creator.
    
    See Also:
    
    Constant Field Values
  - ACCESS_APPLICATION
```
public static final int ACCESS_APPLICATION
```
    Deprecated.
    
    An application visible/modifiable object!
    
    See Also:
    
    Constant Field Values
  - ACCESS_APPLICATION_READ_ONLY
```
public static final int ACCESS_APPLICATION_READ_ONLY
```
    Deprecated.
    
    An application scope readable object! Can only be modified by its creator
    
    See Also:
    
    Constant Field Values
  - ACCESS_PRIVATE
```
public static final int ACCESS_PRIVATE
```
    Deprecated.
    
    An object that can only be viewed or modified by its creator
    
    See Also:
    
    Constant Field Values
  - BINDING_DEFERRED
```
public static final int BINDING_DEFERRED
```
    Deprecated.
    
    Changes to the bound property won't be reflected into the bound cloud object until commit binding is invoked
    
    See Also:
    
    Constant Field Values
  - BINDING_IMMEDIATE
```
public static final int BINDING_IMMEDIATE
```
    Deprecated.
    
    Changes to the bound property will be reflected instantly into the cloud object
    
    See Also:
    
    Constant Field Values
  - BINDING_AUTO_SAVE
```
public static final int BINDING_AUTO_SAVE
```
    Deprecated.
    
    Changes to the bound property will be reflected instantly into the cloud object and the object would be saved immediately (not committed!).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CloudObject
```
public CloudObject()
```
    Deprecated.
    
    Default constructor for externalization purposes only!
  - CloudObject
```
public CloudObject(String type)
```
    Deprecated.
    
    Constructor
    
    Parameters:
    
    type - the type of the object
  - CloudObject
```
public CloudObject(String type,
                   int permissions)
```
    Deprecated.
    
    Create an object with different permissions settings
    
    Parameters:
    
    type - the type of the object
    
    permissions - one of the ACCESS_* values
- Method Detail
  - getStatus
```
public int getStatus()
```
    Deprecated.
    
    Returns one of the status constants in this class
    
    Returns:
    
    the status of the object against the cloud
  - setType
```
public void setType(String type)
```
    Deprecated.
    
    Set the type of the object
    
    Parameters:
    
    type - the type of the field
  - getType
```
public String getType()
```
    Deprecated.
    
    Returns the type of the object
    
    Returns:
    
    the type of the object
  - setIndexString
```
public void setIndexString(int index,
                           String value)
```
    Deprecated.
    
    Only indexed values can be queried and sorted
    
    Parameters:
    
    index - the index which must be a value between 1 and 10.
    
    value - the value for the given index
  - getIndexString
```
public String getIndexString(int index)
```
    Deprecated.
    
    Returns the index value for the given index number
    
    Parameters:
    
    index - the index number
    
    Returns:
    
    the value of this entry for that index as a String
  - setIndexLong
```
public void setIndexLong(int index,
                         long value)
```
    Deprecated.
    
    Only indexed values can be queried and sorted
    
    Parameters:
    
    index - the index which must be a value between 1 and 10.
    
    value - the value for the given index
  - getIndexLong
```
public Long getIndexLong(int index)
```
    Deprecated.
    
    Returns the index value for the given index number
    
    Parameters:
    
    index - the index number
    
    Returns:
    
    the value of this entry for that index as a Long value
  - setIndexDouble
```
public void setIndexDouble(int index,
                           double value)
```
    Deprecated.
    
    Only indexed values can be queried and sorted
    
    Parameters:
    
    index - the index which must be a value between 1 and 10.
    
    value - the value for the given index
  - getIndexDouble
```
public Double getIndexDouble(int index)
```
    Deprecated.
    
    Returns the index value for the given index number
    
    Parameters:
    
    index - the index number
    
    Returns:
    
    the value of this entry for that index as a Double value
  - isOwner
```
public boolean isOwner()
```
    Deprecated.
    
    Returns true if this object is owned by me or is world writeable
    
    Returns:
    
    ownership status
  - getCloudId
```
public String getCloudId()
```
    Deprecated.
    
    The object id is a unique key that allows you to find an object that was persisted in the store (a primary key). When it is null the object is effectively unsynchronized!
    
    Returns:
    
    the object id or null for an object that isn't fully persisted yet
  - getLastModified
```
public long getLastModified()
```
    Deprecated.
    
    Indicates the last modification date for the object
    
    Returns:
    
    the last modification date
  - getObject
```
public Object getObject(String key)
```
    Deprecated.
    
    Allows us to extract an object from the cloud object without knowing its type in advance or whether it exists
    
    Parameters:
    
    key - the key for the object
    
    Returns:
    
    the value of the object
  - setCustomProperty
```
public static void setCustomProperty(String key,
                                     CustomProperty cp)
```
    Deprecated.
    
    Install a custom property on the given property name
    
    Parameters:
    
    key - the key on which to install the custom property
    
    cp - the custom property implementation
  - setString
```
public void setString(String key,
                      String value)
```
    Deprecated.
    
    Sets a value that can be no more than 512 characters
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getString
```
public String getString(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a string value
  - remove
```
public void remove(String key)
```
    Deprecated.
    
    Delete an entry within the object
    
    Parameters:
    
    key - the key to remove from the object
  - setLong
```
public void setLong(String key,
                    long value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - setLong
```
public void setLong(String key,
                    Long value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getLong
```
public Long getLong(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a long value
  - setInteger
```
public void setInteger(String key,
                       int value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - setInteger
```
public void setInteger(String key,
                       Integer value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getInteger
```
public Integer getInteger(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a value
  - setDouble
```
public void setDouble(String key,
                      double value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - setDouble
```
public void setDouble(String key,
                      Double value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getDouble
```
public Double getDouble(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a value
  - setFloat
```
public void setFloat(String key,
                     float value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - setFloat
```
public void setFloat(String key,
                     Float value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getFloat
```
public Float getFloat(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a value
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - setBoolean
```
public void setBoolean(String key,
                       Boolean value)
```
    Deprecated.
    
    Sets a value
    
    Parameters:
    
    key - the key for the given value
    
    value - the value
  - getBoolean
```
public Boolean getBoolean(String key)
```
    Deprecated.
    
    Returns the value for the given key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    a value
  - getVersion
```
public int getVersion()
```
    Deprecated.
    
    Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
    
    Specified by:
    
    getVersion in interface Externalizable
    
    Returns:
    
    version number for the persistant code
  - externalize
```
public void externalize(DataOutputStream out)
                 throws IOException
```
    Deprecated.
    
    Allows us to store an object state, this method must be implemented in order to save the state of an object
    
    Specified by:
    
    externalize in interface Externalizable
    
    Parameters:
    
    out - the stream into which the object must be serialized
    
    Throws:
    
    IOException - the method may throw an exception
  - getObjectId
```
public String getObjectId()
```
    Deprecated.
    
    Description copied from interface: Externalizable
    
    The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
    
    Specified by:
    
    getObjectId in interface Externalizable
    
    Returns:
    
    a unique id
  - internalize
```
public void internalize(int version,
                        DataInputStream in)
                 throws IOException
```
    Deprecated.
    
    Loads the object from the input stream and allows deserialization
    
    Specified by:
    
    internalize in interface Externalizable
    
    Parameters:
    
    version - the version the class returned during the externalization processs
    
    in - the input stream used to load the class
    
    Throws:
    
    IOException - the method may throw an exception
  - getAccessPermissions
```
public int getAccessPermissions()
```
    Deprecated.
    
    The access permissions for an object can only be changed for an object in which the current user is the owner
    
    Returns:
    
    the accessPermissions
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - bindTree
```
public void bindTree(Container ui,
                     int defer,
                     boolean objectLead)
```
    Deprecated.
    
    Binds a UI tree to the cloud object so its values automatically update in the cloud object
    
    Parameters:
    
    ui - the component tree to bind
    
    defer - bind settings whether to defer the binding which requires developers to explicitly commit the binding to perform the changes
    
    objectLead - if set to true the UI property is initialized from values in the CloudObject, if false the cloud object property is initialized from the UI
  - unbindTree
```
public void unbindTree(Container ui)
```
    Deprecated.
    
    Clears the binding to this component tree
    
    Parameters:
    
    ui - the container whose children might be bound
  - bindProperty
```
public void bindProperty(Component cmp,
                         String propertyName,
                         String attributeName,
                         int defer,
                         boolean objectLead)
```
    Deprecated.
    
    Binds a property value within the given component to this cloud object, this means that when the component changes the cloud object changes unless deferred. If the defer flag is false all changes are stored in a temporary location and only "committed" once commitBindings() is invoked.
    
    Parameters:
    
    cmp - the component to bind
    
    propertyName - the name of the property in the bound component
    
    attributeName - the key within the cloud object
    
    defer - bind settings whether to defer the binding which requires developers to explicitly commit the binding to perform the changes
    
    objectLead - if set to true the UI property is initialized from values in the CloudObject, if false the cloud object property is initialized from the UI
  - unbindProperty
```
public void unbindProperty(Component cmp,
                           String propertyName)
```
    Deprecated.
    
    Releases the binding for the specific property name
    
    Parameters:
    
    cmp - the component
    
    propertyName - the name of the property
  - commitBinding
```
public void commitBinding()
```
    Deprecated.
    
    If deferred changes exist this method applies these changes to the data
  - cancelBinding
```
public void cancelBinding()
```
    Deprecated.
    
    If deferred changes exist this method discards such values

Class CloudObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_NEW

STATUS_COMMITTED

STATUS_MODIFIED

STATUS_COMMIT_IN_PROGRESS

STATUS_DELETE_IN_PROGRESS

STATUS_DELETED

STATUS_REFRESH_IN_PROGRESS

ACCESS_PUBLIC

ACCESS_PUBLIC_READ_ONLY

ACCESS_APPLICATION

ACCESS_APPLICATION_READ_ONLY

ACCESS_PRIVATE

BINDING_DEFERRED

BINDING_IMMEDIATE

BINDING_AUTO_SAVE

Constructor Detail

CloudObject

CloudObject

CloudObject

Method Detail

getStatus

setType

getType

setIndexString

getIndexString

setIndexLong

getIndexLong

setIndexDouble

getIndexDouble

isOwner

getCloudId

getLastModified

getObject

setCustomProperty

setString

getString

remove

setLong

setLong

getLong

setInteger

setInteger

getInteger

setDouble

setDouble

getDouble

setFloat

setFloat

getFloat

setBoolean

setBoolean

getBoolean

getVersion

externalize

getObjectId

internalize

getAccessPermissions

equals

hashCode

bindTree

unbindTree

bindProperty

unbindProperty

commitBinding

cancelBinding