org.dmfs.jems2.hamcrest.matchers.matcher.DescriptionMatcher 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.matcher;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.StringDescription;
import org.hamcrest.TypeSafeDiagnosingMatcher;


/**
 * A {@link Matcher} to test the description of another {@link Matcher}.
 */
public final class DescriptionMatcher> extends TypeSafeDiagnosingMatcher
{
    private final Matcher mDescriptionMatcher;


    public DescriptionMatcher(Matcher descriptionMatcher)
    {
        mDescriptionMatcher = descriptionMatcher;
    }


    @Override
    protected boolean matchesSafely(T item, Description mismatchDescription)
    {
        Description description = new StringDescription();
        item.describeTo(description);
        if (!mDescriptionMatcher.matches(description.toString()))
        {
            mismatchDescription.appendText("description ");
            mDescriptionMatcher.describeMismatch(description.toString(), mismatchDescription);
            return false;
        }
        return true;
    }


    @Override
    public void describeTo(Description description)
    {
        description.appendText("description ");
        mDescriptionMatcher.describeTo(description);
    }
}