Package org.opendaylight.yangtools.yang.parser.api

Record Class YangLibModule

java.lang.Object

java.lang.Record

org.opendaylight.yangtools.yang.parser.api.YangLibModule

Record Components:

identifier - SourceIdentifier of this module, e.g. the combination of name and revision

namespace - XMLNamespace of this module

submodules - Submodules of this module

features - The set of supported features in this module

deviationModuleNames - Names of modules containing deviate statements targetting this module

source - A SourceRepresentation of the module

public record YangLibModule(@NonNull SourceIdentifier identifier, @NonNull XMLNamespace namespace, @NonNull ImmutableMap<UnresolvedQName.Unqualified,YangLibSubmodule> submodules, @NonNull ImmutableSet<UnresolvedQName.Unqualified> features, @NonNull ImmutableSet<UnresolvedQName.Unqualified> deviationModuleNames, @NonNull SourceRepresentation source)
extends Record

A single RFC8525 module or import-only-module list entry. Note that the YANG definition has two dissimilar instances, but that really is an artifact of how indexes work in YANG.

Constructor Summary

Constructors

Constructor	Description
YangLibModule(@NonNull SourceIdentifier identifier, @NonNull XMLNamespace namespace, @NonNull ImmutableMap<UnresolvedQName.Unqualified,YangLibSubmodule> submodules, @NonNull ImmutableSet<UnresolvedQName.Unqualified> features, @NonNull ImmutableSet<UnresolvedQName.Unqualified> deviationModuleNames, @NonNull SourceRepresentation source)	Creates an instance of a YangLibModule record class.

Method Summary

Modifier and Type	Method	Description
@NonNull ImmutableSet<UnresolvedQName.Unqualified>	deviationModuleNames()	Returns the value of the deviationModuleNames record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NonNull ImmutableSet<UnresolvedQName.Unqualified>	features()	Returns the value of the features record component.
final int	hashCode()	Returns a hash code value for this object.
@NonNull SourceIdentifier	identifier()	Returns the value of the identifier record component.
@NonNull XMLNamespace	namespace()	Returns the value of the namespace record component.
@NonNull SourceRepresentation	source()	Returns the value of the source record component.
@NonNull ImmutableMap<UnresolvedQName.Unqualified,YangLibSubmodule>	submodules()	Returns the value of the submodules record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

YangLibModule

public YangLibModule(@NonNull SourceIdentifier identifier,
 @NonNull XMLNamespace namespace,
 @NonNull ImmutableMap<UnresolvedQName.Unqualified,YangLibSubmodule> submodules,
 @NonNull ImmutableSet<UnresolvedQName.Unqualified> features,
 @NonNull ImmutableSet<UnresolvedQName.Unqualified> deviationModuleNames,
 @NonNull SourceRepresentation source)

Creates an instance of a YangLibModule record class.

Parameters:

identifier - the value for the identifier record component

namespace - the value for the namespace record component

submodules - the value for the submodules record component

features - the value for the features record component

deviationModuleNames - the value for the deviationModuleNames record component

source - the value for the source record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

identifier

public @NonNull SourceIdentifier identifier()

Returns the value of the identifier record component.

Returns:

the value of the identifier record component

namespace

public @NonNull XMLNamespace namespace()

Returns the value of the namespace record component.

Returns:

the value of the namespace record component

submodules

public @NonNull ImmutableMap<UnresolvedQName.Unqualified,YangLibSubmodule> submodules()

Returns the value of the submodules record component.

Returns:

the value of the submodules record component

features

public @NonNull ImmutableSet<UnresolvedQName.Unqualified> features()

Returns the value of the features record component.

Returns:

the value of the features record component

deviationModuleNames

public @NonNull ImmutableSet<UnresolvedQName.Unqualified> deviationModuleNames()

Returns the value of the deviationModuleNames record component.

Returns:

the value of the deviationModuleNames record component

source

public @NonNull SourceRepresentation source()

Returns the value of the source record component.

Returns:

the value of the source record component