org.opendaylight.yangtools.yang.data.util

Class AbstractStringIdentityrefCodec

java.lang.Object

org.opendaylight.yangtools.yang.data.util.AbstractStringIdentityrefCodec

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Codec<String,org.opendaylight.yangtools.yang.common.QName>, org.opendaylight.yangtools.concepts.Deserializer<org.opendaylight.yangtools.yang.common.QName,String>, org.opendaylight.yangtools.concepts.Serializer<String,org.opendaylight.yangtools.yang.common.QName>, IdentityrefCodec<String>

Direct Known Subclasses:

AbstractModuleStringIdentityrefCodec

@Beta
public abstract class AbstractStringIdentityrefCodec
extends Object
implements IdentityrefCodec<String>

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

Constructor Summary

Constructors

Constructor and Description
AbstractStringIdentityrefCodec()

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.
org.opendaylight.yangtools.yang.common.QName	deserialize(String data)
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(org.opendaylight.yangtools.yang.common.QName data)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStringIdentityrefCodec

public AbstractStringIdentityrefCodec()

Method Detail

serialize

public String serialize(org.opendaylight.yangtools.yang.common.QName data)

Specified by:

serialize in interface org.opendaylight.yangtools.concepts.Codec<String,org.opendaylight.yangtools.yang.common.QName>

Specified by:

serialize in interface org.opendaylight.yangtools.concepts.Serializer<String,org.opendaylight.yangtools.yang.common.QName>

Specified by:

serialize in interface IdentityrefCodec<String>

deserialize

public org.opendaylight.yangtools.yang.common.QName deserialize(String data)

Specified by:

deserialize in interface org.opendaylight.yangtools.concepts.Codec<String,org.opendaylight.yangtools.yang.common.QName>

Specified by:

deserialize in interface org.opendaylight.yangtools.concepts.Deserializer<org.opendaylight.yangtools.yang.common.QName,String>

Specified by:

deserialize in interface IdentityrefCodec<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)