blob: 0033cfc07d26772252e824d16a3bc186a17d7b56 (
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/*
* 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.impl.trans;
import com.google.common.annotations.Beta;
import java.util.List;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* Base VPP reader, responsible for translation between DataObjects and VPP apis
*/
@Beta
public interface VppReader<D extends DataObject> {
// TODO add vpp read context that will be shared by all readers during a single read to keep useful information
// preventing possible duplicate reads from VPP
// TODO make async
/**
* Reads from VPP data identified by id
*
* @param id unique identifier of subtree to be read.
* The subtree must contain managed data object type enforcing it to point
* to the node type managed by this reader or below. For identifiers pointing below
* node managed by this reader, its reader's responsibility to filter out the right
* node or to delegate the read to a child reader.
*
* @return List of DataObjects identified by id. If the ID points to a single node, it will be wrapped in a list
*/
@Nonnull List<? extends DataObject> read(@Nonnull final InstanceIdentifier<? extends DataObject> id);
/**
* Get the type of node managed by this reader
*
* @return Class object for node managed by this reader
*/
@Nonnull InstanceIdentifier<D> getManagedDataObjectType();
}
|
