/*
 * 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.lucene.search;

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import org.apache.lucene.tests.util.LuceneTestCase;
import org.junit.Test;

public class TestFilterWeight extends LuceneTestCase {

  @Test
  public void testDeclaredMethodsOverridden() throws Exception {
    final Class<?> subClass = FilterWeight.class;
    implTestDeclaredMethodsOverridden(subClass.getSuperclass(), subClass);
  }

  private void implTestDeclaredMethodsOverridden(Class<?> superClass, Class<?> subClass)
      throws Exception {
    for (final Method superClassMethod : superClass.getDeclaredMethods()) {
      final int modifiers = superClassMethod.getModifiers();
      if (Modifier.isFinal(modifiers)) continue;
      if (Modifier.isStatic(modifiers)) continue;
      if (Arrays.asList("bulkScorer", "scorerSupplier", "count")
          .contains(superClassMethod.getName())) {
        try {
          final Method subClassMethod =
              subClass.getDeclaredMethod(
                  superClassMethod.getName(), superClassMethod.getParameterTypes());
          fail(
              subClass
                  + " must not override\n'"
                  + superClassMethod
                  + "'"
                  + " but it does override\n'"
                  + subClassMethod
                  + "'");
        } catch (
            @SuppressWarnings("unused")
            NoSuchMethodException e) {
          /* FilterWeight must not override the bulkScorer method
           * since as of July 2016 not all deriving classes use the
           * {code}return in.bulkScorer(content);{code}
           * implementation that FilterWeight.bulkScorer would use.
           */
          continue;
        }
      }
      try {
        final Method subClassMethod =
            subClass.getDeclaredMethod(
                superClassMethod.getName(), superClassMethod.getParameterTypes());
        assertEquals(
            "getReturnType() difference",
            superClassMethod.getReturnType(),
            subClassMethod.getReturnType());
      } catch (
          @SuppressWarnings("unused")
          NoSuchMethodException e) {
        fail(subClass + " needs to override '" + superClassMethod + "'");
      }
    }
  }
}
