io.sphere.sdk.customobjects.queries.CustomObjectByKeyGet Maven / Gradle / Ivy

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.queries;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import io.sphere.sdk.customobjects.CustomObject;
import io.sphere.sdk.json.TypeReferences;
import io.sphere.sdk.queries.Get;

/**
 * {@link io.sphere.sdk.client.SphereRequest} to fetch one {@link io.sphere.sdk.customobjects.CustomObject} by container and key.
 *
 * {@include.example io.sphere.sdk.customobjects.queries.CustomObjectByKeyGetTest#execution()}
 *
 * @param  The type of the value of the custom object.
 * @see CustomObject
 */
public interface CustomObjectByKeyGet extends Get> {

    /**
     * Creates an object to fetch a custom object by the container and key with POJO mapping.
     * @param container container of the custom object to fetch
     * @param key key of the custom object to fetch
     * @param valueClass the class of the value, if it not uses generics like lists, typically for POJOs
     * @param  the type of the value in the custom object
     * @return query object
     */
    static  CustomObjectByKeyGet of(final String container, final String key, final Class valueClass) {
        return new CustomObjectByKeyGetImpl<>(container, key, valueClass);
    }

    /**
     * Creates an object to fetch a custom object by the container and key with POJO mapping.
     * @param container container of the custom object to fetch
     * @param key key of the custom object to fetch
     * @param valueTypeReference the type reference of the value of the custom object
     * @param  the type of the value in the custom object
     * @return query object
     */
    static  CustomObjectByKeyGet of(final String container, final String key, final TypeReference valueTypeReference) {
        return new CustomObjectByKeyGetImpl<>(container, key, valueTypeReference);
    }

    /**
     * Creates an object to fetch a custom object by the container and get the result as {@link JsonNode}.
     * @param container container of the custom object to fetch
     * @param key key of the custom object to fetch
     * @return query object
     */
    static CustomObjectByKeyGet ofJsonNode(final String container, final String key) {
        return of(container, key, TypeReferences.jsonNodeTypeReference());
    }

    /**
     * @deprecated use {@link #ofJsonNode(String, String)} instead
     * @param container container
     * @param key key
     * @return CustomObjectByKeyGet
     */
    @Deprecated
    static CustomObjectByKeyGet of(final String container, final String key) {
        return ofJsonNode(container, key);
    }
}