data/yang-data-tree-ri/src/main/java/org/opendaylight/yangtools/yang/data/tree/impl/NodeModification.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.yangtools.yang.data.tree.impl;
   9
  10 import java.util.Collection;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.yangtools.concepts.Identifiable;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  15 import org.opendaylight.yangtools.yang.data.tree.impl.node.TreeNode;
  16
  17 /**
  18  * Internal interface representing a modification action of a particular node. It is used by the validation code to
  19  * allow for a read-only view of the modification tree as we should never modify that during validation.
  20  */
  21 abstract sealed class NodeModification implements Identifiable<PathArgument> permits ModifiedNode {
  22     /**
  23      * Get the type of modification.
  24      *
  25      * @return Operation type.
  26      */
  27     abstract LogicalOperation getOperation();
  28
  29     /**
  30      * Get the original tree node to which the modification is to be applied.
  31      *
  32      * @return The original node, or {@link Optional#absent()} if the node is a new node.
  33      */
  34     // FIXME: we should not need this method
  35     final Optional<? extends TreeNode> getOriginal() {
  36         return Optional.ofNullable(original());
  37     }
  38
  39     /**
  40      * Get the original tree node to which the modification is to be applied.
  41      *
  42      * @return The original node, or {@code null} if the node is a new node.
  43      */
  44     abstract @Nullable TreeNode original();
  45
  46     /**
  47      * Get a read-only view of children nodes.
  48      *
  49      * @return Collection of all children nodes.
  50      */
  51     abstract Collection<? extends NodeModification> getChildren();
  52
  53     /**
  54      * A shortcut to {@code getChildren().isEmpty()}.
  55      *
  56      * @return {@code} if {@link #getChildren()} is empty.
  57      */
  58     abstract boolean isEmpty();
  59 }