io.sphere.sdk.customobjects.CustomObjectDraft Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation
sphere-models
There is a newer version: 1.0.0-M26
package io.sphere.sdk.customobjects;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import io.sphere.sdk.models.Base;

import javax.annotation.Nullable;

/**
 * A draft for creating or updating custom objects.
 * @param  The type of the value of the custom object.
 */
public class CustomObjectDraft extends Base {
    private static final TypeReference> JSON_NODE_TYPE_REFERENCE = new TypeReference>() {
        @Override
        public String toString() {
            return "TypeReference>";
        }
    };

    private final T value;
    @Nullable
    private final Long version;
    private final TypeReference> typeReference;
    private final String container;
    private final String key;

    private CustomObjectDraft(final String container, final String key, final T value, @Nullable final Long version, final TypeReference> typeReference) {
        this.container = CustomObject.validatedContainer(container);
        this.key = CustomObject.validatedKey(key);
        this.value = value;
        this.version = version;
        this.typeReference = typeReference;
    }

    public T getValue() {
        return value;
    }

    public TypeReference> typeReference() {
        return typeReference;
    }

    /**
     * Creates a draft for updating a custom object. Optimistic concurrency control is used.
     * @param customObject the custom object to override (provides key, container and version)
     * @param newValue the value which should be assigned to the custom object
     * @param typeReference the type reference to deserialize the updated custom object from the SPHERE.IO response
     * @param   The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofVersionedUpdate(final CustomObject customObject, final T newValue, final TypeReference> typeReference) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, customObject.getVersion(), typeReference);
    }

    /**
     * Creates a draft for updating a custom object. Does not use optimistic concurrency control so the last update wins.
     * @param customObject the custom object to override (provides key, container and version)
     * @param newValue the value which should be assigned to the custom object
     * @param typeReference the type reference to deserialize the updated custom object from the SPHERE.IO response
     * @param  The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofUnversionedUpdate(final CustomObject customObject, final T newValue, final TypeReference> typeReference) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, null, typeReference);
    }


    /**
     * Creates a draft for creating or updating a custom object. Does not use optimistic concurrency control so the last update wins.
     * @param container the container
     * @param key the key
     * @param value the value which should be assigned to the custom object
     * @param typeReference the type reference to deserialize the updated custom object from the SPHERE.IO response
     * @param  The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofUnversionedUpsert(final String container, final String key, final T value, final TypeReference> typeReference) {
        return new CustomObjectDraft<>(container, key, value, null, typeReference);
    }

    /**
     * Creates a draft for creating or updating a custom object. Optimistic concurrency control is used.
     * @param container the container
     * @param key the key
     * @param value the value which should be assigned to the custom object
     * @param version the version for optimistic locking
     * @param typeReference the type reference to deserialize the updated custom object from the SPHERE.IO response
     * @param  The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofVersionedUpsert(final String container, final String key, final T value, final long version, final TypeReference> typeReference) {
        return new CustomObjectDraft<>(container, key, value, version, typeReference);
    }

    /**
     * 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
     * {@link CustomObjectDraft#CustomObjectDraft(String, String, Object, Long, com.fasterxml.jackson.core.type.TypeReference)}
     * with pure JSON as value for the custom object.
     *
     * @param container the container
     * @param key the key
     * @param value the value which should be assigned to the custom object
     * @return the draft
     */
    public static CustomObjectDraft ofUnversionedUpsert(final String container, final String key, final JsonNode value) {
        return ofUnversionedUpsert(container, key, value, JSON_NODE_TYPE_REFERENCE);
    }

    @Nullable
    public Long getVersion() {
        return version;
    }

    /**
     * Copies this {@link io.sphere.sdk.customobjects.CustomObjectDraft} and sets the version to {@code version} to use optimistic locking.
     *
     * @param version the version of the current stored custom object in SPHERE.IO.
     * @return a draft which provides optimistic locking
     */
    public CustomObjectDraft withVersion(final long version) {
        return new CustomObjectDraft<>(getContainer(), getKey(), getValue(), version, typeReference());
    }

    public String getContainer() {
        return container;
    }

    public String getKey() {
        return key;
    }
}