SchemaUtils (yangtools 1.1.5-SNAPSHOT API)

java.lang.Object
- org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils

public final class SchemaUtils
extends Object

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`belongsToCaseAugment(ChoiceCaseNode caseNode, YangInstanceIdentifier.AugmentationIdentifier childToProcess)`
`static com.google.common.base.Optional<ChoiceCaseNode>`	`detectCase(ChoiceSchemaNode schema, DataContainerChild<?,?> child)`
`static SchemaNode`	`findChildSchemaByQName(SchemaNode node, QName qname)` Deprecated. use `findChildSchemaNodesByQName(SchemaNode, QName)` instead.
`static Collection<SchemaNode>`	`findChildSchemaNodesByQName(SchemaNode node, QName qname)` Find child schema node identified by its QName within a provided schema node.
`static AugmentationSchema`	`findCorrespondingAugment(DataSchemaNode parent, DataSchemaNode child)` Tries to find in `parent` which is dealed as augmentation target node with QName as `child`.
`static SchemaNode`	`findDataChildSchemaByQName(SchemaNode node, QName qname)` Find child data schema node identified by its QName within a provided schema node.
`static SchemaNode`	`findDataParentSchemaOnPath(SchemaContext schemaContext, SchemaPath path)` Finds schema node for given path in schema context.
`static com.google.common.base.Optional<DataSchemaNode>`	`findFirstSchema(QName qname, Iterable<DataSchemaNode> dataSchemaNode)`
`static Collection<SchemaNode>`	`findParentSchemaNodesOnPath(SchemaContext schemaContext, SchemaPath path)` Finds schema node for given path in schema context.
`static SchemaNode`	`findParentSchemaOnPath(SchemaContext schemaContext, SchemaPath path)` Deprecated. use `findParentSchemaNodesOnPath(SchemaContext, SchemaPath)` instead.
`static AugmentationSchema`	`findSchemaForAugment(AugmentationTarget schema, Set<QName> qNames)`
`static AugmentationSchema`	`findSchemaForAugment(ChoiceSchemaNode schema, Set<QName> qNames)`
`static DataSchemaNode`	`findSchemaForChild(ChoiceSchemaNode schema, QName childPartialQName)`
`static DataSchemaNode`	`findSchemaForChild(DataNodeContainer schema, QName qname)` Find child schema node identified by its QName within a provided schema node
`static DataSchemaNode`	`findSchemaForChild(DataNodeContainer schema, QName qname, boolean strictMode)`
`static DataSchemaNode`	`findSchemaForChild(DataNodeContainer schema, QName qname, Iterable<DataSchemaNode> childNodes)`
`static Set<QName>`	`getChildNodesRecursive(DataNodeContainer nodeContainer)` Recursively list all child nodes.
`static YangInstanceIdentifier.AugmentationIdentifier`	`getNodeIdentifierForAugmentation(AugmentationSchema schema)`
`static Set<DataSchemaNode>`	`getRealSchemasForAugment(AugmentationTarget targetSchema, AugmentationSchema augmentSchema)` Retrieves real schemas for augmented child node.
`static Set<DataSchemaNode>`	`getRealSchemasForAugment(DataNodeContainer targetSchema, AugmentationSchema augmentSchema)`
`static Map<QName,AugmentationSchema>`	`mapChildElementsFromAugments(AugmentationTarget schema)` Recursively find all child nodes that come from augmentations.
`static Map<QName,ChoiceSchemaNode>`	`mapChildElementsFromChoices(DataNodeContainer schema)` Recursively find all child nodes that come from choices.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - findFirstSchema
```
public static com.google.common.base.Optional<DataSchemaNode> findFirstSchema(QName qname,
                                                                              Iterable<DataSchemaNode> dataSchemaNode)
```
    Parameters:
    
    qname - - schema node to find
    
    dataSchemaNode - - iterable of schemaNodes to look through
    
    Returns:
    
    - schema node with newest revision or absent if no schema node with matching qname is found
  - findSchemaForChild
