io.sphere.sdk.customobjects

Class CustomObjectDraft<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.customobjects.CustomObjectDraft<T>

Type Parameters:

T - The type of the value of the custom object.

public final class CustomObjectDraft<T>
extends Base

A draft for creating or updating custom objects.

See Also:

CustomObjectUpsertCommand, CustomObject

Method Summary

Modifier and Type	Method and Description
String	getContainer()
com.fasterxml.jackson.databind.JavaType	getJavaType()
String	getKey()
T	getValue()
Long	getVersion()
static <T> CustomObjectDraft<T>	ofUnversionedUpdate(CustomObject<T> customObject, T newValue, Class<T> valueClass) Creates a draft for updating a custom object.
static <T> CustomObjectDraft<T>	ofUnversionedUpdate(CustomObject<T> customObject, T newValue, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Creates a draft for updating a custom object.
static CustomObjectDraft<com.fasterxml.jackson.databind.JsonNode>	ofUnversionedUpsert(String container, String key, com.fasterxml.jackson.databind.JsonNode value) Creates a draft for creating or updating a custom object.
static <T> CustomObjectDraft<T>	ofUnversionedUpsert(String container, String key, T value, Class<T> valueClass) Creates a draft for creating or updating a custom object.
static <T> CustomObjectDraft<T>	ofUnversionedUpsert(String container, String key, T value, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Creates a draft for creating or updating a custom object.
static <T> CustomObjectDraft<T>	ofVersionedUpdate(CustomObject<T> customObject, T newValue, Class<T> valueClass) Creates a draft for updating a custom object.
static <T> CustomObjectDraft<T>	ofVersionedUpdate(CustomObject<T> customObject, T newValue, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Creates a draft for updating a custom object.
static <T> CustomObjectDraft<T>	ofVersionedUpsert(String container, String key, T value, Long version, Class<T> valueClass) Creates a draft for creating or updating a custom object.
static <T> CustomObjectDraft<T>	ofVersionedUpsert(String container, String key, T value, Long version, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Creates a draft for creating or updating a custom object.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public T getValue()

ofVersionedUpdate

public static <T> CustomObjectDraft<T> ofVersionedUpdate(CustomObject<T> customObject,
                                                         T newValue,
                                                         com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Creates a draft for updating a custom object. Optimistic concurrency control is used.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

customObject - the custom object to override (provides key, container and version)

newValue - the value which should be assigned to the custom object

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

the draft

ofVersionedUpdate

public static <T> CustomObjectDraft<T> ofVersionedUpdate(CustomObject<T> customObject,
                                                         T newValue,
                                                         Class<T> valueClass)

Creates a draft for updating a custom object. Optimistic concurrency control is used.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

customObject - the custom object to override (provides key, container and version)

newValue - the value which should be assigned to the custom object

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

the draft

ofUnversionedUpdate

public static <T> CustomObjectDraft<T> ofUnversionedUpdate(CustomObject<T> customObject,
                                                           T newValue,
                                                           com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Creates a draft for updating a custom object. Does not use optimistic concurrency control so the last update wins.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

customObject - the custom object to override (provides key, container and version)

newValue - the value which should be assigned to the custom object

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

the draft

ofUnversionedUpdate

public static <T> CustomObjectDraft<T> ofUnversionedUpdate(CustomObject<T> customObject,
                                                           T newValue,
                                                           Class<T> valueClass)

Creates a draft for updating a custom object. Does not use optimistic concurrency control so the last update wins.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

customObject - the custom object to override (provides key, container and version)

newValue - the value which should be assigned to the custom object

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

the draft

ofUnversionedUpsert

public static <T> CustomObjectDraft<T> ofUnversionedUpsert(String container,
                                                           String key,
                                                           T value,
                                                           com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Creates a draft for creating or updating a custom object. Does not use optimistic concurrency control so the last update wins.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

container - the container

key - the key

value - the value which should be assigned to the custom object

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

the draft

ofUnversionedUpsert

public static <T> CustomObjectDraft<T> ofUnversionedUpsert(String container,
                                                           String key,
                                                           T value,
                                                           Class<T> valueClass)

Creates a draft for creating or updating a custom object. Does not use optimistic concurrency control so the last update wins.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

container - the container

key - the key

value - the value which should be assigned to the custom object

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

the draft

ofVersionedUpsert

public static <T> CustomObjectDraft<T> ofVersionedUpsert(String container,
                                                         String key,
                                                         T value,
                                                         Long version,
                                                         com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Creates a draft for creating or updating a custom object. Optimistic concurrency control is used.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

container - the container

key - the key

value - the value which should be assigned to the custom object

version - the version for optimistic locking

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

the draft

ofVersionedUpsert

public static <T> CustomObjectDraft<T> ofVersionedUpsert(String container,
                                                         String key,
                                                         T value,
                                                         Long version,
                                                         Class<T> valueClass)

Creates a draft for creating or updating a custom object. Optimistic concurrency control is used.

Type Parameters:

T - The type of the value of the custom object.

Parameters:

container - the container

key - the key

value - the value which should be assigned to the custom object

version - the version for optimistic locking

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

the draft

ofUnversionedUpsert

public static CustomObjectDraft<com.fasterxml.jackson.databind.JsonNode> ofUnversionedUpsert(String container,
                                                                                             String key,
                                                                                             com.fasterxml.jackson.databind.JsonNode value)

Creates a draft for creating or updating a custom object. Does not use optimistic concurrency control so the last update wins. It is an alias of CustomObjectDraft(String, String, Object, Long, com.fasterxml.jackson.core.type.TypeReference) with pure JSON as value for the custom object.

Parameters:

container - the container

key - the key

value - the value which should be assigned to the custom object

Returns:

the draft

getVersion

@Nullable
public Long getVersion()

getContainer

public String getContainer()

getKey

public String getKey()

getJavaType

public com.fasterxml.jackson.databind.JavaType getJavaType()