summaryrefslogtreecommitdiffstats
path: root/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriteContext.java
blob: bb0b3314589d286562043f31905675e0910943b3 (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.v3po.translate.write;

import com.google.common.annotations.Beta;
import com.google.common.base.Optional;
import io.fd.honeycomb.v3po.translate.Context;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * Context providing information about current state of DataTree to writers
 */
@Beta
public interface WriteContext extends AutoCloseable {

    /**
     * Read any data object before current modification was applied
     *
     * @param currentId Id of an object to read
     *
     * @return Data before the modification was applied
     */
    Optional<DataObject> readBefore(@Nonnull final InstanceIdentifier<? extends DataObject> currentId);

    /**
     * Read any data object from current modification
     *
     * @param currentId Id of an object to read
     *
     * @return Data from the modification
     */
    Optional<DataObject> readAfter(@Nonnull final InstanceIdentifier<? extends DataObject> currentId);

    /**
     * Get key value storage for customizers
     *
     * @return Context for customizers
     */
    @Nonnull
    Context getContext();

    @Override
    void close();
}