data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/TreeType.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.api.schema.tree;
   9
  10 import com.google.common.annotations.Beta;
  11
  12 /**
  13  * {@link DataTree} type, specifying which YANG modeled content is valid with a data tree. This reflects
  14  * <a href="https://tools.ietf.org/html/rfc6020#section-7.21.1">RFC6020</a>/
  15  * <a href="https://tools.ietf.org/html/rfc6020#section-7.19.1">RFC7950</a> data combinations based on {@code config}
  16  * statement.
  17  */
  18 // FIXME: 7.0.0: Consider defining a 'config false'-only type
  19 // FIXME: 7.0.0: Consider renaming this enum
  20 @Beta
  21 public enum TreeType {
  22     /**
  23      * Only {@code config true} nodes are allowed. This corresponds, but is not limited, to @{code candidate},
  24      * {@code startup} and {@code running} data stores defined in
  25      * <a href="https://tools.ietf.org/html/rfc8342#section-4.1">RFC8342 section 4.1</a> as well as {@code intended}
  26      * data store defined in <a href="https://tools.ietf.org/html/rfc8342#section-5">RFC8342 section 4.1</a>.
  27      */
  28     CONFIGURATION,
  29     /**
  30      * Only {@code config true} and {@code config false} nodes are allowed. This corresponds, but is not limited, to
  31      * {@code operational state} defined in
  32      * <a href="https://tools.ietf.org/html/rfc8342#section-4.1">RFC8342 section 4.1</a> as well as {@code operational}
  33      * data store defined in <a href="https://tools.ietf.org/html/rfc8342#section-5">RFC8342 section 4.1</a>.
  34      */
  35     OPERATIONAL,
  36 }