yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/ValueNode.java

   1 /*
   2  * Copyright (c) 2016 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.api.schema;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  11
  12 /**
  13  * Interface holding the common trait of {@link LeafSetEntryNode} and {@link LeafNode}, which both hold a value.
  14  *
  15  * @param <K> Local identifier of node
  16  * @param <V> Value of node
  17  */
  18 public interface ValueNode<K extends PathArgument, V> extends NormalizedNode<K, V> {
  19     /**
  20      * Returns value of held by this node.
  21      *
  22      * <b>Implementation note</b>
  23      * Invocation of {@link #getValue()} must provide the same value as value in {@link #getIdentifier()}.
  24      * {@code true == this.getIdentifier().getValue().equals(this.getValue())}.
  25      *
  26      * @return Returned value of this node. Value SHOULD meet criteria defined by schema.
  27      */
  28     @Override
  29     V getValue();
  30 }