io.sphere.sdk.search.Bound 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.search;

import io.sphere.sdk.models.Base;

/**
 * Represents one of the two possible bounds of a range or interval.
 * @param  type of the endpoint contained in the bound.
 */
public class Bound> extends Base {
    private final T endpoint;
    private final BoundType type;

    /**
     * Allows to define the bound type of a range.
     * A bound identified with INCLUSIVE type indicates the endpoint is included in the range.
     * A bound identified with EXCLUSIVE type indicates the endpoint is excluded in the range.
     */
    private static enum BoundType {
        INCLUSIVE,
        EXCLUSIVE
    }

    private Bound(final T endpoint, final BoundType type) {
        this.endpoint = endpoint;
        this.type = type;
    }

    public T endpoint() {
        return endpoint;
    }

    /**
     * Determines whether the endpoint is excluded from the range or included.
     * @return true if the bound is exclusive, false if it is inclusive.
     */
    public boolean isExclusive() {
        return type.equals(BoundType.EXCLUSIVE);
    }

    /**
     * Determines whether the endpoint is included from the range or excluded.
     * @return true if the bound is inclusive, false if it is exclusive.
     */
    public boolean isInclusive() {
        return !isExclusive();
    }

    /**
     * Generates a bound with the same characteristics of the current bound but with the given endpoint instead.
     * @param endpoint for the new bound.
     * @return the new bound based on the current bound but with the provided endpoint.
     */
    public Bound withEndpoint(final T endpoint) {
        return new Bound<>(endpoint, type);
    }

    /**
     * Creates a bound with the given endpoint, excluded from the range.
     * @param endpoint the endpoint value of the given type T.
     * @param  type of the endpoint.
     * @return the exclusive bound with the endpoint.
     */
    public static > Bound exclusive(T endpoint) {
        return new Bound<>(endpoint, BoundType.EXCLUSIVE);
    }

    /**
     * Creates a bound with the given endpoint, included from the range.
     * @param endpoint the endpoint value of the given type T.
     * @param  type of the endpoint.
     * @return the inclusive bound with the endpoint.
     */
     public static > Bound inclusive(T endpoint) {
        return new Bound<>(endpoint, BoundType.INCLUSIVE);
    }
}