org.opendaylight.yangtools.yang.data.util

Class AbstractStringIdentityrefCodec

java.lang.Object

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

All Implemented Interfaces:

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

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 abstract @Nullable QName	createQName(@NonNull String prefix, @NonNull String localName) Create a QName for a prefix and local name.
QName	deserialize(String data) Produce an object base on input.
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(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(QName data)

Specified by:

serialize in interface Codec<String,QName>

Specified by:

serialize in interface Serializer<String,QName>

Specified by:

serialize in interface IdentityrefCodec<String>

deserialize

public QName deserialize(String data)

Description copied from interface: Deserializer

Produce an object base on input.

Specified by:

deserialize in interface Codec<String,QName>

Specified by:

deserialize in interface Deserializer<QName,String>

Specified by:

deserialize in interface IdentityrefCodec<String>

Parameters:

data - Input object

Returns:

Product derived from input

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)