com.google.common.truth.GuavaOptionalSubject Maven / Gradle / Ivy
/*
* 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 static com.google.common.truth.Fact.fact;
import static com.google.common.truth.Fact.simpleFact;
import com.google.common.base.Optional;
import org.checkerframework.checker.nullness.compatqual.NullableDecl;
/**
* Propositions for Guava {@link Optional} subjects.
*
* If you are looking for a {@code java.util.Optional} subject, please read
* faq#java8
*
* @author Christian Gruber
*/
public final class GuavaOptionalSubject extends Subject> {
GuavaOptionalSubject(
FailureMetadata metadata,
@NullableDecl Optional actual,
@NullableDecl String typeDescription) {
super(metadata, actual, typeDescription);
}
/** Fails if the {@link Optional}{@code } is absent or the subject is null. */
public void isPresent() {
if (actual() == null) {
failWithActual(simpleFact("expected present optional"));
} else if (!actual().isPresent()) {
failWithoutActual(simpleFact("expected to be present"));
}
}
/** Fails if the {@link Optional}{@code } is present or the subject is null. */
public void isAbsent() {
if (actual() == null) {
failWithActual(simpleFact("expected absent optional"));
} else if (actual().isPresent()) {
failWithoutActual(
simpleFact("expected to be absent"), fact("but was present with value", actual().get()));
}
}
/**
* Fails if the {@link Optional}{@code } does not have the given value or the subject is null.
*
* To make more complex assertions on the optional's value split your assertion in two:
*
*
{@code
* assertThat(myOptional).isPresent();
* assertThat(myOptional.get()).contains("foo");
* }
*/
public void hasValue(Object expected) {
if (expected == null) {
throw new NullPointerException("Optional cannot have a null value.");
}
if (actual() == null) {
failWithActual("expected an optional with value", expected);
} else if (!actual().isPresent()) {
failWithoutActual(fact("expected to have value", expected), simpleFact("but was absent"));
} else {
checkNoNeedToDisplayBothValues("get()").that(actual().get()).isEqualTo(expected);
}
}
}