blob: acfabf5bcf1c41eac21485dc8ae12053b8ea0b8a (
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
56
57
58
59
60
|
/*
* 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.spi.read;
import com.google.common.annotations.Beta;
import io.fd.honeycomb.translate.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* CompositeChildReader SPI to customize its behavior.
*
* @param <O> Specific DataObject derived type (Identifiable), that is handled by this customizer
* @param <B> Specific Builder for handled type (C)
*/
@Beta
public interface ReaderCustomizer<O extends DataObject, B extends Builder<O>> {
/**
* Creates new builder that will be used to build read value.
*/
@Nonnull
B getBuilder(@Nonnull final InstanceIdentifier<O> id);
/**
* Adds current data (identified by id) to the provided builder.
*
* @param id id of current data object
* @param builder builder for creating read value
* @param ctx context for current read
* @throws ReadFailedException if read was unsuccessful
*/
void readCurrentAttributes(@Nonnull final InstanceIdentifier<O> id,
@Nonnull final B builder,
@Nonnull final ReadContext ctx) throws ReadFailedException;
/**
* Merge read data into provided parent builder.
*/
void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final O readValue);
}
|