/*
 * 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.translate.util.read.cache;

import io.fd.honeycomb.translate.read.ReadFailedException;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * Generic interface for classes that return dumps for Data objects.
 * Must be implemented in Thread-safe fashion and return non-null data
 */
@ThreadSafe
public interface EntityDumpExecutor<T, U> {

    Void NO_PARAMS = null;

    /**
     * Performs dump on {@link T} entity.
     *
     * @return dump of specified {@link T} entity
     * @throws ReadFailedException when dump fails
     */
    @Nonnull
    T executeDump(final InstanceIdentifier<?> identifier, final U params) throws ReadFailedException;
}