org.opendaylight.yangtools.yang.data.util

Class AbstractStringInstanceIdentifierCodec

java.lang.Object

org.opendaylight.yangtools.yang.data.util.AbstractStringInstanceIdentifierCodec

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Codec<String,YangInstanceIdentifier>, org.opendaylight.yangtools.concepts.Deserializer<YangInstanceIdentifier,String>, org.opendaylight.yangtools.concepts.Serializer<String,YangInstanceIdentifier>, InstanceIdentifierCodec<String>

Direct Known Subclasses:

AbstractModuleStringInstanceIdentifierCodec

@Beta
public abstract class AbstractStringInstanceIdentifierCodec
extends Object
implements InstanceIdentifierCodec<String>

Abstract utility class for representations which encode YangInstanceIdentifier as a prefix:name tuple. Typical uses are RESTCONF/JSON (module:name) and XML (prefix:name).

Constructor Summary

Constructors

Constructor and Description
AbstractStringInstanceIdentifierCodec()

Method Summary

Methods

Modifier and Type	Method and Description
protected StringBuilder	appendQName(StringBuilder sb, org.opendaylight.yangtools.yang.common.QName qname)
protected abstract org.opendaylight.yangtools.yang.common.QName	createQName(String prefix, String localName) Create a QName for a prefix and local name.
YangInstanceIdentifier	deserialize(String data)
protected Object	deserializeKeyValue(DataSchemaNode schemaNode, String value)
protected abstract DataSchemaContextTree	getDataContextTree() Returns DataSchemaContextTree associated with SchemaContext for which serialization / deserialization occurs.
protected org.opendaylight.yangtools.yang.common.QName	parseQName(String str)
protected abstract String	prefixForNamespace(URI namespace) Return string prefix for a particular namespace, allocating a new one if necessary.
String	serialize(YangInstanceIdentifier data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractStringInstanceIdentifierCodec

public AbstractStringInstanceIdentifierCodec()

Method Detail

serialize

public final String serialize(YangInstanceIdentifier data)

Specified by:

serialize in interface org.opendaylight.yangtools.concepts.Codec<String,YangInstanceIdentifier>

Specified by:

serialize in interface org.opendaylight.yangtools.concepts.Serializer<String,YangInstanceIdentifier>

Specified by:

serialize in interface InstanceIdentifierCodec<String>

getDataContextTree

@Nonnull
protected abstract DataSchemaContextTree getDataContextTree()

Returns DataSchemaContextTree associated with SchemaContext for which serialization / deserialization occurs. Implementations MUST provide non-null Data Tree context, in order for correct serialization / deserialization of PathArguments, since XML representation does not have Augmentation arguments and does not provide path arguments for cases. This effectively means same input XPath representation of Path Argument may result in different YangInstanceIdentifiers if models are different in uses of choices and cases.

Returns:

DataSchemaContextTree associated with SchemaContext for which serialization / deserialization occurs.

deserializeKeyValue

protected Object deserializeKeyValue(DataSchemaNode schemaNode,
                         String value)

deserialize

public final YangInstanceIdentifier deserialize(String data)

Specified by:

deserialize in interface org.opendaylight.yangtools.concepts.Codec<String,YangInstanceIdentifier>

Specified by:

deserialize in interface org.opendaylight.yangtools.concepts.Deserializer<YangInstanceIdentifier,String>

Specified by:

deserialize in interface InstanceIdentifierCodec<String>

prefixForNamespace

@Nullable
protected abstract String prefixForNamespace(@Nonnull
                                 URI namespace)

Return string prefix for a particular namespace, allocating a new one if necessary.

Parameters:

namespace - Namespace to map

Returns:

Allocated unique prefix, or null if the prefix cannot be mapped.

createQName

@Nullable
protected abstract org.opendaylight.yangtools.yang.common.QName createQName(@Nonnull
                                                                String prefix,
                                                                @Nonnull
                                                                String localName)

Create a QName for a prefix and local name.

Parameters:

prefix - Prefix for namespace

localName - local name

Returns:

QName

Throws:

IllegalArgumentException - if the prefix cannot be resolved

appendQName

protected final StringBuilder appendQName(StringBuilder sb,
                        org.opendaylight.yangtools.yang.common.QName qname)

parseQName

protected final org.opendaylight.yangtools.yang.common.QName parseQName(String str)