org.dmfs.jems2.hamcrest.matchers.optional.PresentMatcher Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 dmfs GmbH
 *
 *
 * 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 org.dmfs.jems2.hamcrest.matchers.optional;

import org.dmfs.jems2.Optional;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeDiagnosingMatcher;
import org.hamcrest.core.IsAnything;
import org.hamcrest.core.IsEqual;

import static org.hamcrest.Matchers.equalTo;


/**
 * A {@link Matcher} to match the presence and value of an {@link Optional}.
 */
public final class PresentMatcher extends TypeSafeDiagnosingMatcher>
{
    private final Matcher mDelegate;


    public PresentMatcher()
    {
        this(new IsAnything());
    }


    public PresentMatcher(T expected)
    {
        this(new IsEqual<>(expected));
    }


    public PresentMatcher(Matcher delegate)
    {
        mDelegate = delegate;
    }


    public static  PresentMatcher present()
    {
        return new PresentMatcher<>();
    }


    public static  PresentMatcher present(T expectedValue)
    {
        return new PresentMatcher<>(equalTo(expectedValue));
    }


    public static  PresentMatcher present(Matcher delegate)
    {
        return new PresentMatcher<>(delegate);
    }


    @Override
    protected boolean matchesSafely(Optional item, Description mismatchDescription)
    {
        if (!item.isPresent())
        {
            mismatchDescription.appendText("not present");
            return false;
        }

        if (!mDelegate.matches(item.value()))
        {
            mismatchDescription.appendText("present, but value ");
            mDelegate.describeMismatch(item.value(), mismatchDescription);
            return false;
        }

        return true;
    }


    @Override
    public void describeTo(Description description)
    {
        description.appendText("present with value ");
        mDelegate.describeTo(description);
    }
}