BUG-509: cleanup datastore interafaces
[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / store / impl / tree / data / NoopDataTreeCandidate.java
1 /*
2  * Copyright (c) 2014 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.controller.md.sal.dom.store.impl.tree.data;
9
10 import java.util.Collections;
11
12 import org.opendaylight.controller.md.sal.dom.store.impl.tree.DataTreeCandidateNode;
13 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ModificationType;
14 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
15 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
17
18 import com.google.common.base.Optional;
19 import com.google.common.base.Preconditions;
20
21 /**
22  * Internal utility class for an empty candidate. We instantiate this class
23  * for empty modifications, saving memory and processing speed. Instances
24  * of this class are explicitly recognized and processing of them is skipped.
25  */
26 final class NoopDataTreeCandidate extends AbstractDataTreeCandidate {
27     private static final DataTreeCandidateNode ROOT = new DataTreeCandidateNode() {
28         @Override
29         public ModificationType getModificationType() {
30             return ModificationType.UNMODIFIED;
31         }
32
33         @Override
34         public Iterable<DataTreeCandidateNode> getChildNodes() {
35             return Collections.emptyList();
36         }
37
38         @Override
39         public PathArgument getIdentifier() {
40             throw new IllegalStateException("Attempted to read identifier of the no-operation change");
41         }
42
43         @Override
44         public Optional<NormalizedNode<?, ?>> getDataAfter() {
45             return Optional.absent();
46         }
47
48         @Override
49         public Optional<NormalizedNode<?, ?>> getDataBefore() {
50             return Optional.absent();
51         }
52     };
53
54     protected NoopDataTreeCandidate(final InstanceIdentifier rootPath, final ModifiedNode modificationRoot) {
55         super(rootPath);
56         Preconditions.checkArgument(modificationRoot.getType() == ModificationType.UNMODIFIED);
57     }
58
59     @Override
60     public DataTreeCandidateNode getRootNode() {
61         return ROOT;
62     }
63 }