com.google.common.truth.BooleanSubject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truth Show documentation

There is a newer version: 1.4.4

/*
 * Copyright (c) 2011 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 javax.annotation.Nullable;

/**
 * Propositions for boolean subjects.
 *
 * @author Christian Gruber ([email protected])
 */
public class BooleanSubject extends ComparableSubject {
  BooleanSubject(FailureStrategy failureStrategy, @Nullable Boolean subject) {
    super(failureStrategy, subject);
  }

  /**
   * @deprecated Use {@link #isEqualTo} instead. Boolean comparison is consistent with equality.
   */
  @Deprecated
  public final void isEquivalentAccordingToCompareTo(Boolean other) {
    super.isEquivalentAccordingToCompareTo(other);
  }

  /**
   * Fails if the subject is false.
   */
  public void isTrue() {
    if (getSubject() == null || !getSubject()) {
      failWithRawMessage("%s was expected to be true, but was false", booleanSubject());
    }
  }

  /**
   * Fails if the subject is true.
   */
  public void isFalse() {
    if (getSubject() == null || getSubject()) {
      failWithRawMessage("%s was expected to be false, but was true", booleanSubject());
    }
  }

  private String booleanSubject() {
    return internalCustomName() == null ? "The subject" : getDisplaySubject();
  }
}