From b5c14e82bb698f5da05fa7b502aded65e0267235 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Tue, 17 Apr 2018 03:27:14 +0200 Subject: [PATCH] Add TreeType documentation Clarify TreeType's relationship with RFC6020, RFC7950 and RFC8342, add 2.1.0/3.0.0 design considerations. Change-Id: Ie74eba7244270015be87fdaf5e48d6d265f6e099 Signed-off-by: Robert Varga --- .../yang/data/api/schema/tree/TreeType.java | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/TreeType.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/TreeType.java index 91a9f640a2..f00e24bb30 100644 --- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/TreeType.java +++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/TreeType.java @@ -9,8 +9,28 @@ package org.opendaylight.yangtools.yang.data.api.schema.tree; import com.google.common.annotations.Beta; +/** + * {@link DataTree} type, specifying which YANG modeled content is valid with a data tree. This reflects + * RFC6020/ + * RFC7950 data combinations based on {@code config} + * statement. + */ +// FIXME: 2.1.0: 3.0.0: Consider defining a 'config false'-only type +// FIXME: 3.0.0: Consider renaming this enum @Beta public enum TreeType { + /** + * Only {@code config true} nodes are allowed. This corresponds, but is not limited, to @{code candidate}, + * {@code startup} and {@code running} data stores defined in + * RFC8342 section 4.1 as well as {@code intended} + * data store defined in RFC8342 section 4.1. + */ CONFIGURATION, + /** + * Only {@code config true} and {@code config false} nodes are allowed. This corresponds, but is not limited, to + * {@code operational state} defined in + * RFC8342 section 4.1 as well as {@code operational} + * data store defined in RFC8342 section 4.1. + */ OPERATIONAL, } -- 2.36.6