gerrit.fd Code Review - hc2vpp.git/blob

   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.v3po.util.cache;
  18
  19 import io.fd.honeycomb.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException;
  20 import org.openvpp.jvpp.dto.JVppReplyDump;
  21
  22 /**
  23  * Generic interface for classes that return dumps for Data objects
  24  */
  25 public interface EntityDumpExecutor<T extends JVppReplyDump, U> {
  26
  27     /**
  28      * Performs dump on {link T} entity
  29      *
  30      * @return dump of specified {@link T} entity
  31      * @throws DumpExecutionFailedException when dump fails
  32      */
  33     public T executeDump() throws DumpExecutionFailedException;
  34
  35     /**
  36      * Bind dumping params for executor
  37      */
  38     default public void bindDumpParams(U params) {
  39         throw new UnsupportedOperationException("You should override this method if you need to bind dumping params");
  40     }
  41 }