Package 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
@Deprecated(since="7.0.11",
            forRemoval=true)
public final class SemVerSourceIdentifier
extends SourceIdentifier

Deprecated, for removal: This API element is subject to removal in a future version.

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

Method Summary

Modifier and Type	Method	Description
static @NonNull SemVerSourceIdentifier	create(String moduleName, Optional<Revision> revision, SemVer semVer)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new YANG Schema semVer source identifier.
static @NonNull SemVerSourceIdentifier	create(String moduleName, SemVer semVer)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new YANG Schema semVer source identifier.
static @NonNull SemVerSourceIdentifier	create(String moduleName, Revision revision, SemVer semVer)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new YANG Schema semVer source identifier.
boolean	equals(Object obj)	Deprecated, for removal: This API element is subject to removal in a future version.
Optional<SemVer>	getSemanticVersion()	Deprecated, for removal: This API element is subject to removal in a future version. Returns semantic version of source if it was specified.
int	hashCode()	Deprecated, for removal: This API element is subject to removal in a future version.
String	toString()	Deprecated, for removal: This API element is subject to removal in a future version.

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

getSemanticVersion

public Optional<SemVer> getSemanticVersion()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns semantic version of source if it was specified.

Returns:

revision of source.

create

public static @NonNull SemVerSourceIdentifier create(String moduleName,
                                                     SemVer semVer)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates new YANG Schema semVer source identifier.

Parameters:

moduleName - Name of schema

semVer - semantic version of source

Returns:

A SemVerSourceIdentifier

create

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

A SemVerSourceIdentifier

create

public static @NonNull SemVerSourceIdentifier create(String moduleName,
                                                     Optional<Revision> revision,
                                                     SemVer semVer)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

A SemVerSourceIdentifier

hashCode

public int hashCode()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

hashCode in interface Identifier

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

equals in interface Identifier

Overrides:

equals in class Object

toString

public String toString()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

toString in interface Identifier

Overrides:

toString in class Object