summaryrefslogtreecommitdiffstats
path: root/infra/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/ModifiableSubtreeManagerRegistryBuilder.java
blob: 591a9e9bbaeb10de410ae228d46d6aa4feaa893b (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
/*
 * 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;

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;

/**
 * Registry builder where {@link SubtreeManager}s can be added with or without relationships between them.
 * The relationships express what the order of execution should be.
 */
public interface ModifiableSubtreeManagerRegistryBuilder<S extends SubtreeManager<? extends DataObject>> {

    /**
     * Add a handler responsible for writing only a single complex node.
     */
    ModifiableSubtreeManagerRegistryBuilder<S> add(@Nonnull S handler);

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

    /**
     * Add a handler and make sure it will be executed before handler identifier by relatedType is executed.
     */
    ModifiableSubtreeManagerRegistryBuilder<S> addBefore(@Nonnull S handler,
                                                         @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableSubtreeManagerRegistryBuilder<S> addBefore(@Nonnull S handler,
                                                         @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    ModifiableSubtreeManagerRegistryBuilder<S> subtreeAddBefore(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                                @Nonnull S handler,
                                                                @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableSubtreeManagerRegistryBuilder<S> subtreeAddBefore(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                                @Nonnull S handler,
                                                                @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    /**
     * Add a handler and make sure it will be executed after handler identifier by relatedType is executed.
     */
    ModifiableSubtreeManagerRegistryBuilder<S> addAfter(@Nonnull S handler,
                                                        @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableSubtreeManagerRegistryBuilder<S> addAfter(@Nonnull S handler,
                                                        @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);

    ModifiableSubtreeManagerRegistryBuilder<S> subtreeAddAfter(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                               @Nonnull S handler,
                                                               @Nonnull InstanceIdentifier<?> relatedType);

    ModifiableSubtreeManagerRegistryBuilder<S> subtreeAddAfter(@Nonnull Set<InstanceIdentifier<?>> handledChildren,
                                                               @Nonnull S handler,
                                                               @Nonnull Collection<InstanceIdentifier<?>> relatedTypes);
}