Package org.opendaylight.yangtools.yang.common

Class UnqualifiedQName

java.lang.Object

org.opendaylight.yangtools.yang.common.AbstractQName

org.opendaylight.yangtools.yang.common.UnqualifiedQName

All Implemented Interfaces:

Serializable, Comparable<UnqualifiedQName>, Identifier, Immutable, MutationBehaviour<Immutable>, WritableObject

@Beta
@NonNullByDefault
public final class UnqualifiedQName
extends AbstractQName
implements Comparable<UnqualifiedQName>

An unresolved, unqualified QName. It is guaranteed to hold a valid AbstractQName.getLocalName(), in the default namespace, which is not resolved. A resolved QName can be constructed through AbstractQName.bindTo(QNameModule).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
int	compareTo(UnqualifiedQName o)
boolean	equals(@Nullable Object obj)
int	hashCode()
UnqualifiedQName	intern()	Return an interned reference to an equivalent object.
static UnqualifiedQName	of(String localName)	Create a new unqualified QName.
static UnqualifiedQName	readFrom(DataInput in)	Read an UnqualifiedQName from a DataInput.
String	toString()
static @Nullable UnqualifiedQName	tryCreate(String localName)	Create a new unqualified QName.
void	writeTo(DataOutput out)	Serialize this object into a DataOutput as a fixed-format stream.

Methods inherited from class org.opendaylight.yangtools.yang.common.AbstractQName

bindTo, getLocalName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static UnqualifiedQName of(String localName)

Create a new unqualified QName.

Parameters:

localName - The local name of this unqualified QName

Returns:

An UnqualifiedQName instance

Throws:

IllegalArgumentException - if localName is null or it does not conform to YANG localName requirements.

tryCreate

public static @Nullable UnqualifiedQName tryCreate(String localName)

Create a new unqualified QName.

Parameters:

localName - The local name of this unqualified QName

Returns:

An UnqualifiedQName instance, or null if localName is not valid

readFrom

public static UnqualifiedQName readFrom(DataInput in)
                                 throws IOException

Read an UnqualifiedQName from a DataInput. The format is expected to match the output format of writeTo(DataOutput).

Parameters:

in - DataInput to read

Returns:

An UnqualifiedQName instance

Throws:

IOException - if I/O error occurs

intern

public UnqualifiedQName intern()

Description copied from class: AbstractQName

Return an interned reference to an equivalent object.

Specified by:

intern in class AbstractQName

Returns:

Interned reference, or this object if it was interned.

compareTo

public int compareTo(UnqualifiedQName o)

Specified by:

compareTo in interface Comparable<UnqualifiedQName>

writeTo

public void writeTo(DataOutput out)
             throws IOException

Description copied from interface: WritableObject

Serialize this object into a DataOutput as a fixed-format stream.

Specified by:

writeTo in interface WritableObject

Parameters:

out - Data output

Throws:

IOException - if an I/O error occurs

hashCode

public int hashCode()

Specified by:

hashCode in interface Identifier

Specified by:

hashCode in class AbstractQName

equals

public boolean equals(@Nullable Object obj)

Specified by:

equals in interface Identifier

Specified by:

equals in class AbstractQName

toString

public String toString()

Specified by:

toString in interface Identifier

Specified by:

toString in class AbstractQName