Package org.opendaylight.yangtools.yang.parser.spi.meta

Class NamespaceBehaviour<K,V,N extends ParserNamespace<K,V>>

java.lang.Object

org.opendaylight.yangtools.concepts.AbstractIdentifiable<T,T>

org.opendaylight.yangtools.concepts.AbstractSimpleIdentifiable<Class<N>>

org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour<K,V,N>

Type Parameters:

K - Key type

V - Value type

N - Namespace Type

All Implemented Interfaces:

Identifiable<Class<N>>

Direct Known Subclasses:

DerivedNamespaceBehaviour, SchemaTreeNamespace

public abstract class NamespaceBehaviour<K,V,N extends ParserNamespace<K,V>>
extends AbstractSimpleIdentifiable<Class<N>>

Definition / implementation of specific Identifier Namespace behaviour. A namespace behaviour is built on top of a tree of NamespaceBehaviour.NamespaceStorageNode which represents local context of one of types defined n NamespaceBehaviour.StorageNodeType.

For common behaviour models please use static factories global(Class), sourceLocal(Class) and treeScoped(Class).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamespaceBehaviour.NamespaceStorageNode
static interface	NamespaceBehaviour.OnDemandSchemaTreeStorageNode	Interface implemented by NamespaceBehaviour.NamespaceStorageNodes which support dynamic addition of child elements as they are requested.
static interface	NamespaceBehaviour.Registry
static class	NamespaceBehaviour.StorageNodeType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NamespaceBehaviour(Class<N> identifier)

Method Summary

Modifier and Type	Method	Description
abstract void	addTo(NamespaceBehaviour.NamespaceStorageNode storage, K key, V value)	Adds a key/value to corresponding namespace storage according to param class.
protected void	addToStorage(NamespaceBehaviour.NamespaceStorageNode storage, K key, V value)
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper helper)
protected static NamespaceBehaviour.NamespaceStorageNode	findClosestTowardsRoot(NamespaceBehaviour.NamespaceStorageNode storage, NamespaceBehaviour.StorageNodeType type)
abstract Map<K,V>	getAllFrom(NamespaceBehaviour.NamespaceStorageNode storage)	Returns all values of a keys of param class from model namespace storage.
protected Map<K,V>	getAllFromLocalStorage(NamespaceBehaviour.NamespaceStorageNode storage)
abstract V	getFrom(NamespaceBehaviour.NamespaceStorageNode storage, K key)	Returns a value from model namespace storage according to key param class.
Optional<Map.Entry<K,V>>	getFrom(NamespaceBehaviour.NamespaceStorageNode storage, NamespaceKeyCriterion<K> criterion)	Returns the key/value mapping best matching specified criterion.
protected V	getFromLocalStorage(NamespaceBehaviour.NamespaceStorageNode storage, K key)
static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N>	global(Class<N> identifier)	Creates a global namespace behaviour for supplied namespace type.
static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N>	rootStatementLocal(Class<N> identifier)	Creates a root-statement-local namespace behaviour for supplied namespace type.
static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N>	sourceLocal(Class<N> identifier)	Creates source-local namespace behaviour for supplied namespace type.
static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N>	statementLocal(Class<N> identifier)
static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N>	treeScoped(Class<N> identifier)	Creates tree-scoped namespace behaviour for supplied namespace type.

Methods inherited from class org.opendaylight.yangtools.concepts.AbstractIdentifiable

getIdentifier, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceBehaviour

protected NamespaceBehaviour(Class<N> identifier)

Method Detail

global

public static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N> global(Class<N> identifier)

Creates a global namespace behaviour for supplied namespace type. Global behaviour stores and loads all values from root NamespaceBehaviour.NamespaceStorageNode with type of NamespaceBehaviour.StorageNodeType.GLOBAL.

Type Parameters:

K - type parameter

V - type parameter

N - type parameter

Parameters:

identifier - Namespace identifier.

Returns:

global namespace behaviour for supplied namespace type.

sourceLocal

public static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N> sourceLocal(Class<N> identifier)

Creates source-local namespace behaviour for supplied namespace type. Source-local namespace behaviour stores and loads all values from closest NamespaceBehaviour.NamespaceStorageNode ancestor with type of NamespaceBehaviour.StorageNodeType.SOURCE_LOCAL_SPECIAL.

Type Parameters:

K - type parameter

V - type parameter

N - type parameter

Parameters:

identifier - Namespace identifier.

Returns:

source-local namespace behaviour for supplied namespace type.

statementLocal

public static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N> statementLocal(Class<N> identifier)

rootStatementLocal

public static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N> rootStatementLocal(Class<N> identifier)

Creates a root-statement-local namespace behaviour for supplied namespace type. Root-statement-local namespace behaviour stores and loads all values from closest NamespaceBehaviour.NamespaceStorageNode ancestor with type of NamespaceBehaviour.StorageNodeType.ROOT_STATEMENT_LOCAL.

Type Parameters:

K - type parameter

V - type parameter

N - type parameter

Parameters:

identifier - Namespace identifier.

Returns:

root-statement-local namespace behaviour for supplied namespace type.

treeScoped

public static <K,V,N extends ParserNamespace<K,V>> @NonNull NamespaceBehaviour<K,V,N> treeScoped(Class<N> identifier)

Creates tree-scoped namespace behaviour for supplied namespace type. Tree-scoped namespace behaviour searches for value in all storage nodes up to the root and stores values in supplied node.

Type Parameters:

K - type parameter

V - type parameter

N - type parameter

Parameters:

identifier - Namespace identifier.

Returns:

tree-scoped namespace behaviour for supplied namespace type.

getFrom

public abstract V getFrom(NamespaceBehaviour.NamespaceStorageNode storage,
                          K key)

Returns a value from model namespace storage according to key param class.

Parameters:

storage - namespace storage

key - type parameter

Returns:

value from model namespace storage according to key param class

getFrom

public final Optional<Map.Entry<K,V>> getFrom(NamespaceBehaviour.NamespaceStorageNode storage,
                                                    NamespaceKeyCriterion<K> criterion)

Returns the key/value mapping best matching specified criterion.

Parameters:

storage - namespace storage

criterion - selection criterion

Returns:

Selected mapping, if available.

getAllFrom

public abstract Map<K,V> getAllFrom(NamespaceBehaviour.NamespaceStorageNode storage)

Returns all values of a keys of param class from model namespace storage.

Parameters:

storage - namespace storage

Returns:

all values of keys of param class from model namespace storage

addTo

public abstract void addTo(NamespaceBehaviour.NamespaceStorageNode storage,
                           K key,
                           V value)

Adds a key/value to corresponding namespace storage according to param class.

Parameters:

storage - namespace storage

key - type parameter

value - type parameter

getFromLocalStorage

protected final V getFromLocalStorage(NamespaceBehaviour.NamespaceStorageNode storage,
                                      K key)

getAllFromLocalStorage

protected final Map<K,V> getAllFromLocalStorage(NamespaceBehaviour.NamespaceStorageNode storage)

addToStorage

protected final void addToStorage(NamespaceBehaviour.NamespaceStorageNode storage,
                                  K key,
                                  V value)

findClosestTowardsRoot

protected static NamespaceBehaviour.NamespaceStorageNode findClosestTowardsRoot(NamespaceBehaviour.NamespaceStorageNode storage,
                                                                                NamespaceBehaviour.StorageNodeType type)

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper helper)

Overrides:

addToStringAttributes in class AbstractIdentifiable<Class<N extends ParserNamespace<K,V>>,Class<N extends ParserNamespace<K,V>>>