data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/AbstractCursor.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.impl.schema.tree;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.util.Arrays;
  14 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  17 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor;
  18
  19 abstract class AbstractCursor<T extends AbstractCursorAware> implements DataTreeSnapshotCursor {
  20     @SuppressWarnings("rawtypes")
  21     private static final AtomicIntegerFieldUpdater<AbstractCursor> CLOSED_UPDATER =
  22             AtomicIntegerFieldUpdater.newUpdater(AbstractCursor.class, "closed");
  23     private final YangInstanceIdentifier rootPath;
  24     private final T parent;
  25     // closed isn't unused, it's updated by CLOSED_UPDATER but data-flow analysers can't see that
  26     @SuppressWarnings("unused")
  27     private volatile int closed;
  28
  29     AbstractCursor(final T parent, final YangInstanceIdentifier rootPath) {
  30         this.rootPath = requireNonNull(rootPath);
  31         this.parent = requireNonNull(parent);
  32     }
  33
  34     final T getParent() {
  35         return parent;
  36     }
  37
  38     final YangInstanceIdentifier getRootPath() {
  39         return rootPath;
  40     }
  41
  42
  43     final void ensureNotClosed() {
  44         checkState(closed == 0, "Modification cursor has been closed");
  45     }
  46
  47     @Override
  48     public final void enter(final PathArgument... path) {
  49         enter(Arrays.asList(path));
  50     }
  51
  52     @Override
  53     public final void exit() {
  54         exit(1);
  55     }
  56
  57     @Override
  58     public final void close() {
  59         if (CLOSED_UPDATER.compareAndSet(this, 0, 1)) {
  60             parent.closeCursor(this);
  61         }
  62     }
  63
  64 }