```
public static DataSchemaNode findSchemaForChild(DataNodeContainer schema,
                                                QName qname)
```
    Find child schema node identified by its QName within a provided schema node
    
    Parameters:
    
    schema - schema for parent node - search root
    
    qname - qname(with or without a revision) of a child node to be found in the parent schema
    
    Returns:
    
    found schema node
    
    Throws:
    
    IllegalStateException - if the child was not found in parent schema node
  - findSchemaForChild
```
@Nullable
public static DataSchemaNode findSchemaForChild(DataNodeContainer schema,
                                                          QName qname,
                                                          boolean strictMode)
```
  - findSchemaForChild
```
public static DataSchemaNode findSchemaForChild(DataNodeContainer schema,
                                                QName qname,
                                                Iterable<DataSchemaNode> childNodes)
```
  - findSchemaForAugment
```
public static AugmentationSchema findSchemaForAugment(AugmentationTarget schema,
                                                      Set<QName> qNames)
```
  - findSchemaForAugment
```
public static AugmentationSchema findSchemaForAugment(ChoiceSchemaNode schema,
                                                      Set<QName> qNames)
```
  - findSchemaForChild
```
public static DataSchemaNode findSchemaForChild(ChoiceSchemaNode schema,
                                                QName childPartialQName)
```
  - mapChildElementsFromChoices
```
public static Map<QName,ChoiceSchemaNode> mapChildElementsFromChoices(DataNodeContainer schema)
```
    Recursively find all child nodes that come from choices.
    
    Parameters:
    
    schema - schema
    
    Returns:
    
    Map with all child nodes, to their most top augmentation
  - mapChildElementsFromAugments
```
public static Map<QName,AugmentationSchema> mapChildElementsFromAugments(AugmentationTarget schema)
```
    Recursively find all child nodes that come from augmentations.
    
    Parameters:
    
    schema - schema
    
    Returns:
    
    Map with all child nodes, to their most top augmentation
  - getChildNodesRecursive
```
public static Set<QName> getChildNodesRecursive(DataNodeContainer nodeContainer)
```
    Recursively list all child nodes. In case of choice, augment and cases, step in.
    
    Parameters:
    
    nodeContainer - node container
    
    Returns:
    
    set of QNames
  - getRealSchemasForAugment
```
public static Set<DataSchemaNode> getRealSchemasForAugment(AugmentationTarget targetSchema,
                                                           AugmentationSchema augmentSchema)
```
    Retrieves real schemas for augmented child node. Schema of the same child node from augment, and directly from target is not the same. Schema of child node from augment is incomplete, therefore its useless for XML/NormalizedNode translation.
    
    Parameters:
    
    targetSchema - target schema
    
    augmentSchema - augment schema
    
    Returns:
    
    set of nodes
  - getRealSchemasForAugment
```
public static Set<DataSchemaNode> getRealSchemasForAugment(DataNodeContainer targetSchema,
                                                           AugmentationSchema augmentSchema)
```
  - detectCase
```
public static com.google.common.base.Optional<ChoiceCaseNode> detectCase(ChoiceSchemaNode schema,
                                                                         DataContainerChild<?,?> child)
```
  - belongsToCaseAugment
```
public static boolean belongsToCaseAugment(ChoiceCaseNode caseNode,
                                           YangInstanceIdentifier.AugmentationIdentifier childToProcess)
```
  - findCorrespondingAugment
```
public static AugmentationSchema findCorrespondingAugment(DataSchemaNode parent,
                                                          DataSchemaNode child)
```
    Tries to find in parent which is dealed as augmentation target node with QName as child. If such node is found then it is returned, else null.
    
    Parameters:
    
    parent - parent node
    
    child - child node
    
    Returns:
    
    augmentation schema
  - getNodeIdentifierForAugmentation
```
public static YangInstanceIdentifier.AugmentationIdentifier getNodeIdentifierForAugmentation(AugmentationSchema schema)
```
  - findDataParentSchemaOnPath
