2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.util;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.Preconditions;
13 import javax.annotation.Nonnull;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
19 import org.opendaylight.yangtools.yang.data.api.codec.InstanceIdentifierCodec;
20 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
23 * Abstract utility class for representations which encode {@link YangInstanceIdentifier} as a
24 * prefix:name tuple. Typical uses are RESTCONF/JSON (module:name) and XML (prefix:name).
27 public abstract class AbstractStringInstanceIdentifierCodec extends AbstractNamespaceCodec
28 implements InstanceIdentifierCodec<String> {
31 public final String serialize(final YangInstanceIdentifier data) {
32 StringBuilder sb = new StringBuilder();
33 DataSchemaContextNode<?> current = getDataContextTree().getRoot();
34 for (PathArgument arg : data.getPathArguments()) {
35 current = current.getChild(arg);
36 Preconditions.checkArgument(current != null,
37 "Invalid input %s: schema for argument %s (after %s) not found", data, arg, sb);
39 if (current.isMixin()) {
41 * XML/YANG instance identifier does not have concept
42 * of augmentation identifier, or list as whole which
43 * identifies a mixin (same as the parent element),
44 * so we can safely ignore it if it is part of path
45 * (since child node) is identified in same fashion.
51 appendQName(sb, arg.getNodeType());
53 if (arg instanceof NodeIdentifierWithPredicates) {
54 for (Map.Entry<QName, Object> entry : ((NodeIdentifierWithPredicates) arg).getKeyValues().entrySet()) {
56 appendQName(sb, entry.getKey());
58 sb.append(String.valueOf(entry.getValue()));
61 } else if (arg instanceof NodeWithValue) {
63 sb.append(((NodeWithValue<?>) arg).getValue());
71 * Returns DataSchemaContextTree associated with SchemaContext for which
72 * serialization / deserialization occurs.
75 * Implementations MUST provide non-null Data Tree context, in order
76 * for correct serialization / deserialization of PathArguments,
77 * since XML representation does not have Augmentation arguments
78 * and does not provide path arguments for cases.
81 * This effectively means same input XPath representation of Path Argument
82 * may result in different YangInstanceIdentifiers if models are different
83 * in uses of choices and cases.
85 * @return DataSchemaContextTree associated with SchemaContext for which
86 * serialization / deserialization occurs.
88 protected abstract @Nonnull DataSchemaContextTree getDataContextTree();
90 protected Object deserializeKeyValue(final DataSchemaNode schemaNode, final String value) {
95 public final YangInstanceIdentifier deserialize(final String data) {
96 Preconditions.checkNotNull(data, "Data may not be null");
97 XpathStringParsingPathArgumentBuilder builder = new XpathStringParsingPathArgumentBuilder(this, data);
98 return YangInstanceIdentifier.create(builder.build());