*/
package org.opendaylight.mdsal.binding.dom.adapter;
+import com.google.common.annotations.Beta;
import java.util.Optional;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
+import org.opendaylight.yangtools.yang.data.api.schema.AnyxmlNode;
import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
+import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
/**
- * Defines structural mapping of Normalized Node to Binding data
- * addressable by Instance Identifier.
+ * Defines structural mapping of Normalized Node to Binding data addressable by Instance Identifier. Not all binding
+ * data are addressable by instance identifier and there are some differences.
*
* <p>
- * Not all binding data are addressable by instance identifier
- * and there are some differences.
+ * See {@link #NOT_ADDRESSABLE},{@link #INVISIBLE_CONTAINER},{@link #VISIBLE_CONTAINER} for more details.
*
* <p>
- * See {@link #NOT_ADDRESSABLE},{@link #INVISIBLE_CONTAINER},{@link #VISIBLE_CONTAINER}
- * for more details.
+ * NOTE: this class is exposed for migration purposes only, no new users outside of its package should be introduced.
*/
-enum BindingStructuralType {
-
+@Beta
+public enum BindingStructuralType {
/**
- * DOM Item is not addressable in Binding Instance Identifier,
- * data is not lost, but are available only via parent object.
- *
- * <p>
- * Such types of data are leaf-lists, leafs, list without keys
- * or anyxml.
- *
+ * DOM Item is not addressable in Binding InstanceIdentifier, data is not lost, but are available only via parent
+ * object. Such types of data are leaf-lists, leafs, list without keys or anyxml.
*/
NOT_ADDRESSABLE,
/**
- * Data container is addressable in NormalizedNode format,
- * but in Binding it is not represented in Instance Identifier.
+ * Data container is addressable in NormalizedNode format, but in Binding it is not represented in
+ * InstanceIdentifier. These are choice / case nodes.
*
* <p>
- * This are choice / case nodes.
- *
- * <p>
- * This data is still accessible using parent object and their
- * children are addressable.
- *
+ * This data is still accessible using parent object and their children are addressable.
*/
INVISIBLE_CONTAINER,
/**
- * Data container is addressable in NormalizedNode format,
- * but in Binding it is not represented in Instance Identifier.
- *
- * <p>
- * This are list nodes.
+ * Data container is addressable in NormalizedNode format, but in Binding it is not represented in
+ * InstanceIdentifier. These are list nodes.
*
* <p>
- * This data is still accessible using parent object and their
- * children are addressable.
- *
+ * This data is still accessible using parent object and their children are addressable.
*/
INVISIBLE_LIST,
/**
- * Data container is addressable in Binding Instance Identifier format
- * and also YangInstanceIdentifier format.
- *
+ * Data container is addressable in Binding InstanceIdentifier format and also YangInstanceIdentifier format.
*/
VISIBLE_CONTAINER,
/**
- * Mapping algorithm was unable to detect type or was not updated after introduction
- * of new NormalizedNode type.
+ * Mapping algorithm was unable to detect type or was not updated after introduction of new NormalizedNode type.
*/
UNKNOWN;
- static BindingStructuralType from(final DataTreeCandidateNode domChildNode) {
- Optional<NormalizedNode<?, ?>> dataBased = domChildNode.getDataAfter();
+ public static BindingStructuralType from(final DataTreeCandidateNode domChildNode) {
+ Optional<NormalizedNode> dataBased = domChildNode.getDataAfter();
if (!dataBased.isPresent()) {
dataBased = domChildNode.getDataBefore();
}
return UNKNOWN;
}
- static BindingStructuralType from(final NormalizedNode<?, ?> data) {
+ static BindingStructuralType from(final NormalizedNode data) {
if (isNotAddressable(data)) {
return NOT_ADDRESSABLE;
}
return UNKNOWN;
}
- private static boolean isVisibleContainer(final NormalizedNode<?, ?> data) {
+ public static BindingStructuralType recursiveFrom(final DataTreeCandidateNode node) {
+ final BindingStructuralType type = BindingStructuralType.from(node);
+ switch (type) {
+ case INVISIBLE_CONTAINER:
+ case INVISIBLE_LIST:
+ // This node is invisible, try to resolve using a child node
+ for (final DataTreeCandidateNode child : node.getChildNodes()) {
+ final BindingStructuralType childType = recursiveFrom(child);
+ switch (childType) {
+ case INVISIBLE_CONTAINER:
+ case INVISIBLE_LIST:
+ // Invisible nodes are not addressable
+ return BindingStructuralType.NOT_ADDRESSABLE;
+ case NOT_ADDRESSABLE:
+ case UNKNOWN:
+ case VISIBLE_CONTAINER:
+ return childType;
+ default:
+ throw new IllegalStateException("Unhandled child type " + childType + " for child "
+ + child);
+ }
+ }
+
+ return BindingStructuralType.NOT_ADDRESSABLE;
+ default:
+ return type;
+ }
+ }
+
+ private static boolean isVisibleContainer(final NormalizedNode data) {
return data instanceof MapEntryNode || data instanceof ContainerNode || data instanceof AugmentationNode;
}
- private static boolean isNotAddressable(final NormalizedNode<?, ?> normalizedNode) {
+ private static boolean isNotAddressable(final NormalizedNode normalizedNode) {
return normalizedNode instanceof LeafNode
- || normalizedNode instanceof AnyXmlNode
+ || normalizedNode instanceof AnyxmlNode
|| normalizedNode instanceof LeafSetNode
- || normalizedNode instanceof LeafSetEntryNode;
+ || normalizedNode instanceof LeafSetEntryNode
+ || normalizedNode instanceof UnkeyedListNode
+ || normalizedNode instanceof UnkeyedListEntryNode;
}
-
}
Code Review / mdsal.git / blobdiff