summaryrefslogtreecommitdiffstats
path: root/v3po/vpp-translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/v3po/util/cache/EntityDumpExecutor.java
blob: 82b30cf26c426b756f2e1217aa96d1aa66873f10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.fd.honeycomb.v3po.translate.v3po.util.cache;

import io.fd.honeycomb.v3po.translate.v3po.util.cache.exceptions.execution.DumpExecutionFailedException;
import org.openvpp.jvpp.dto.JVppReplyDump;

/**
 * Generic interface for classes that return dumps for Data objects
 */
public interface EntityDumpExecutor<T extends JVppReplyDump, U> {

    /**
     * Performs dump on {link T} entity
     *
     * @return dump of specified {@link T} entity
     * @throws DumpExecutionFailedException when dump fails
     */
    public T executeDump() throws DumpExecutionFailedException;

    /**
     * Bind dumping params for executor
     */
    default public void bindDumpParams(U params) {
        throw new UnsupportedOperationException("You should override this method if you need to bind dumping params");
    }
}