com.google.common.truth.ComparableSubject.java Source code

Introduction

Here is the source code for com.google.common.truth.ComparableSubject.java

Source

/*
 * Copyright (c) 2014 Google, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 com.google.common.truth;

import com.google.common.collect.Range;
import org.checkerframework.checker.nullness.compatqual.NullableDecl;

/**
 * Propositions for {@link Comparable} typed subjects.
 *
 * @author Kurt Alfred Kluever
 * @param <T> the type of the object being tested by this {@code ComparableSubject}
 */
public abstract class ComparableSubject<T extends Comparable> extends Subject {
    /**
     * Constructor for use by subclasses. If you want to create an instance of this class itself, call
     * {@link Subject#check(String, Object..) check(...)}{@code .that(actual)}.
     */
    private final T actual;

    protected ComparableSubject(FailureMetadata metadata, @NullableDecl T actual) {
        super(metadata, actual);
        this.actual = actual;
    }

    /** Checks that the subject is in {@code range}. */
    public final void isIn(Range<T> range) {
        if (!range.contains(actual)) {
            failWithActual("expected to be in range", range);
        }
    }

    /** Checks that the subject is <i>not</i> in {@code range}. */
    public final void isNotIn(Range<T> range) {
        if (range.contains(actual)) {
            failWithActual("expected not to be in range", range);
        }
    }

    /**
     * Checks that the subject is equivalent to {@code other} according to {@link
     * Comparable#compareTo}, (i.e., checks that {@code a.comparesTo(b) == 0}).
     *
     * <p><b>Note:</b> Do not use this method for checking object equality. Instead, use {@link
     * #isEqualTo(Object)}.
     */
    public void isEquivalentAccordingToCompareTo(T expected) {
        if (actual.compareTo(expected) != 0) {
            failWithActual("expected value that sorts equal to", expected);
        }
    }

    /**
     * Checks that the subject is greater than {@code other}.
     *
     * <p>To check that the subject is greater than <i>or equal to</i> {@code other}, use {@link
     * #isAtLeast}.
     */
    public final void isGreaterThan(T other) {
        if (actual.compareTo(other) <= 0) {
            failWithActual("expected to be greater than", other);
        }
    }

    /**
     * Checks that the subject is less than {@code other}.
     *
     * <p>To check that the subject is less than <i>or equal to</i> {@code other}, use {@link
     * #isAtMost}.
     */
    public final void isLessThan(T other) {
        if (actual.compareTo(other) >= 0) {
            failWithActual("expected to be less than", other);
        }
    }

    /**
     * Checks that the subject is less than or equal to {@code other}.
     *
     * <p>To check that the subject is <i>strictly</i> less than {@code other}, use {@link
     * #isLessThan}.
     */
    public final void isAtMost(T other) {
        if (actual.compareTo(other) > 0) {
            failWithActual("expected to be at most", other);
        }
    }

    /**
     * Checks that the subject is greater than or equal to {@code other}.
     *
     * <p>To check that the subject is <i>strictly</i> greater than {@code other}, use {@link
     * #isGreaterThan}.
     */
    public final void isAtLeast(T other) {
        if (actual.compareTo(other) < 0) {
            failWithActual("expected to be at least", other);
        }
    }
}