summaryrefslogtreecommitdiffstats
path: root/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/ModifiableWriterRegistry.java
blob: 71ecbb806a4a70a00866eb975b019d0f826bd153 (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
 * 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.write;

import com.google.common.annotations.Beta;
import java.util.Collection;
import java.util.Set;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * Mutable registry that allows adding new writers.
 */
@Beta
public interface ModifiableWriterRegistry {

    /**
     * Add a writer responsible for writing only a single complex node.
     */
    ModifiableWriterRegistry addWriter(@Nonnull Writer<? extends DataObject> writer);

    /**
     * Add a writer responsible for writing multiple complex nodes within a subtree its responsible for.
     * Identifiers for subtree nodes handled by a single writer have to be relative from {@link DataObject} that
     * represents subtree root.
     */
    ModifiableWriterRegistry addSubtreeWriter(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                              @Nonnull Writer<? extends DataObject> writer);

    /**
     * Add a writer and make sure it will be executed before writer identifier by relatedType is executed.
     */
    ModifiableWriterRegistry addWriterBefore(@Nonnull Writer<? extends DataObject> writer,
                                             @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableWriterRegistry addSubtreeWriterBefore(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                    @Nonnull Writer<? extends DataObject> writer,
                                                    @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableWriterRegistry addWriterBefore(@Nonnull Writer<? extends DataObject> writer,
                                             @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    ModifiableWriterRegistry addSubtreeWriterBefore(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                    @Nonnull Writer<? extends DataObject> writer,
                                                    @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    /**
     * Add a writer and make sure it will be executed after writer identifier by relatedType is executed.
     */
    ModifiableWriterRegistry addWriterAfter(@Nonnull Writer<? extends DataObject> writer,
                                            @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableWriterRegistry addSubtreeWriterAfter(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                   @Nonnull Writer<? extends DataObject> writer,
                                                   @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableWriterRegistry addWriterAfter(@Nonnull Writer<? extends DataObject> writer,
                                            @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    ModifiableWriterRegistry addSubtreeWriterAfter(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                   @Nonnull Writer<? extends DataObject> writer,
                                                   @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);
}