```
public static SchemaNode findDataParentSchemaOnPath(SchemaContext schemaContext,
                                                    SchemaPath path)
```
    Finds schema node for given path in schema context. This method performs lookup in the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1.
    
    Parameters:
    
    schemaContext - schema context
    
    path - path
    
    Returns:
    
    schema node on path
  - findParentSchemaOnPath
```
@Deprecated
public static SchemaNode findParentSchemaOnPath(SchemaContext schemaContext,
                                                            SchemaPath path)
```
    Deprecated. use findParentSchemaNodesOnPath(SchemaContext, SchemaPath) instead.
    
    Finds schema node for given path in schema context. This method performs lookup in both the namespace of groupings and the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1. This method is deprecated, because name conflicts can occur between the namespace of groupings and namespace of data nodes and in consequence lookup could be ambiguous.
    
    Parameters:
    
    schemaContext - schema context
    
    path - path
    
    Returns:
    
    schema node on path
  - findDataChildSchemaByQName
```
@Nullable
public static SchemaNode findDataChildSchemaByQName(SchemaNode node,
                                                              QName qname)
```
    Find child data schema node identified by its QName within a provided schema node. This method performs lookup in the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1.
    
    Parameters:
    
    node - schema node
    
    qname - QName
    
    Returns:
    
    data child schema node
    
    Throws:
    
    IllegalArgumentException - if the schema node does not allow children
  - findChildSchemaByQName
```
@Deprecated
public static SchemaNode findChildSchemaByQName(SchemaNode node,
                                                            QName qname)
```
    Deprecated. use findChildSchemaNodesByQName(SchemaNode, QName) instead.
    
    Find child schema node identified by its QName within a provided schema node. This method performs lookup in both the namespace of groupings and the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1. This method is deprecated, because name conflicts can occur between the namespace of groupings and namespace of data nodes and in consequence lookup could be ambiguous.
    
    Parameters:
    
    node - schema node
    
    qname - QName
    
    Returns:
    
    child schema node
    
    Throws:
    
    IllegalArgumentException - if the schema node does not allow children
  - findParentSchemaNodesOnPath
```
public static Collection<SchemaNode> findParentSchemaNodesOnPath(SchemaContext schemaContext,
                                                                 SchemaPath path)
```
    Finds schema node for given path in schema context. This method performs lookup in both the namespace of groupings and the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1. This method returns collection of SchemaNodes, because name conflicts can occur between the namespace of groupings and namespace of data nodes. This method finds and collects all schema nodes that matches supplied SchemaPath and returns them all as collection of schema nodes.
    
    Parameters:
    
    schemaContext - schema context
    
    path - path
    
    Returns:
    
    collection of schema nodes on path
  - findChildSchemaNodesByQName
```
public static Collection<SchemaNode> findChildSchemaNodesByQName(SchemaNode node,
                                                                 QName qname)
```
    Find child schema node identified by its QName within a provided schema node. This method performs lookup in both the namespace of groupings and the namespace of all leafs, leaf-lists, lists, containers, choices, rpcs, actions, notifications, anydatas, and anyxmls according to Rfc6050/Rfc7950 section 6.2.1. This method returns collection of SchemaNodes, because name conflicts can occur between the namespace of groupings and namespace of data nodes. This method finds and collects all schema nodes with supplied QName and returns them all as collection of schema nodes.
    
    Parameters:
    
    node - schema node
    
    qname - QName
    
    Returns:
    
    collection of child schema nodes
    
    Throws:
    
    IllegalArgumentException - if the schema node does not allow children

Class SchemaUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

findFirstSchema

findSchemaForChild

findSchemaForChild

findSchemaForChild

findSchemaForAugment

findSchemaForAugment

findSchemaForChild

mapChildElementsFromChoices

mapChildElementsFromAugments

getChildNodesRecursive

getRealSchemasForAugment

getRealSchemasForAugment

detectCase

belongsToCaseAugment

findCorrespondingAugment

getNodeIdentifierForAugmentation

findDataParentSchemaOnPath

findParentSchemaOnPath

findDataChildSchemaByQName

findChildSchemaByQName

findParentSchemaNodesOnPath

findChildSchemaNodesByQName