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

Class SourceIdentifier

java.lang.Object

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

All Implemented Interfaces:

Serializable, Identifier, Immutable, MutationBehaviour<Immutable>

Direct Known Subclasses:

RevisionSourceIdentifier, SemVerSourceIdentifier

@Beta
public abstract class SourceIdentifier
extends Object
implements Identifier, Immutable

Base class of YANG Schema source identifiers.

Source identifiers are designated to be carry only necessary information to look-up YANG model source and to be used by various SchemaSourceProviders.

(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

Modifier and Type	Field and Description
static String	NOT_PRESENT_FORMATTED_REVISION Default revision for sources without specified revision.
static Pattern	REVISION_PATTERN Simplified compiled revision pattern in format YYYY-mm-dd, which checks only distribution of number elements.

Method Summary

Modifier and Type	Method and Description
static SourceIdentifier	create(String moduleName, com.google.common.base.Optional<String> revision) Deprecated. use either SemVerSourceIdentifier.create(String, SemVer) SemVerSourceIdentifier.create(String, Optional, SemVer) SemVerSourceIdentifier.create(String, String, SemVer) or RevisionSourceIdentifier.create(String) RevisionSourceIdentifier.create(String, String) RevisionSourceIdentifier.create(String, Optional)
String	getName() Returns model name.
String	getRevision() Returns revision of source or null if revision was not supplied.
SourceIdentifier	intern() Return an interned reference to a equivalent SemVerSourceIdentifier.
String	toYangFilename() Returns filename for this YANG module as specified in RFC 6020.
static String	toYangFileName(String moduleName, com.google.common.base.Optional<String> revision) Returns filename for this YANG module as specified in RFC 6020.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.concepts.Identifier

equals, hashCode, toString

Field Detail

NOT_PRESENT_FORMATTED_REVISION

public static final String NOT_PRESENT_FORMATTED_REVISION

Default revision for sources without specified revision. This should be used for comparisons based on revision when a SourceIdentifier does not have a revision.

See Also:

Constant Field Values

REVISION_PATTERN

public static final Pattern REVISION_PATTERN

Simplified compiled revision pattern in format YYYY-mm-dd, which checks only distribution of number elements.

For checking if supplied string is real date, use SimpleDateFormatUtil instead.

Method Detail

intern

public SourceIdentifier intern()

Return an interned reference to a equivalent SemVerSourceIdentifier.

Returns:

Interned reference, or this object if it was interned.

getName

public String getName()

Returns model name.

Returns:

model name

getRevision

public String getRevision()

Returns revision of source or null if revision was not supplied.

Returns:

revision of source or null if revision was not supplied.

create

@Deprecated
public static SourceIdentifier create(String moduleName,
                                                  com.google.common.base.Optional<String> revision)

Deprecated. use either

• SemVerSourceIdentifier.create(String, SemVer)
• SemVerSourceIdentifier.create(String, Optional, SemVer)
• SemVerSourceIdentifier.create(String, String, SemVer)

or

• RevisionSourceIdentifier.create(String)
• RevisionSourceIdentifier.create(String, String)
• RevisionSourceIdentifier.create(String, Optional)

Since we've got two ways of model versioning (revision & semantic version), this method shouldn't be called directly anymore. Eventually, callers of this method should be notified before method gets deleted.

Parameters:

moduleName - Name of schema

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

Returns:

particular SourceIdentifier instance

toYangFilename

public String toYangFilename()

Returns filename for this YANG module as specified in RFC 6020.

Returns filename in format name ['@' revision] '.yang', where revision is date in format YYYY-mm-dd.

Returns:

Filename for this source identifier.

See Also:

RFC6020

toYangFileName

public static String toYangFileName(String moduleName,
                                    com.google.common.base.Optional<String> revision)

Returns filename for this YANG module as specified in RFC 6020.

Returns filename in format moduleName ['@' revision] '.yang', where Where revision-date is in format YYYY-mm-dd.

See http://tools.ietf.org/html/rfc6020#section-5.2

Returns:

Filename for this source identifier.