Split out yang-data-tree-{api,spi}
[yangtools.git] / codec / yang-data-codec-binfmt / src / main / java / org / opendaylight / yangtools / yang / data / codec / binfmt / AbstractDataTreeCandidateNode.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.yangtools.yang.data.codec.binfmt;
9
10 import static java.util.Objects.requireNonNull;
11
12 import java.util.Optional;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
16 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
17 import org.opendaylight.yangtools.yang.data.tree.api.ModificationType;
18
19 /**
20  * Abstract base class for our internal implementation of {@link DataTreeCandidateNode},
21  * which we instantiate from a serialized stream. We do not retain the before-image and
22  * do not implement {@link #getModifiedChild(PathArgument)}, as that method is only
23  * useful for end users. Instances based on this class should never be leaked outside of
24  * this component.
25  */
26 abstract class AbstractDataTreeCandidateNode implements DataTreeCandidateNode {
27     private final @NonNull ModificationType type;
28
29     AbstractDataTreeCandidateNode(final ModificationType type) {
30         this.type = requireNonNull(type);
31     }
32
33     @Override
34     public final Optional<DataTreeCandidateNode> getModifiedChild(final PathArgument identifier) {
35         throw new UnsupportedOperationException("Not implemented");
36     }
37
38     @Override
39     public final ModificationType getModificationType() {
40         return type;
41     }
42
43     @Override
44     public final Optional<NormalizedNode> getDataBefore() {
45         throw new UnsupportedOperationException("Before-image not available after serialization");
46     }
47 }