com.gluonhq.charm.connect.service

Enum SyncMethod

java.lang.Object

java.lang.Enum<SyncMethod>

com.gluonhq.charm.connect.service.SyncMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SyncMethod>

public enum SyncMethod
extends java.lang.Enum<SyncMethod>

The sync method defines when changes to a property of a remote object should be synchronized with Gluon Cloud.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO The AUTO method is a shorthand notation for AUTO_READ and AUTO_WRITE.
AUTO_READ Properties annotated with AUTO_READ will automatically receive all changes that occur to the value of the property on Gluon Cloud.
AUTO_WRITE Properties annotated with AUTO_WRITE will automatically push all changes that occur to the value of the property to Gluon Cloud.
MANUAL The MANUAL method is a shorthand notation for MANUAL_READ and MANUAL_WRITE.
MANUAL_READ Properties annotated with AUTO_READ will only receive the value that is stored on Gluon Cloud when a sync operation is started.
MANUAL_WRITE Properties annotated with AUTO_READ will only push their current value to Gluon Cloud when a sync operation is started.
NONE Properties annotated with method NONE will never be synchronized with Gluon Cloud.

Method Summary

Modifier and Type	Method and Description
static SyncMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SyncMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SyncMethod NONE

Properties annotated with method NONE will never be synchronized with Gluon Cloud. Such a property can also be considered as a local property, because all the changes to that property remain local within the client application. This method can not be combined with any of the other methods.

AUTO

public static final SyncMethod AUTO

The AUTO method is a shorthand notation for AUTO_READ and AUTO_WRITE. This method can not be combined with NONE or any of the manual methods.

AUTO_READ

public static final SyncMethod AUTO_READ

Properties annotated with AUTO_READ will automatically receive all changes that occur to the value of the property on Gluon Cloud. This method can not be combined with NONE, MANUAL or MANUAL_READ.

AUTO_WRITE

public static final SyncMethod AUTO_WRITE

Properties annotated with AUTO_WRITE will automatically push all changes that occur to the value of the property to Gluon Cloud. This method can not be combined with NONE, MANUAL or MANUAL_WRITE.

MANUAL

public static final SyncMethod MANUAL

The MANUAL method is a shorthand notation for MANUAL_READ and MANUAL_WRITE. This method can not be combined with NONE or any of the auto methods.

MANUAL_READ

public static final SyncMethod MANUAL_READ

Properties annotated with AUTO_READ will only receive the value that is stored on Gluon Cloud when a sync operation is started. However, when retrieving a remote object for the first time, the value of the property will contain the value that was stored at that time on Gluon Cloud. This method can not be combined with NONE, AUTO or AUTO_READ.

MANUAL_WRITE

public static final SyncMethod MANUAL_WRITE

Properties annotated with AUTO_READ will only push their current value to Gluon Cloud when a sync operation is started. This method can not be combined with NONE, AUTO or AUTO_WRITE.

Method Detail

values

public static SyncMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SyncMethod c : SyncMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SyncMethod valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null