org.opendaylight.yangtools.yang.model.repo.api

Class RevisionSourceIdentifier

java.lang.Object

org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier

org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier

All Implemented Interfaces:

Serializable, Identifier, Immutable, MutationBehaviour<Immutable>

@Beta
public final class RevisionSourceIdentifier
extends SourceIdentifier

YANG Schema revision source identifier.

Simple transfer object represents revision identifier of source for YANG schema (module or submodule), which consists of

• YANG schema name (SourceIdentifier.getName()
• Module revision (optional) ({link SourceIdentifier.getRevision())

Revision source identifier is designated to be carry only necessary information to look-up YANG model source and to be used by various SchemaSourceProviders.

Note:On source retrieval layer it is impossible to distinguish between YANG module and/or submodule unless source is present.

(For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2 and http://tools.ietf.org/html/rfc6022#section-3.1 ).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static RevisionSourceIdentifier	create(String moduleName) Creates new YANG Schema revision source identifier for sources without a revision.
static RevisionSourceIdentifier	create(String moduleName, Optional<Revision> revision) Creates new YANG Schema revision source identifier.
static RevisionSourceIdentifier	create(String moduleName, Revision revision) Creates new YANG Schema revision source identifier.
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier

getName, getRevision, intern, toYangFilename, toYangFileName

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RevisionSourceIdentifier create(String moduleName,
                                              Optional<Revision> revision)

Creates new YANG Schema revision source identifier.

Parameters:

moduleName - Name of schema

revision - Revision of source in format YYYY-mm-dd. If not present, default value will be used.

create

public static RevisionSourceIdentifier create(String moduleName,
                                              @Nullable
                                              Revision revision)

Creates new YANG Schema revision source identifier.

Parameters:

moduleName - Name of schema

revision - Revision of source, may be null

create

public static RevisionSourceIdentifier create(String moduleName)

Creates new YANG Schema revision source identifier for sources without a revision.

Parameters:

moduleName - Name of schema

hashCode

public int hashCode()

Specified by:

hashCode in interface Identifier

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Identifier

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface Identifier

Overrides:

toString in class Object