summaryrefslogtreecommitdiffstats
path: root/infra/translate-api/src/main/java/io/fd/honeycomb/translate/write/Writer.java
blob: e6538012b2f11dc0d4f812c5879435098aef6a31 (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
/*
 * 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.write;

import com.google.common.annotations.Beta;
import io.fd.honeycomb.translate.SubtreeManager;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * Base writer, responsible for translation between DataObjects and any other side. Handling all update operations(create,
 * update, delete)
 *
 * @param <D> Specific DataObject derived type, that is handled by this writer
 */
@Beta
public interface Writer<D extends DataObject> extends SubtreeManager<D> {

    /**
     * Handle update operation. U from CRUD.
     *
     * @param id         Identifier of data being written
     * @param dataBefore Old data
     * @param dataAfter  New, updated data
     * @param ctx        Write context enabling writer to get information about candidate data as well as current data
     * @throws WriteFailedException if update failed
     */
    void update(@Nonnull final InstanceIdentifier<? extends DataObject> id,
                @Nullable final DataObject dataBefore,
                @Nullable final DataObject dataAfter,
                @Nonnull final WriteContext ctx) throws WriteFailedException;
}