binding/mdsal-binding-dom-codec-spi/src/main/java/org/opendaylight/mdsal/binding/dom/codec/spi/AbstractBindingLazyContainerNode.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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.mdsal.binding.dom.codec.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ForwardingObject;
  14 import java.util.Collection;
  15 import org.checkerframework.checker.lock.qual.GuardedBy;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
  19 import org.opendaylight.yangtools.concepts.PrettyTree;
  20 import org.opendaylight.yangtools.yang.binding.DataObject;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  23 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  25
  26 /**
  27  * A {@link ContainerNode} backed by a binding {@link DataObject}, with lazy instantiation of the ContainerNode view.
  28  * This class is thread-safe.
  29  *
  30  * @param <T> Binding DataObject type
  31  * @param <C> Context type
  32  * @author Robert Varga
  33  */
  34 @Beta
  35 public abstract class AbstractBindingLazyContainerNode<T extends DataObject, C> extends ForwardingObject
  36         implements BindingLazyContainerNode<T> {
  37     private final @NonNull NodeIdentifier identifier;
  38     private final @NonNull T bindingData;
  39
  40     private volatile @Nullable ContainerNode delegate;
  41     @GuardedBy("this")
  42     private @Nullable C context;
  43
  44     protected AbstractBindingLazyContainerNode(final @NonNull NodeIdentifier identifier, final @NonNull T bindingData,
  45             final C context) {
  46         this.identifier = requireNonNull(identifier);
  47         this.bindingData = requireNonNull(bindingData);
  48         this.context = context;
  49     }
  50
  51     @Override
  52     public final @NonNull T getDataObject() {
  53         return bindingData;
  54     }
  55
  56     @Override
  57     public final @NonNull NodeIdentifier getIdentifier() {
  58         return identifier;
  59     }
  60
  61     @Override
  62     public final ContainerNode getDelegate() {
  63         return delegate();
  64     }
  65
  66     @Override
  67     public Collection<DataContainerChild> body() {
  68         return delegate().body();
  69     }
  70
  71     @Override
  72     public DataContainerChild childByArg(final PathArgument child) {
  73         return delegate().childByArg(child);
  74     }
  75
  76     @Override
  77     public PrettyTree prettyTree() {
  78         // Do not touch delegate() until we really need to
  79         return new PrettyTree() {
  80             @Override
  81             public void appendTo(final StringBuilder sb, final int depth) {
  82                 delegate().prettyTree().appendTo(sb, depth);
  83             }
  84         };
  85     }
  86
  87     @Override
  88     public int hashCode() {
  89         return delegate().hashCode();
  90     }
  91
  92     @Override
  93     public boolean equals(final @Nullable Object obj) {
  94         if (this == obj) {
  95             return true;
  96         }
  97         if (!(obj instanceof ContainerNode)) {
  98             return false;
  99         }
 100         final ContainerNode other = (ContainerNode) obj;
 101         return delegate().equals(other);
 102     }
 103
 104     @Override
 105     protected final @NonNull ContainerNode delegate() {
 106         ContainerNode local = delegate;
 107         if (local == null) {
 108             synchronized (this) {
 109                 local = delegate;
 110                 if (local == null) {
 111                     local = delegate = requireNonNull(computeContainerNode(context));
 112                     context = null;
 113                 }
 114             }
 115         }
 116
 117         return local;
 118     }
 119
 120     @GuardedBy("this")
 121     protected abstract @NonNull ContainerNode computeContainerNode(C context);
 122 }