ai.djl.repository.Restriction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Deep Java Library - api
There is a newer version: 0.30.0
/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
 * with the License. A copy of the License is located at
 *
 * http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package ai.djl.repository;

import java.util.Objects;

/**
 * A {@code Restriction} is a set of bounds on a {@link Version} that form a {@link VersionRange}.
 */
class Restriction {

    public static final Restriction EVERYTHING = new Restriction(null, false, null, false);

    private Version lowerBound;
    private boolean lowerBoundInclusive;
    private Version upperBound;
    private boolean upperBoundInclusive;

    /**
     * Constructs a Restriction from the bounds.
     *
     * @param lowerBound the lower bound
     * @param lowerBoundInclusive true if the lower bound is inclusive and not exclusive
     * @param upperBound the upper bound
     * @param upperBoundInclusive true if the upper bound is inclusive and not exclusive
     */
    public Restriction(
            Version lowerBound,
            boolean lowerBoundInclusive,
            Version upperBound,
            boolean upperBoundInclusive) {
        this.lowerBound = lowerBound;
        this.lowerBoundInclusive = lowerBoundInclusive;
        this.upperBound = upperBound;
        this.upperBoundInclusive = upperBoundInclusive;
    }

    /**
     * Returns the lower bound version (inclusive/exclusive depends on {@link
     * Restriction#isLowerBoundInclusive()}).
     *
     * @return the lower bound
     */
    public Version getLowerBound() {
        return lowerBound;
    }

    /**
     * Returns true if the lower bound is inclusive.
     *
     * @return true if the lower bound is inclusive
     */
    public boolean isLowerBoundInclusive() {
        return lowerBoundInclusive;
    }

    /**
     * Returns the upper bound version (inclusive/exclusive depends on {@link
     * Restriction#isUpperBoundInclusive()}).
     *
     * @return the upper bound
     */
    public Version getUpperBound() {
        return upperBound;
    }

    /**
     * Returns true if the upper bound is inclusive.
     *
     * @return true if the upper bound is inclusive
     */
    public boolean isUpperBoundInclusive() {
        return upperBoundInclusive;
    }

    /**
     * Returns true if the given version lies within the restriction bounds.
     *
     * @param version the version to check against
     * @return true if the version fits the bounds
     */
    public boolean containsVersion(Version version) {
        if (lowerBound != null) {
            int comparison = lowerBound.compareTo(version);

            if ((comparison == 0) && !lowerBoundInclusive) {
                return false;
            }
            if (comparison > 0) {
                return false;
            }
        }
        if (upperBound != null) {
            int comparison = upperBound.compareTo(version);

            if ((comparison == 0) && !upperBoundInclusive) {
                return false;
            }
            return comparison >= 0;
        }

        return true;
    }

    /** {@inheritDoc} */
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Restriction that = (Restriction) o;
        return lowerBoundInclusive == that.lowerBoundInclusive
                && upperBoundInclusive == that.upperBoundInclusive
                && Objects.equals(lowerBound, that.lowerBound)
                && Objects.equals(upperBound, that.upperBound);
    }

    /** {@inheritDoc} */
    @Override
    public int hashCode() {
        return Objects.hash(lowerBound, lowerBoundInclusive, upperBound, upperBoundInclusive);
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        StringBuilder buf = new StringBuilder();

        buf.append(isLowerBoundInclusive() ? '[' : '(');
        if (getLowerBound() != null) {
            buf.append(getLowerBound().toString());
        }
        buf.append(',');
        if (getUpperBound() != null) {
            buf.append(getUpperBound().toString());
        }
        buf.append(isUpperBoundInclusive() ? ']' : ')');

        return buf.toString();
    }
}