Package org.opendaylight.yangtools.yang.data.api

Class YangInstanceIdentifier.NodeIdentifierWithPredicates

java.lang.Object

org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates

All Implemented Interfaces:

Serializable, Comparable<YangInstanceIdentifier.PathArgument>, Immutable, MutationBehaviour<Immutable>, YangInstanceIdentifier.PathArgument

Direct Known Subclasses:

YangInstanceIdentifier.NodeIdentifierWithPredicates.Singleton

Enclosing class:

YangInstanceIdentifier

public abstract static class YangInstanceIdentifier.NodeIdentifierWithPredicates
extends Object

Composite path argument identifying a MapEntryNode leaf overall data tree.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YangInstanceIdentifier.NodeIdentifierWithPredicates.Singleton

Method Summary

Modifier and Type	Method	Description
abstract @NonNull Map<QName,Object>	asMap()	Deprecated. This method in a provisional one.
abstract boolean	containsKey(QName key)	Determine whether a particular predicate key is present.
abstract @NonNull Set<Map.Entry<QName,Object>>	entrySet()	Return the set of predicates keys and values.
boolean	equals(Object obj)
@Nullable Object	getValue(QName key)
<T> @Nullable T	getValue(QName key, Class<T> valueClass)
protected int	hashCodeImpl()
abstract @NonNull Set<QName>	keySet()	Return the predicate key in the iteration order of entrySet().
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, Map.Entry<QName,Object> entry)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, Map<QName,Object> keyValues)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, ImmutableOffsetMap<QName,Object> keyValues)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, SharedSingletonMap<QName,Object> keyValues)	Deprecated.
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, QName key, Object value)
abstract int	size()	Return the number of predicates present.
String	toRelativeString(YangInstanceIdentifier.PathArgument previous)	Return the string representation of this object for use in context provided by a previous object.
String	toString()
abstract @NonNull Collection<Object>	values()	Return the predicate values in the iteration order of entrySet().

Methods inherited from class java.lang.Object

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

Method Detail

of

public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node)

of

public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node,
                                                                              QName key,
                                                                              Object value)

of

public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node,
                                                                              Map.Entry<QName,Object> entry)

of

public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node,
                                                                              Map<QName,Object> keyValues)

of

public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node,
                                                                              ImmutableOffsetMap<QName,Object> keyValues)

of

@Deprecated
public static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates of(QName node,
                                                                              SharedSingletonMap<QName,Object> keyValues)

Deprecated.

entrySet

public abstract @NonNull Set<Map.Entry<QName,Object>> entrySet()

Return the set of predicates keys and values. Keys are guaranteeed to be unique.

Returns:

Predicate set.

keySet

public abstract @NonNull Set<QName> keySet()

Return the predicate key in the iteration order of entrySet().

Returns:

Predicate values.

containsKey

public abstract boolean containsKey(QName key)

Determine whether a particular predicate key is present.

Parameters:

key - Predicate key

Returns:

True if the predicate is present, false otherwise

Throws:

NullPointerException - if key is null

values

public abstract @NonNull Collection<Object> values()

Return the predicate values in the iteration order of entrySet().

Returns:

Predicate values.

getValue

@Beta
public final @Nullable Object getValue(QName key)

getValue

@Beta
public final <T> @Nullable T getValue(QName key,
                                      Class<T> valueClass)

size

public abstract int size()

Return the number of predicates present.

Returns:

The number of predicates present.

asMap

public abstract @NonNull Map<QName,Object> asMap()

Deprecated.

This method in a provisional one. It can be used in the code base, but users requiring it should contact yangtools-dev for migration guidelines. Callers are strongly encouraged to explore entrySet(), size(), values() and keySet() as an alternative.

A Map-like view of this identifier's predicates. The view is expected to be stable and effectively-immutable.

Returns:

Map of predicates.

hashCodeImpl

protected final int hashCodeImpl()

equals

public final boolean equals(Object obj)

toString

public final String toString()

toRelativeString

public final String toRelativeString(YangInstanceIdentifier.PathArgument previous)

Description copied from interface: YangInstanceIdentifier.PathArgument

Return the string representation of this object for use in context provided by a previous object. This method can be implemented in terms of YangInstanceIdentifier.toString(), but implementations are encourage to reuse any context already emitted by the previous object.

Specified by:

toRelativeString in interface YangInstanceIdentifier.PathArgument

Parameters:

previous - Previous path argument

Returns:

String representation