infra/translate-utils/src/main/java/io/fd/honeycomb/translate/util/read/cache/EntityDumpExecutor.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.translate.util.read.cache;
  18
  19 import io.fd.honeycomb.translate.util.read.cache.exceptions.execution.DumpExecutionFailedException;
  20 import javax.annotation.concurrent.ThreadSafe;
  21
  22 /**
  23  * Generic interface for classes that return dumps for Data objects.
  24  * Must be implemented in Thread-save fashion.
  25  */
  26 @ThreadSafe
  27 public interface EntityDumpExecutor<T, U> {
  28
  29     static Void NO_PARAMS = null;
  30
  31     /**
  32      * Performs dump on {@link T} entity
  33      *
  34      * @return dump of specified {@link T} entity
  35      * @throws DumpExecutionFailedException when dump fails
  36      */
  37     T executeDump(final U params) throws DumpExecutionFailedException;
  38 }