data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/ChoiceNode.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.api.schema;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  11
  12 /**
  13  * Node representing data instance of <code>choice</code>.
  14  *
  15  * <p>
  16  * Choice node is instance of one of possible alternatives, from which only one is allowed to exist at one time in
  17  * particular context of parent node.
  18  *
  19  * <p>
  20  * YANG Model and schema for choice is described by instance of
  21  * {@link org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode}.
  22  *
  23  * <p>
  24  * Valid alternatives of subtree are described by instances of
  25  * {@link org.opendaylight.yangtools.yang.model.api.CaseSchemaNode}, which are retrieved via
  26  * {@link org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode#getCases()}.
  27  */
  28 public interface ChoiceNode extends MixinNode, DataContainerNode, DataContainerChild {
  29     @Override
  30     default Class<ChoiceNode> contract() {
  31         return ChoiceNode.class;
  32     }
  33
  34     @Override
  35     NodeIdentifier getIdentifier();
  36 }