org.opendaylight.yangtools.yang.common

Class QNameModule

java.lang.Object

org.opendaylight.yangtools.yang.common.QNameModule

All Implemented Interfaces:

Serializable, Comparable<QNameModule>, org.opendaylight.yangtools.concepts.Identifier, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>, org.opendaylight.yangtools.concepts.WritableObject

public final class QNameModule
extends Object
implements Comparable<QNameModule>, org.opendaylight.yangtools.concepts.Immutable, Serializable, org.opendaylight.yangtools.concepts.Identifier, org.opendaylight.yangtools.concepts.WritableObject

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(QNameModule o)
static QNameModule	create(URI namespace) Create a new QName module instance with specified namespace and norevision.
static QNameModule	create(URI namespace, Optional<Revision> revision) Create a new QName module instance with specified namespace/revision.
static QNameModule	create(URI namespace, Revision revision) Create a new QName module instance with specified namespace/revision.
boolean	equals(Object obj)
URI	getNamespace() Returns the namespace of the module which is specified as argument of YANG Module namespace keyword.
Optional<Revision>	getRevision() Returns the revision date for the module.
int	hashCode()
QNameModule	intern() Return an interned reference to a equivalent QNameModule.
static QNameModule	readFrom(DataInput in) Read a QNameModule from a DataInput.
String	toString()
QNameModule	withoutRevision() Returns a QNameModule with the same namespace, but with no revision.
void	writeTo(DataOutput out)

Methods inherited from class java.lang.Object

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

Method Detail

intern

public QNameModule intern()

Return an interned reference to a equivalent QNameModule.

Returns:

Interned reference, or this object if it was interned.

create

public static QNameModule create(URI namespace,
                                 Optional<Revision> revision)

Create a new QName module instance with specified namespace/revision.

Parameters:

namespace - Module namespace

revision - Module revision

Returns:

A new, potentially shared, QNameModule instance

create

public static QNameModule create(URI namespace)

Create a new QName module instance with specified namespace and norevision.

Parameters:

namespace - Module namespace

Returns:

A new, potentially shared, QNameModule instance

create

public static QNameModule create(URI namespace,
                                 @Nullable
                                 Revision revision)

Create a new QName module instance with specified namespace/revision.

Parameters:

namespace - Module namespace

revision - Module revision

Returns:

A new, potentially shared, QNameModule instance

readFrom

public static QNameModule readFrom(DataInput in)
                            throws IOException

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

Parameters:

in - DataInput to read

Returns:

A QNameModule instance

Throws:

IOException - if I/O error occurs

getNamespace

public URI getNamespace()

Returns the namespace of the module which is specified as argument of YANG Module namespace keyword.

Returns:

URI format of the namespace of the module

getRevision

public Optional<Revision> getRevision()

Returns the revision date for the module.

Returns:

date of the module revision which is specified as argument of YANG Module revison keyword

compareTo

public int compareTo(QNameModule o)

Specified by:

compareTo in interface Comparable<QNameModule>

withoutRevision

public QNameModule withoutRevision()

Returns a QNameModule with the same namespace, but with no revision. If this QNameModule does not have a revision, this object is returned.

Returns:

a QNameModule with the same namespace, but with no revision.

writeTo

public void writeTo(DataOutput out)
             throws IOException

Specified by:

writeTo in interface org.opendaylight.yangtools.concepts.WritableObject

Throws:

IOException

hashCode

public int hashCode()

Specified by:

hashCode in interface org.opendaylight.yangtools.concepts.Identifier

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.opendaylight.yangtools.concepts.Identifier

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface org.opendaylight.yangtools.concepts.Identifier

Overrides:

toString in class Object