Package org.opendaylight.yangtools.yang.model.api.stmt

Class FeatureSet

java.lang.Object

org.opendaylight.yangtools.yang.model.api.stmt.FeatureSet

All Implemented Interfaces:

Immutable

public abstract sealed class FeatureSet
extends Object
implements Immutable

A set of features.

The semantics of contains(QName) is a bit funky, depending on implementation:

1. explicit implementation, returned from of(), of(Set) et al., delegates to the underlying Set's Set.contains(Object), while on the other hand
2. sparse implementation, constructed via builder() and FeatureSet.Builder.build(), carves the features into well-known module namespaces, expressed as QNameModule for which we have an explicit enumeration of supported features. All other module namespaces are treated as if there was no specification of supported features -- e.g. all features from those namespaces are deemed to be present in the instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FeatureSet.Builder	A builder for a sparse FeatureSet.

Constructor Summary

Constructors

Constructor	Description
FeatureSet()

Method Summary

Modifier and Type	Method	Description
static @NonNull FeatureSet.Builder	builder()
abstract boolean	contains(@NonNull QName qname)	Determine whether a particular feature, as identified by its QName is part of this set.
abstract boolean	equals(Object obj)
abstract int	hashCode()
static @NonNull FeatureSet	of()	Return an empty FeatureSet.
static @NonNull FeatureSet	of(Set<QName> features)	Return a FeatureSet containing specified features.
static @NonNull FeatureSet	of(QName... features)	Return a FeatureSet containing specified features.
abstract String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FeatureSet

public FeatureSet()

Method Details

of

public static @NonNull FeatureSet of()

Return an empty FeatureSet.

Returns:

An empty FeatureSet

of

public static @NonNull FeatureSet of(QName... features)

Return a FeatureSet containing specified features.

Returns:

A FeatureSet

Throws:

NullPointerException - if features is or contains null

of

public static @NonNull FeatureSet of(Set<QName> features)

Return a FeatureSet containing specified features.

Returns:

A FeatureSet

Throws:

NullPointerException - if features is or contains null

builder

public static @NonNull FeatureSet.Builder builder()

contains

public abstract boolean contains(@NonNull QName qname)

Determine whether a particular feature, as identified by its QName is part of this set.

Parameters:

qname - Feature QName

Returns:

true if this set contains the feature

Throws:

NullPointerException - if qname is null

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

toString

public abstract String toString()

Overrides:

toString in class Object