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

Class SemVerSourceIdentifier

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Identifier, Immutable, MutationBehaviour<Immutable>

@Beta
public final class SemVerSourceIdentifier
extends SourceIdentifier

YANG Schema source identifier with specified semantic version Simple transfer object represents identifier of source for YANG schema (module or submodule), which consists of

• YANG schema name SourceIdentifier.getName()
• Semantic version of yang schema getSemanticVersion()
• (Optional) Module revision ({link SourceIdentifier.getRevision()

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

Field Summary

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

NOT_PRESENT_FORMATTED_REVISION, REVISION_PATTERN

Method Summary

Modifier and Type	Method and Description
static SemVerSourceIdentifier	create(String moduleName, com.google.common.base.Optional<String> revision, SemVer semVer) Creates new YANG Schema semVer source identifier.
static SemVerSourceIdentifier	create(String moduleName, SemVer semVer) Creates new YANG Schema semVer source identifier.
static SemVerSourceIdentifier	create(String moduleName, String revision, SemVer semVer) Creates new YANG Schema semVer source identifier.
boolean	equals(Object obj)
SemVer	getSemanticVersion() Returns semantic version of source or Module.DEFAULT_SEMANTIC_VERSION if semantic version was not supplied.
int	hashCode()
String	toString()

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

create, getName, getRevision, intern, toYangFilename, toYangFileName

Methods inherited from class java.lang.Object

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

Method Detail

getSemanticVersion

public SemVer getSemanticVersion()

Returns semantic version of source or Module.DEFAULT_SEMANTIC_VERSION if semantic version was not supplied.

Returns:

revision of source or Module.DEFAULT_SEMANTIC_VERSION if revision was not supplied.

create

public static SemVerSourceIdentifier create(String moduleName,
                                            SemVer semVer)

Creates new YANG Schema semVer source identifier.

Parameters:

moduleName - Name of schema

semVer - semantic version of source

create

public static SemVerSourceIdentifier create(String moduleName,
                                            String revision,
                                            SemVer semVer)

Creates new YANG Schema semVer source identifier.

Parameters:

moduleName - Name of schema

revision - Revision of source in format YYYY-mm-dd

semVer - semantic version of source

create

public static SemVerSourceIdentifier create(String moduleName,
                                            com.google.common.base.Optional<String> revision,
                                            SemVer semVer)

Creates new YANG Schema semVer source identifier.

Parameters:

moduleName - Name of schema

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

semVer - semantic version of source

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