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