org.dmfs.jems2.hamcrest.matchers.throwable.ThrowableMatcher 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.throwable;

import org.hamcrest.Matcher;

import static org.dmfs.jems2.hamcrest.matchers.LambdaMatcher.having;
import static org.hamcrest.Matchers.*;


/**
 * A collection of {@link Matcher}s for {@link Throwable}s.
 * 
 * TODO: consider implementing a custom Matcher instead of using instanceOf to get better error messages
 */
public final class ThrowableMatcher
{
    @SafeVarargs
    public static Matcher throwable(Matcher... features)
    {
        return allOf(features);
    }


    public static Matcher throwable(Class exceptionClass)
    {
        return instanceOf(exceptionClass);
    }


    public static Matcher throwable(Class exceptionClass, Iterable> features)
    {
        return allOf(instanceOf(exceptionClass), allOf(features));
    }


    @SafeVarargs
    public static Matcher throwable(Class exceptionClass, Matcher... features)
    {
        return allOf(instanceOf(exceptionClass), allOf(features));
    }


    public static Matcher withMessage(Matcher messageMatcher)
    {
        return having("message", Throwable::getMessage, messageMatcher);
    }


    public static Matcher withMessage(String message)
    {
        return having("message", Throwable::getMessage, is(message));
    }


    public static Matcher causedBy(Matcher reasonMatcher)
    {
        return having("caused by", Throwable::getCause, reasonMatcher);
    }
}