|------|-----------|---------|
| Classes/Interfaces | PascalCase | `SuggestIndexer`, `ReadingConverter` |
| Methods | camelCase | `createIndexIfNothing()` |
| Constants | UPPER_SNAKE_CASE | `DEFAULT_MAX_READING_NUM` |
| Packages | lowercase | `org.codelibs.fess.suggest` |

### JavaDoc Requirements

All public classes and methods require JavaDoc with `@param`, `@return`, and `@throws` tags.

### Best Practices

**Null Safety:**

  /**
   * Tries to perform a "full" garbage collection cycle (including processing of weak references and
   * invocation of finalize methods) and waits for it to complete. Ensures that at least one weak
   * reference has been cleared and one {@code finalize} method has been run before this method
   * returns. This method may be useful when testing the garbage collection mechanism itself, or
   * inhibiting a spontaneous GC initiation in subsequent code.

    }

    public MethodMetaData addMethod(String name, TypeMetaData returnType, String rawCommentText) {
        MethodMetaData method = new MethodMetaData(name, this);
        declaredMethods.add(method);
        method.setReturnType(returnType);
        method.setRawCommentText(rawCommentText);
        return method;
    }

    @Override
    public void resolveTypes(Transformer<String, String> transformer) {

import org.jspecify.annotations.Nullable;

/**
 * This class provides a skeletal implementation of {@link Network}. It is recommended to extend
 * this class rather than implement {@link Network} directly.
 *
 * <p>The methods implemented in this class should not be overridden unless the subclass admits a
 * more efficient implementation.
 *
 * @author James Sexton
 * @param <N> Node parameter type
 * @param <E> Edge parameter type

class DfsReferralDataTest extends BaseTest {

    @Mock
    private DfsReferralData mockReferralData;

    @Test
    @DisplayName("Should define interface methods")
    void testDfsReferralDataInterface() {
        // Verify interface methods exist
        assertDoesNotThrow(() -> {
            mockReferralData.unwrap(DfsReferralData.class);
            mockReferralData.getServer();
            mockReferralData.getDomain();

 */
package org.codelibs.fess.crawler.client.ftp;

import java.util.ArrayList;
import java.util.List;

/**
 * Holds a list of FtpAuthentication objects and provides methods to add and retrieve them based on a given path.
 * This class is designed to manage FTP authentication details for different paths.
 */
public class FtpAuthenticationHolder {

 *
 * @since 3.0
 */
@Named("nearest")
@Singleton
@Deprecated
public class NearestConflictResolver implements ConflictResolver {
    // ConflictResolver methods -----------------------------------------------

    /*
     * @see org.apache.maven.artifact.resolver.conflict.ConflictResolver#resolveConflict(org.apache.maven.artifact.resolver.ResolutionNode,

 * versions of the {@link FluentFuture#catching(Class, com.google.common.base.Function)
 * FluentFuture.catching} family of methods. Those versions have slightly different signatures.
 */
abstract class GwtFluentFutureCatchingSpecialization<V extends @Nullable Object>
    extends AbstractFuture<V> {
  /*
   * In the GWT versions of the methods (below), every exceptionType parameter is required to be

    return getMethod(methodName, arguments).invoke(lockLikeObject, arguments);
  }

  private Method getMethod(String methodName, Object... arguments) throws Exception {
    METHODS:
    for (Method method : lockLikeObject.getClass().getMethods()) {
      Class<?>[] parameterTypes = method.getParameterTypes();
      if (method.getName().equals(methodName) && (parameterTypes.length == arguments.length)) {

 * the {@link Futures#catching(ListenableFuture, Class, com.google.common.base.Function)
 * Futures.catching} family of methods. Those versions have slightly different signatures.
 */
abstract class GwtFuturesCatchingSpecialization {
  /*
   * In the GWT versions of the methods (below), every exceptionType parameter is required to be
   * Class<Throwable>. To handle only certain kinds of exceptions under GWT, you'll need to write