org.opendaylight.yangtools.yang.data.util

Class AbstractStringInstanceIdentifierCodec

java.lang.Object

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

All Implemented Interfaces:

Codec<String,YangInstanceIdentifier>, Deserializer<YangInstanceIdentifier,String>, 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

Modifier and Type	Method and Description
protected StringBuilder	appendQName(StringBuilder sb, QName qname)
protected StringBuilder	appendQName(StringBuilder sb, QName qname, @Nullable QNameModule lastModule) Append a QName, potentially taking into account last QNameModule encountered in the serialized path.
protected QName	createQName(@Nullable QNameModule lastModule, String localName) Create QName from unprefixed name, potentially taking last QNameModule encountered into account.
protected abstract @Nullable QName	createQName(@NonNull String prefix, @NonNull String localName) Create a QName for a prefix and local name.
YangInstanceIdentifier	deserialize(String data) Produce an object base on input.
protected Object	deserializeKeyValue(DataSchemaNode schemaNode, String value)
protected abstract @NonNull DataSchemaContextTree	getDataContextTree() Returns DataSchemaContextTree associated with SchemaContext for which serialization / deserialization occurs.
protected QName	parseQName(String str)
protected abstract @Nullable String	prefixForNamespace(@NonNull 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 Codec<String,YangInstanceIdentifier>

Specified by:

serialize in interface Serializer<String,YangInstanceIdentifier>

Specified by:

serialize in interface InstanceIdentifierCodec<String>

getDataContextTree

protected abstract @NonNull 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)

Description copied from interface: Deserializer

Produce an object base on input.

Specified by:

deserialize in interface Codec<String,YangInstanceIdentifier>

Specified by:

deserialize in interface Deserializer<YangInstanceIdentifier,String>

Specified by:

deserialize in interface InstanceIdentifierCodec<String>

Parameters:

data - Input object

Returns:

Product derived from input

createQName

protected QName createQName(@Nullable QNameModule lastModule,
                            String localName)

Create QName from unprefixed name, potentially taking last QNameModule encountered into account.

Parameters:

lastModule - last QNameModule encountered, potentially null

localName - Local name string

Returns:

A newly-created QName

prefixForNamespace

protected abstract @Nullable 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

protected abstract @Nullable 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,
                                          QName qname)

appendQName

protected StringBuilder appendQName(StringBuilder sb,
                                    QName qname,
                                    @Nullable QNameModule lastModule)

Append a QName, potentially taking into account last QNameModule encountered in the serialized path.

Parameters:

sb - target StringBuilder

qname - QName to append

lastModule - last QNameModule encountered, may be null

Returns:

target StringBuilder

parseQName

protected final QName parseQName(String str)