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

Enclosing class:

YangInstanceIdentifier

public static final class YangInstanceIdentifier.NodeIdentifierWithPredicates
extends Object

Composite path argument identifying a MapEntryNode leaf overall data tree.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NodeIdentifierWithPredicates(QName node) Deprecated.
NodeIdentifierWithPredicates(QName node, ImmutableOffsetMap<QName,Object> keyValues) Deprecated.
NodeIdentifierWithPredicates(QName node, Map<QName,Object> keyValues) Deprecated.
NodeIdentifierWithPredicates(QName node, QName key, Object value) Deprecated.
NodeIdentifierWithPredicates(QName node, SharedSingletonMap<QName,Object> keyValues) Deprecated.

Method Summary

Modifier and Type	Method and Description
@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.
boolean	containsKey(QName key) Determine whether a particular predicate key is present.
@NonNull Set<Map.Entry<QName,Object>>	entrySet() Return the set of predicates keys and values.
boolean	equals(Object obj)
@NonNull Map<QName,Object>	getKeyValues() Deprecated. Map view is actively discouraged and should be considered deprecated. For replacement, please see keySet(), #entrySet()}, values() and size(). As a last resort, please migrate to asMap().
@Nullable Object	getValue(QName key)
<T> T	getValue(QName key, Class<T> valueClass)
protected int	hashCodeImpl()
@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, ImmutableOffsetMap<QName,Object> keyValues)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, Map<QName,Object> keyValues)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, QName key, Object value)
static @NonNull YangInstanceIdentifier.NodeIdentifierWithPredicates	of(QName node, SharedSingletonMap<QName,Object> keyValues)
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()
@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

Constructor Detail

NodeIdentifierWithPredicates

@Deprecated
public NodeIdentifierWithPredicates(QName node)

Deprecated.

NodeIdentifierWithPredicates

@Deprecated
public NodeIdentifierWithPredicates(QName node,
                                                Map<QName,Object> keyValues)

Deprecated.

NodeIdentifierWithPredicates

@Deprecated
public NodeIdentifierWithPredicates(QName node,
                                                ImmutableOffsetMap<QName,Object> keyValues)

Deprecated.

NodeIdentifierWithPredicates

@Deprecated
public NodeIdentifierWithPredicates(QName node,
                                                SharedSingletonMap<QName,Object> keyValues)

Deprecated.

NodeIdentifierWithPredicates

@Deprecated
public NodeIdentifierWithPredicates(QName node,
                                                QName key,
                                                Object value)

Deprecated.

Method Detail

of

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

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

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

of

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

getKeyValues

@Deprecated
public @NonNull Map<QName,Object> getKeyValues()

Deprecated. Map view is actively discouraged and should be considered deprecated. For replacement, please see keySet(), #entrySet()}, values() and size(). As a last resort, please migrate to asMap().

Return predicates as a Map.

Returns:

Predicate map.

entrySet

@Beta
public @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

@Beta
public @NonNull Set<QName> keySet()

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

Returns:

Predicate values.

containsKey

@Beta
public 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

@Beta
public @NonNull Collection<Object> values()

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

Returns:

Predicate values.

getValue

@Beta
public @Nullable Object getValue(QName key)

getValue

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

size

@Beta
public int size()

Return the number of predicates present.

Returns:

Thee number of predicates present.

asMap

@Beta
 @Deprecated
public @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. While this method is deprecated, it is preferred to getKeyValues(). The view is expected to be stable and effectively-immutable.

Returns:

Map of predicates.

hashCodeImpl

protected int hashCodeImpl()

equals

public boolean equals(Object obj)

toString

public String toString()

toRelativeString

public 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