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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of models Show documentation

models

There is a newer version: 1.0.0-M12

package io.sphere.sdk.customobjects;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.models.DefaultModelView;
import io.sphere.sdk.models.Reference;
import io.sphere.sdk.models.Referenceable;

import java.util.Optional;

/**
 * Custom objects are a way to store arbitrary JSON-formatted data on the SPHERE.IO platform. It allows you to persist data that does not fit our standard data model.
 *
 * The storage can be seen as key value store but with an additional prefix called container to improve querying custom objects and provide an additional namespace.
 *
 * @param  The type of the value of this custom object.
 */
@JsonDeserialize(as = CustomObjectImpl.class)
public interface CustomObject extends DefaultModelView>, Referenceable> {

    /**
     * The container is part of the custom object namespace to find it
     * @return container
     */
    String getContainer();

    /**
     * The key is part of the custom object namespace to find it
     * @return container
     */
    String getKey();

    /**
     * The value stored in the custom object.
     * @return the value
     */
    T getValue();

    @SuppressWarnings("unchecked")
    @Override
    default Reference> toReference() {
        return Reference.of(typeId(), getId(), (CustomObject)this);
    }

    public static String typeId(){
        return "key-value-document";
    }

    public static String validatedKey(final String key) {
        return CustomObjectImpl.validatedKey("key", key);
    }

    public static String validatedContainer(final String container) {
        return CustomObjectImpl.validatedKey("container", container);
    }
}