io.sphere.sdk.models.Reference Maven / Gradle / Ivy

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

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import javax.annotation.Nullable;

/**
 * A {@link io.sphere.sdk.models.Reference} is a loose reference to another resource on the SPHERE.IO platform.
 *
 * The reference may have a copy of the referenced object available via the method {@link io.sphere.sdk.models.Reference#getObj()}
 *
 * For equals, only the {@link Reference#getTypeId()} and {@link io.sphere.sdk.models.Reference#getId()} are compared used and {@link Reference#getObj()} will be ignored.
 *
 * @param  the type of the referenced object
 */
public final class Reference implements Referenceable, Identifiable {
    private final String typeId;
    private final String id;
    @Nullable
    private final T obj;

    @JsonCreator
    private Reference(final String typeId, final String id, @Nullable final T obj) {
        this.id = id;
        this.typeId = typeId;
        this.obj = obj;
    }

    /**
     * Id of the object this reference represents.
     * @return the id
     */
    public String getId() {
        return id;
    }

    /**
     * Type id of the object this reference represents, e.g. "customer".
     * @return the type id
     */
    public String getTypeId() {
        return typeId;
    }

    /**
     * The optional value of the referenced object.
     * @return The value of the referenced object or null.
     */
    @JsonIgnore
    @Nullable
    public T getObj() {
        return obj;
    }

    public Reference filled(@Nullable final T obj) {
        return new Reference<>(getTypeId(), getId(), obj);
    }

    public static  Reference of(final String typeId, final String id) {
        return new Reference<>(typeId, id, null);
    }

    public static  Reference of(final String typeId, final String id, T obj) {
        return Reference.of(typeId, id).filled(obj);
    }

    public static > Reference of(final String typeId, final T obj) {
        return Reference.of(typeId, obj.getId(), obj);
    }

    public boolean referencesSameResource(final Referenceable counterpart) {
        final Reference reference = counterpart.toReference();
        return reference.getId().equals(getId()) && reference.getTypeId().equals(getTypeId());
    }

    @Override
    public Reference toReference() {
        return this;
    }

    @Override
    public String toString() {
        return "Reference{" +
                "typeId='" + typeId + '\'' +
                ", id='" + id + '\'' +
                ", obj=" + obj +
                '}';
    }

    @SuppressWarnings("rawtypes")//at runtime generic type is not determinable
    @Override
    public final boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Reference reference = (Reference) o;

        if (!getId().equals(reference.getId())) return false;
        if (!getTypeId().equals(reference.getTypeId())) return false;

        return true;
    }

    @Override
    public final int hashCode() {
        //important, ignore obj hash code to match with equals
        return new HashCodeBuilder(17, 37).
                append(id).
                append(typeId).
                toHashCode();
    }
}