package org.codelibs.fess.suggest.request;

/**
 * The Response interface serves as a marker interface for all response types
 * in the suggestion system. Implementations of this interface are used to
 * encapsulate the results of various operations and queries within the system.
 *
 * <p>Classes implementing this interface should provide specific details and
 * data relevant to the type of response they represent.</p>
 */
public interface Response {

import org.codelibs.fess.suggest.request.Response;

/**
 * Represents the response for popular words request.
 */
public class PopularWordsResponse implements Response {

    /**
     * The index associated with the response.
     */
    protected final String index;

    /**
     * The time taken to generate the response in milliseconds.
     */
    protected final long tookMs;

/**
 * The ResponseProcessor interface defines a contract for processing response data.
 * Implementations of this interface are responsible for handling the response data
 * obtained during a crawling process.
 */
public interface ResponseProcessor {

    /**
     * Processes the given response data.
     *
     * @param responseData the response data to be processed
     */
    void process(ResponseData responseData);

import java.util.List;

import org.codelibs.fess.suggest.request.Response;

/**
 * Represents the response of a suggest index operation.
 * This class contains information about the number of suggest documents,
 * the number of input documents, any errors that occurred during the operation,
 * and the time taken to complete the operation.
 */
public class SuggestIndexResponse implements Response {
    /** The number of suggest documents. */

 *   to return the result of the computation.
 * </p>
 *
 * @param <RESPONSE> The type of the response.
 */
public class Deferred<RESPONSE extends Response> {
    /**
     * Constructs a new Deferred object.
     */
    public Deferred() {
        // nothing
    }

    private RESPONSE response = null;

    private Throwable error = null;

    private final Promise promise = new Promise();

import org.opensearch.transport.client.Client;

/**
 * Abstract class representing a request that can be executed to produce a response.
 *
 * @param <T> the type of response produced by this request
 */
public abstract class Request<T extends Response> {
    /**
     * Constructs a new request.
     */
    public Request() {
        // nothing
    }

    /**
     * Executes the request.

 * response data in a web crawler. Implementations of this interface should provide logic
 * to determine if a given response data matches the rule, retrieve the rule's identifier,
 * and obtain the associated response processor.
 */
public interface Rule extends Serializable {

    /**
     * Determines if the given response data matches the rule.
     *

/**
 * Utility class for handling response data.
 */
public final class ResponseDataUtil {

    /**
     * Private constructor to prevent instantiation of this utility class.
     */
    private ResponseDataUtil() {
    }

    /**
     * Creates a temporary file containing the response body from the given ResponseData.
     *
     * @param responseData the response data containing the response body

import org.codelibs.fess.suggest.entity.SuggestItem;
import org.codelibs.fess.suggest.request.Response;

/**
 * Represents a response for a suggest request.
 * This class holds the details of the response including the index, time taken, words, total count, and suggested items.
 */
public class SuggestResponse implements Response {
    /** The index name. */
    protected final String index;

/**
 * NullResponseProcessor is a class that implements the ResponseProcessor interface.
 * It provides a no-op implementation for processing response data.
 * This class can be used when you want to skip the response processing step in a crawler.
 *
 * @author kuma
 */
public class NullResponseProcessor implements ResponseProcessor {

    /**
     * Creates a new NullResponseProcessor instance.