Package org.opendaylight.yangtools.yang.data.util

Class AbstractStringIdentityrefCodec

java.lang.Object

org.opendaylight.yangtools.concepts.AbstractCodec<P,I,X>

org.opendaylight.yangtools.concepts.AbstractUncheckedCodec<P,I,IllegalArgumentException>

org.opendaylight.yangtools.concepts.AbstractIllegalArgumentCodec<String,T>

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

All Implemented Interfaces:

Codec<String,QName,IllegalArgumentException>, Deserializer<QName,String,IllegalArgumentException>, IllegalArgumentCodec<String,QName>, Serializer<String,QName,IllegalArgumentException>, UncheckedCodec<String,QName,IllegalArgumentException>, UncheckedDeserializer<String,QName,IllegalArgumentException>, UncheckedSerializer<QName,String,IllegalArgumentException>, IdentityrefCodec<String>

Direct Known Subclasses:

AbstractModuleStringIdentityrefCodec

@Beta
public abstract class AbstractStringIdentityrefCodec
extends AbstractIllegalArgumentCodec<String,T>
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	Description
AbstractStringIdentityrefCodec()

Method Summary

Modifier and Type	Method	Description
protected @NonNull 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.
protected QName	deserializeImpl(String data)
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.
protected String	serializeImpl(QName data)

Methods inherited from class org.opendaylight.yangtools.concepts.AbstractCodec

deserialize, serialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.concepts.Codec

deserialize, serialize

Methods inherited from interface org.opendaylight.yangtools.concepts.UncheckedDeserializer

serialize

Methods inherited from interface org.opendaylight.yangtools.concepts.UncheckedSerializer

deserialize

Constructor Detail

AbstractStringIdentityrefCodec

public AbstractStringIdentityrefCodec()

Method Detail

serializeImpl

protected final String serializeImpl(QName data)

Specified by:

serializeImpl in class AbstractUncheckedCodec<String,QName,IllegalArgumentException>

deserializeImpl

protected final QName deserializeImpl(String data)

Specified by:

deserializeImpl in class AbstractUncheckedCodec<String,QName,IllegalArgumentException>

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