Remove some redundant modifiers from code (#12880)

This commit is contained in:
Shubham Chaudhary 2023-12-11 23:47:47 +05:30 committed by GitHub
parent c0fd4404ea
commit 1630ed4bd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 60 additions and 60 deletions

View File

@ -528,7 +528,7 @@ public class TestCompoundWordTokenFilter extends BaseTokenStreamTestCase {
assertTokenStreamContents(tf8, new String[] {"fußball"}); assertTokenStreamContents(tf8, new String[] {"fußball"});
} }
public static interface MockRetainAttribute extends Attribute { public interface MockRetainAttribute extends Attribute {
void setRetain(boolean attr); void setRetain(boolean attr);
boolean getRetain(); boolean getRetain();

View File

@ -112,7 +112,7 @@ public abstract sealed class IndexReader implements Closeable permits CompositeR
* *
* @lucene.experimental * @lucene.experimental
*/ */
public static interface CacheHelper { public interface CacheHelper {
/** /**
* Get a key that the resource can be cached on. The given entry can be compared using identity, * Get a key that the resource can be cached on. The given entry can be compared using identity,
@ -139,7 +139,7 @@ public abstract sealed class IndexReader implements Closeable permits CompositeR
* @lucene.experimental * @lucene.experimental
*/ */
@FunctionalInterface @FunctionalInterface
public static interface ClosedListener { public interface ClosedListener {
/** /**
* Invoked when the resource (segment core, or index reader) that is being cached on is closed. * Invoked when the resource (segment core, or index reader) that is being cached on is closed.
*/ */

View File

@ -34,10 +34,10 @@ import org.apache.lucene.util.BytesRef;
public interface IndexableField { public interface IndexableField {
/** Field name */ /** Field name */
public String name(); String name();
/** {@link IndexableFieldType} describing the properties of this field. */ /** {@link IndexableFieldType} describing the properties of this field. */
public IndexableFieldType fieldType(); IndexableFieldType fieldType();
/** /**
* Creates the TokenStream used for indexing this field. If appropriate, implementations should * Creates the TokenStream used for indexing this field. If appropriate, implementations should
@ -52,13 +52,13 @@ public interface IndexableField {
* @return TokenStream value for indexing the document. Should always return a non-null value if * @return TokenStream value for indexing the document. Should always return a non-null value if
* the field is to be indexed * the field is to be indexed
*/ */
public TokenStream tokenStream(Analyzer analyzer, TokenStream reuse); TokenStream tokenStream(Analyzer analyzer, TokenStream reuse);
/** Non-null if this field has a binary value */ /** Non-null if this field has a binary value */
public BytesRef binaryValue(); BytesRef binaryValue();
/** Non-null if this field has a string value */ /** Non-null if this field has a string value */
public String stringValue(); String stringValue();
/** Non-null if this field has a string value */ /** Non-null if this field has a string value */
default CharSequence getCharSequenceValue() { default CharSequence getCharSequenceValue() {
@ -66,20 +66,20 @@ public interface IndexableField {
} }
/** Non-null if this field has a Reader value */ /** Non-null if this field has a Reader value */
public Reader readerValue(); Reader readerValue();
/** Non-null if this field has a numeric value */ /** Non-null if this field has a numeric value */
public Number numericValue(); Number numericValue();
/** /**
* Stored value. This method is called to populate stored fields and must return a non-null value * Stored value. This method is called to populate stored fields and must return a non-null value
* if the field stored. * if the field stored.
*/ */
public StoredValue storedValue(); StoredValue storedValue();
/** /**
* Describes how this field should be inverted. This must return a non-null value if the field * Describes how this field should be inverted. This must return a non-null value if the field
* indexes terms and postings. * indexes terms and postings.
*/ */
public InvertableType invertableType(); InvertableType invertableType();
} }

View File

@ -31,19 +31,19 @@ public interface TwoPhaseCommit {
* method, but avoid actual committing changes. If the 2-phase commit fails, {@link #rollback()} * method, but avoid actual committing changes. If the 2-phase commit fails, {@link #rollback()}
* is called to discard all changes since last successful commit. * is called to discard all changes since last successful commit.
*/ */
public long prepareCommit() throws IOException; long prepareCommit() throws IOException;
/** /**
* The second phase of a 2-phase commit. Implementations should ideally do very little work in * The second phase of a 2-phase commit. Implementations should ideally do very little work in
* this method (following {@link #prepareCommit()}, and after it returns, the caller can assume * this method (following {@link #prepareCommit()}, and after it returns, the caller can assume
* that the changes were successfully committed to the underlying storage. * that the changes were successfully committed to the underlying storage.
*/ */
public long commit() throws IOException; long commit() throws IOException;
/** /**
* Discards any changes that have occurred since the last commit. In a 2-phase commit algorithm, * Discards any changes that have occurred since the last commit. In a 2-phase commit algorithm,
* where one of the objects failed to {@link #commit()} or {@link #prepareCommit()}, this method * where one of the objects failed to {@link #commit()} or {@link #prepareCommit()}, this method
* is used to roll all other objects back to their previous state. * is used to roll all other objects back to their previous state.
*/ */
public void rollback() throws IOException; void rollback() throws IOException;
} }

View File

@ -121,12 +121,12 @@ public abstract class LMSimilarity extends SimilarityBase {
} }
/** A strategy for computing the collection language model. */ /** A strategy for computing the collection language model. */
public static interface CollectionModel { public interface CollectionModel {
/** /**
* Computes the probability {@code p(w|C)} according to the language model strategy for the * Computes the probability {@code p(w|C)} according to the language model strategy for the
* current term. * current term.
*/ */
public double computeProbability(BasicStats stats); double computeProbability(BasicStats stats);
/** The name of the collection model strategy. */ /** The name of the collection model strategy. */
public String getName(); public String getName();

View File

@ -39,7 +39,7 @@ final class ByteBufferGuard {
* this to allow unmapping of bytebuffers with private Java APIs. * this to allow unmapping of bytebuffers with private Java APIs.
*/ */
@FunctionalInterface @FunctionalInterface
static interface BufferCleaner { interface BufferCleaner {
void freeBuffer(String resourceDescription, ByteBuffer b) throws IOException; void freeBuffer(String resourceDescription, ByteBuffer b) throws IOException;
} }

View File

@ -264,7 +264,7 @@ public class MMapDirectory extends FSDirectory {
*/ */
public static final String UNMAP_NOT_SUPPORTED_REASON; public static final String UNMAP_NOT_SUPPORTED_REASON;
static interface MMapIndexInputProvider { interface MMapIndexInputProvider {
IndexInput openInput(Path path, IOContext context, int chunkSizePower, boolean preload) IndexInput openInput(Path path, IOContext context, int chunkSizePower, boolean preload)
throws IOException; throws IOException;

View File

@ -26,14 +26,14 @@ import org.apache.lucene.util.BitUtil; // javadocs
public interface RandomAccessInput { public interface RandomAccessInput {
/** The number of bytes in the file. */ /** The number of bytes in the file. */
public long length(); long length();
/** /**
* Reads a byte at the given position in the file * Reads a byte at the given position in the file
* *
* @see DataInput#readByte * @see DataInput#readByte
*/ */
public byte readByte(long pos) throws IOException; byte readByte(long pos) throws IOException;
/** /**
* Reads a specified number of bytes starting at a given position into an array at the specified * Reads a specified number of bytes starting at a given position into an array at the specified
@ -53,7 +53,7 @@ public interface RandomAccessInput {
* @see DataInput#readShort * @see DataInput#readShort
* @see BitUtil#VH_LE_SHORT * @see BitUtil#VH_LE_SHORT
*/ */
public short readShort(long pos) throws IOException; short readShort(long pos) throws IOException;
/** /**
* Reads an integer (LE byte order) at the given position in the file * Reads an integer (LE byte order) at the given position in the file
@ -61,7 +61,7 @@ public interface RandomAccessInput {
* @see DataInput#readInt * @see DataInput#readInt
* @see BitUtil#VH_LE_INT * @see BitUtil#VH_LE_INT
*/ */
public int readInt(long pos) throws IOException; int readInt(long pos) throws IOException;
/** /**
* Reads a long (LE byte order) at the given position in the file * Reads a long (LE byte order) at the given position in the file
@ -69,5 +69,5 @@ public interface RandomAccessInput {
* @see DataInput#readLong * @see DataInput#readLong
* @see BitUtil#VH_LE_LONG * @see BitUtil#VH_LE_LONG
*/ */
public long readLong(long pos) throws IOException; long readLong(long pos) throws IOException;
} }

View File

@ -714,7 +714,7 @@ public final class ArrayUtil {
/** Comparator for a fixed number of bytes. */ /** Comparator for a fixed number of bytes. */
@FunctionalInterface @FunctionalInterface
public static interface ByteArrayComparator { public interface ByteArrayComparator {
/** /**
* Compare bytes starting from the given offsets. The return value has the same contract as * Compare bytes starting from the given offsets. The return value has the same contract as

View File

@ -30,5 +30,5 @@ public interface AttributeReflector {
* method once using {@code org.apache.lucene.analysis.tokenattributes.CharTermAttribute.class} as * method once using {@code org.apache.lucene.analysis.tokenattributes.CharTermAttribute.class} as
* attribute class, {@code "term"} as key and the actual value as a String. * attribute class, {@code "term"} as key and the actual value as a String.
*/ */
public void reflect(Class<? extends Attribute> attClass, String key, Object value); void reflect(Class<? extends Attribute> attClass, String key, Object value);
} }

View File

@ -32,7 +32,7 @@ public interface ClassLoaderUtils {
* returned (this is fine, because if we get a {@code SecurityException} it is for sure no * returned (this is fine, because if we get a {@code SecurityException} it is for sure no
* parent). * parent).
*/ */
public static boolean isParentClassLoader(final ClassLoader parent, final ClassLoader child) { static boolean isParentClassLoader(final ClassLoader parent, final ClassLoader child) {
try { try {
ClassLoader cl = child; ClassLoader cl = child;
while (cl != null) { while (cl != null) {

View File

@ -127,7 +127,7 @@ public final class NamedSPILoader<S extends NamedSPILoader.NamedSPI> implements
* *
* <p>Names must be all ascii alphanumeric, and less than 128 characters in length. * <p>Names must be all ascii alphanumeric, and less than 128 characters in length.
*/ */
public static interface NamedSPI { public interface NamedSPI {
String getName(); String getName();
} }
} }

View File

@ -23,14 +23,14 @@ import java.io.InputStream;
public interface ResourceLoader { public interface ResourceLoader {
/** Opens a named resource */ /** Opens a named resource */
public InputStream openResource(String resource) throws IOException; InputStream openResource(String resource) throws IOException;
/** Finds class of the name and expected type */ /** Finds class of the name and expected type */
public <T> Class<? extends T> findClass(String cname, Class<T> expectedType); <T> Class<? extends T> findClass(String cname, Class<T> expectedType);
/** Creates an instance of the name and expected type */ /** Creates an instance of the name and expected type */
// TODO: fix exception handling // TODO: fix exception handling
public default <T> T newInstance(String cname, Class<T> expectedType) { default <T> T newInstance(String cname, Class<T> expectedType) {
Class<? extends T> clazz = findClass(cname, expectedType); Class<? extends T> clazz = findClass(cname, expectedType);
try { try {
return clazz.getConstructor().newInstance(); return clazz.getConstructor().newInstance();

View File

@ -24,8 +24,8 @@ package org.apache.lucene.util;
public abstract class RollingBuffer<T extends RollingBuffer.Resettable> { public abstract class RollingBuffer<T extends RollingBuffer.Resettable> {
/** Implement to reset an instance */ /** Implement to reset an instance */
public static interface Resettable { public interface Resettable {
public void reset(); void reset();
} }
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

View File

@ -29,7 +29,7 @@ public interface Unwrappable<T> {
/** Unwraps all {@code Unwrappable}s around the given object. */ /** Unwraps all {@code Unwrappable}s around the given object. */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public static <T> T unwrapAll(T o) { static <T> T unwrapAll(T o) {
while (o instanceof Unwrappable) { while (o instanceof Unwrappable) {
o = ((Unwrappable<T>) o).unwrap(); o = ((Unwrappable<T>) o).unwrap();
} }

View File

@ -45,5 +45,5 @@ public interface AutomatonProvider {
* @return automaton * @return automaton
* @throws IOException if errors occur * @throws IOException if errors occur
*/ */
public Automaton getAutomaton(String name) throws IOException; Automaton getAutomaton(String name) throws IOException;
} }

View File

@ -68,7 +68,7 @@ final class BKDUtil {
/** Predicate for a fixed number of bytes. */ /** Predicate for a fixed number of bytes. */
@FunctionalInterface @FunctionalInterface
public static interface ByteArrayPredicate { public interface ByteArrayPredicate {
/** Test bytes starting from the given offsets. */ /** Test bytes starting from the given offsets. */
boolean test(byte[] a, int aOffset, byte[] b, int bOffset); boolean test(byte[] a, int aOffset, byte[] b, int bOffset);

View File

@ -120,7 +120,7 @@ public class PackedInts {
throw new IllegalArgumentException("Unknown format id: " + id); throw new IllegalArgumentException("Unknown format id: " + id);
} }
private Format(int id) { Format(int id) {
this.id = id; this.id = id;
} }
@ -231,7 +231,7 @@ public class PackedInts {
} }
/** A decoder for packed integers. */ /** A decoder for packed integers. */
public static interface Decoder { public interface Decoder {
/** /**
* The minimum number of long blocks to encode in a single iteration, when using long encoding. * The minimum number of long blocks to encode in a single iteration, when using long encoding.
@ -299,7 +299,7 @@ public class PackedInts {
} }
/** An encoder for packed integers. */ /** An encoder for packed integers. */
public static interface Encoder { public interface Encoder {
/** /**
* The minimum number of long blocks to encode in a single iteration, when using long encoding. * The minimum number of long blocks to encode in a single iteration, when using long encoding.
@ -400,7 +400,7 @@ public class PackedInts {
} }
/** Run-once iterator interface, to decode previously saved PackedInts. */ /** Run-once iterator interface, to decode previously saved PackedInts. */
public static interface ReaderIterator { public interface ReaderIterator {
/** Returns next value */ /** Returns next value */
long next() throws IOException; long next() throws IOException;

View File

@ -221,7 +221,7 @@ public class TestBoolean2 extends LuceneTestCase {
bigSearcher = null; bigSearcher = null;
} }
private static String[] docFields = { private static final String[] docFields = {
"w1 w2 w3 w4 w5", "w1 w3 w2 w3", "w1 xx w2 yy w3", "w1 w3 xx w2 yy mm" "w1 w2 w3 w4 w5", "w1 w3 w2 w3", "w1 xx w2 yy w3", "w1 w3 xx w2 yy mm"
}; };
@ -423,8 +423,8 @@ public class TestBoolean2 extends LuceneTestCase {
// used to set properties or change every BooleanQuery // used to set properties or change every BooleanQuery
// generated from randBoolQuery. // generated from randBoolQuery.
public static interface Callback { public interface Callback {
public void postCreate(BooleanQuery.Builder q); void postCreate(BooleanQuery.Builder q);
} }
// Random rnd is passed in so that the exact same random query may be created // Random rnd is passed in so that the exact same random query may be created

View File

@ -27,7 +27,7 @@ import org.apache.lucene.search.SimpleCollector;
abstract class DocValuesTermsCollector<DV> extends SimpleCollector { abstract class DocValuesTermsCollector<DV> extends SimpleCollector {
@FunctionalInterface @FunctionalInterface
static interface Function<R> { interface Function<R> {
R apply(LeafReader t) throws IOException; R apply(LeafReader t) throws IOException;
} }

View File

@ -41,7 +41,7 @@ public class TestQueryTreeBuilder extends LuceneTestCase {
assertEquals("OK", result); assertEquals("OK", result);
} }
private static interface DummyQueryNodeInterface extends QueryNode {} private interface DummyQueryNodeInterface extends QueryNode {}
private abstract static class AbstractDummyQueryNode extends QueryNodeImpl private abstract static class AbstractDummyQueryNode extends QueryNodeImpl
implements DummyQueryNodeInterface {} implements DummyQueryNodeInterface {}

View File

@ -80,17 +80,17 @@ public abstract class NumberRangePrefixTree extends SpatialPrefixTree {
* *
* @lucene.experimental * @lucene.experimental
*/ */
public static interface NRShape extends Shape, Cloneable { public interface NRShape extends Shape, Cloneable {
/** The result should be parseable by {@link #parseShape(String)}. */ /** The result should be parseable by {@link #parseShape(String)}. */
@Override @Override
abstract String toString(); String toString();
/** /**
* Returns this shape rounded to the target level. If we are already more course than the level * Returns this shape rounded to the target level. If we are already more course than the level
* then the shape is simply returned. The result may refer to internal state of the argument so * then the shape is simply returned. The result may refer to internal state of the argument so
* you may want to clone it. * you may want to clone it.
*/ */
public NRShape roundToLevel(int targetLevel); NRShape roundToLevel(int targetLevel);
} }
// //
@ -234,7 +234,7 @@ public abstract class NumberRangePrefixTree extends SpatialPrefixTree {
* *
* @lucene.experimental * @lucene.experimental
*/ */
public static interface UnitNRShape extends NRShape, Comparable<UnitNRShape> { public interface UnitNRShape extends NRShape, Comparable<UnitNRShape> {
// note: formerly known as LevelledValue; thus some variables still use 'lv' // note: formerly known as LevelledValue; thus some variables still use 'lv'
/** Get the prefix tree level, the higher the more precise. 0 means the world (universe). */ /** Get the prefix tree level, the higher the more precise. 0 means the world (universe). */

View File

@ -1120,12 +1120,12 @@ class GeoComplexPolygon extends GeoBasePolygon {
* into the traversal method of a tree, and each edge that matches will cause this object to be * into the traversal method of a tree, and each edge that matches will cause this object to be
* called. * called.
*/ */
private static interface EdgeIterator { private interface EdgeIterator {
/** /**
* @param edge is the edge that matched. * @param edge is the edge that matched.
* @return true if the iteration should continue, false otherwise. * @return true if the iteration should continue, false otherwise.
*/ */
public boolean matches(final Edge edge); boolean matches(final Edge edge);
} }
/** /**
@ -1133,16 +1133,16 @@ class GeoComplexPolygon extends GeoBasePolygon {
* implementing this interface into the traversal method of a tree, and each edge that matches * implementing this interface into the traversal method of a tree, and each edge that matches
* will cause this object to be called. * will cause this object to be called.
*/ */
private static interface CountingEdgeIterator extends EdgeIterator { private interface CountingEdgeIterator extends EdgeIterator {
/** /**
* @return the number of edges that were crossed. * @return the number of edges that were crossed.
*/ */
public int getCrossingCount(); int getCrossingCount();
/** /**
* @return true if the endpoint was on an edge. * @return true if the endpoint was on an edge.
*/ */
public boolean isOnEdge(); boolean isOnEdge();
} }
/** /**

View File

@ -100,8 +100,8 @@ public final class SuggestRebuildTestUtil {
* Simple marker interface to allow {@link #testLookupsDuringReBuild} callbacks to throw * Simple marker interface to allow {@link #testLookupsDuringReBuild} callbacks to throw
* Exceptions * Exceptions
*/ */
public static interface ExceptionalCallback { public interface ExceptionalCallback {
public void check(final Lookup suggester) throws Exception; void check(final Lookup suggester) throws Exception;
} }
/** /**

View File

@ -90,7 +90,7 @@ public abstract class BaseTokenStreamTestCase extends LuceneTestCase {
* Attribute that records if it was cleared or not. This is used for testing that * Attribute that records if it was cleared or not. This is used for testing that
* clearAttributes() was called correctly. * clearAttributes() was called correctly.
*/ */
public static interface CheckClearAttributesAttribute extends Attribute { public interface CheckClearAttributesAttribute extends Attribute {
boolean getAndResetClearCalled(); boolean getAndResetClearCalled();
} }
@ -129,7 +129,7 @@ public abstract class BaseTokenStreamTestCase extends LuceneTestCase {
@Override @Override
public void copyTo(AttributeImpl target) { public void copyTo(AttributeImpl target) {
((CheckClearAttributesAttributeImpl) target).clear(); target.clear();
} }
@Override @Override

View File

@ -30,7 +30,7 @@ import org.junit.runners.model.Statement;
*/ */
public final class TestRuleIgnoreTestSuites implements TestRule { public final class TestRuleIgnoreTestSuites implements TestRule {
/** Marker interface for nested suites that should be ignored if executed in stand-alone mode. */ /** Marker interface for nested suites that should be ignored if executed in stand-alone mode. */
public static interface NestedTestSuite {} public interface NestedTestSuite {}
/** A boolean system property indicating nested suites should be executed normally. */ /** A boolean system property indicating nested suites should be executed normally. */
public static final String PROPERTY_RUN_NESTED = "tests.runnested"; public static final String PROPERTY_RUN_NESTED = "tests.runnested";

View File

@ -140,7 +140,7 @@ public class TestRuleLimitSysouts extends TestRuleAdapter {
/** Test failures from any tests or rules before. */ /** Test failures from any tests or rules before. */
private final TestRuleMarkFailure failureMarker; private final TestRuleMarkFailure failureMarker;
static interface LimitPredicate { interface LimitPredicate {
void check(long before, long after) throws IOException; void check(long before, long after) throws IOException;
} }