org.opendaylight.mdsal.dom.api

Interface DOMActionImplementation

All Known Implementing Classes:

BindingDOMOperationProviderServiceAdapter.AbstractImplAdapter.ActionAdapter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@Beta
 @FunctionalInterface
 @NonNullByDefault
public interface DOMActionImplementation

Interface implemented by an individual operation implementation. This API allows for dispatch implementations, e.g. an individual object handling a multitude of operations.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
default long	invocationCost() Return the relative invocation cost of this implementation.
com.google.common.util.concurrent.FluentFuture<? extends DOMActionResult>	invokeAction(org.opendaylight.yangtools.yang.model.api.SchemaPath type, DOMDataTreeIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input) Initiate invocation of the action.

Method Detail

invokeAction

com.google.common.util.concurrent.FluentFuture<? extends DOMActionResult> invokeAction(org.opendaylight.yangtools.yang.model.api.SchemaPath type,
                                                                                       DOMDataTreeIdentifier path,
                                                                                       org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input)

Initiate invocation of the action. Implementations of this method are expected to not block.

Parameters:

type - SchemaPath of the action to be invoked. This path refers to an effective action instantiated on top of the conceptual StoreTreeNode.

path - DOMDataTreeIdentifier of parent data node which action attached to.

input - Input arguments

Returns:

A FluentFuture which completes with the result of invocation

Throws:

NullPointerException - if any of the arguments is null

invocationCost

default long invocationCost()

Return the relative invocation cost of this implementation. Default implementation returns 0.

Returns:

Non-negative cost of invoking this implementation.