testkit/src/main/java/org/apache/calcite/test/Unsafe.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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.apache.calcite.test;

import org.hamcrest.Matcher;

/**
 * Contains methods that call JDK methods that the
 * <a href="https://github.com/policeman-tools/forbidden-apis">forbidden
 * APIs checker</a> does not approve of.
 *
 * <p>This class is excluded from the check, so methods called via this class
 * will not fail the build.
 */
public class Unsafe {
  private Unsafe() {}

  /**
   * {@link Matcher#matches(Object)} is forbidden in regular test code in favour of
   * {@link org.hamcrest.MatcherAssert#assertThat}.
   * Note: {@code Matcher#matches} is still useful when testing matcher implementations.
   * @param matcher matcher
   * @param actual actual value
   * @return the result of matcher.matches(actual)
   */
  public static <T> boolean matches(Matcher<T> matcher, Object actual) {
    return matcher.matches(actual);
  }
}