org.opentcs.components.kernel.services.InternalQueryService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.components.kernel.services;

import javax.annotation.Nonnull;
import org.opentcs.components.kernel.Query;
import org.opentcs.components.kernel.QueryResponder;

/**
 * Declares query-related methods not accessible to remote peers.
 *
 * @author Stefan Walter (Fraunhofer IML)
 */
public interface InternalQueryService
    extends QueryService {

  /**
   * Registers the given responder for handling queries of the given type.
   *
   * @param clazz The query type.
   * @param responder The responder to handle the queries.
   */
  void registerResponder(@Nonnull Class> clazz,
                         @Nonnull QueryResponder responder);

  /**
   * Unregisters the responder for the given type.
   *
   * @param clazz The query type.
   */
  void unregisterResponder(@Nonnull Class> clazz);
}