This adds some sorely-needed javadocs.
Change-Id: Ief1797b7f63c6b85e53ee0e485453b0dbb07b95c
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
*/
package org.opendaylight.mdsal.common.api;
*/
package org.opendaylight.mdsal.common.api;
+/**
+ * The concept of a logical data store, similar to RFC8342.
+ */
+// FIXME: 3.0.0: turn this into an interface so it can be externally-defined?
+// FIXME: 3.0.0: note that mount points can have different types and policies, which can potentially be mapped
public enum LogicalDatastoreType {
public enum LogicalDatastoreType {
- * Logical atastore representing operational state of the system
- * and it's components
- * This datastore is used to describe operational state of
- * the system and it's operation related data.
+ * Logical datastore representing operational state of the system and it's components. This datastore is used
+ * to describe operational state of the system and it's operation related data.
+ * <p>
+ * It is defined to:
+ * <ul>
+ * <li>contain both {@code config=true} and {@code config=false} nodes</li>
+ * <li>be replicated across all nodes by default, individual shards may have different strategies, which need to
+ * be documented
+ * </li>
+ * </ul>
- * Logical Datastore representing configuration state of the system
- * and it's components.
- * This datastore is used to describe intended state of
- * the system and intended operation mode.
+ * Logical Datastore representing configuration state of the system and it's components. This datastore is used
+ * to describe intended state of the system and intended operation mode.
+ * <p>
+ * It is defined to:
+ * <ul>
+ * <li>contain only {@code config=true} nodes</li>
+ * <li>be replicated across all nodes by default, individual shards may have different strategies, which need to
+ * be documented
+ * </li>
+ * <li>be persisted on all nodes by default, individual shards may have different strategies, which need to
+ * be documented
+ * </li>
+ * </ul>