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 commercetools-models Show documentation
There is a newer version: 2.16.0
package io.sphere.sdk.customobjects;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonNode;
import io.sphere.sdk.json.TypeReferences;
import io.sphere.sdk.models.Base;

import javax.annotation.Nullable;

import static io.sphere.sdk.customobjects.CustomObjectUtils.getCustomObjectJavaTypeForValue;
import static io.sphere.sdk.json.SphereJsonUtils.convertToJavaType;

/**
 * A draft for creating or updating custom objects.
 * @param  The type of the value of the custom object.
 * @see io.sphere.sdk.customobjects.commands.CustomObjectUpsertCommand
 * @see CustomObject
 */
public final class CustomObjectDraft extends Base {

    private final T value;
    @Nullable
    private final Long version;
    private final JavaType javaType;//CustomObject
    private final String container;
    private final String key;

    private CustomObjectDraft(final String container, final String key, final T value, @Nullable final Long version, final Class valueClass) {
        this(container, key, value, version, convertToJavaType(valueClass));
    }

    private CustomObjectDraft(final String container, final String key, final T value, @Nullable final Long version, final TypeReference valueTypeReference) {
        this(container, key, value, version, convertToJavaType(valueTypeReference));
    }

    //only for use with T=JsonNode
    @SuppressWarnings("unchecked")
    @JsonCreator
    private CustomObjectDraft(final String container, final String key, final JsonNode value, @Nullable final Long version) {
        this.container = CustomObject.validatedContainer(container);
        this.key = CustomObject.validatedKey(key);
        this.value = (T) value;
        this.version = version;
        this.javaType = getCustomObjectJavaTypeForValue(convertToJavaType(JsonNode.class));
    }

    private CustomObjectDraft(final String container, final String key, final T value, @Nullable final Long version, final JavaType valueJavaType) {
        this.container = CustomObject.validatedContainer(container);
        this.key = CustomObject.validatedKey(key);
        this.value = value;
        this.version = version;
        this.javaType = getCustomObjectJavaTypeForValue(valueJavaType);
    }

    public T getValue() {
        return value;
    }

    /**
     * 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 valueTypeReference the type reference to deserialize the updated custom object from the platform 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 valueTypeReference) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, customObject.getVersion(), valueTypeReference);
    }

    /**
     * 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 valueClass the class of the value, if it not uses generics like lists, typically for POJOs
     * @param   The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofVersionedUpdate(final CustomObject customObject, final T newValue, final Class valueClass) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, customObject.getVersion(), valueClass);
    }

    /**
     * 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 valueTypeReference the type reference to deserialize the updated custom object from the platform 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 valueTypeReference) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, null, valueTypeReference);
    }

    /**
     * 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 valueClass the class of the value, if it not uses generics like lists, typically for POJOs
     * @param  The type of the value of the custom object.
     * @return the draft
     */
    public static  CustomObjectDraft ofUnversionedUpdate(final CustomObject customObject, final T newValue, final Class valueClass) {
        return new CustomObjectDraft<>(customObject.getContainer(), customObject.getKey(), newValue, null, valueClass);
    }


    /**
     * 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 valueTypeReference the type reference to deserialize the updated custom object from the platform 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 valueTypeReference) {
        return new CustomObjectDraft<>(container, key, value, null, valueTypeReference);
    }

    /**
     * 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 valueClass the class of the value, if it not uses generics like lists, typically for POJOs
     * @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 Class valueClass) {
        return new CustomObjectDraft<>(container, key, value, null, convertToJavaType(valueClass));
    }

    /**
     * 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 valueTypeReference the type reference to deserialize the updated custom object from the platform 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 valueTypeReference) {
        return new CustomObjectDraft<>(container, key, value, version, valueTypeReference);
    }

    /**
     * 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 valueClass the class of the value, if it not uses generics like lists, typically for POJOs
     * @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 Class valueClass) {
        return new CustomObjectDraft<>(container, key, value, version, valueClass);
    }

    /**
     * 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, TypeReferences.jsonNodeTypeReference());
    }

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

    public String getContainer() {
        return container;
    }

    public String getKey() {
        return key;
    }

    @JsonIgnore
    public JavaType getJavaType() {
        return javaType;
    }
}