org.elasticsearch.test.CheckedFunctionUtils Maven / Gradle / Ivy

Go to download

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

Elasticsearch subproject :test:framework

There is a newer version: 8.16.0

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.test;

import org.elasticsearch.common.CheckedSupplier;
import org.elasticsearch.core.CheckedFunction;

import static org.mockito.ArgumentMatchers.any;

/**
 * Test utilities for working with {@link CheckedFunction}s and {@link CheckedSupplier}s.
 */
public class CheckedFunctionUtils {

    /**
     * Returns a Mockito matcher for any argument that is an {@link CheckedFunction}.
     * @param  the function input type that the caller expects. Do not specify this, it will be inferred
     * @param  the function output type that the caller expects. Do not specify this, it will be inferred
     * @param  the function exception type that the caller expects. Do not specify this, it will be inferred
     * @return a checked function matcher
     */
    @SuppressWarnings("unchecked")
    public static  CheckedFunction anyCheckedFunction() {
        return any(CheckedFunction.class);
    }

    /**
     * Returns a Mockito matcher for any argument that is an {@link CheckedSupplier}.
     * @param  the supplier output type that the caller expects. Do not specify this, it will be inferred
     * @param  the supplier exception type that the caller expects. Do not specify this, it will be inferred
     * @return a checked supplier matcher
     */
    @SuppressWarnings("unchecked")
    public static  CheckedSupplier anyCheckedSupplier() {
        return any(CheckedSupplier.class);
    }
}