org.onosproject.yangutils.parser.impl.parserutils

Class AugmentListenerUtil

java.lang.Object

org.onosproject.yangutils.parser.impl.parserutils.AugmentListenerUtil

public final class AugmentListenerUtil
extends Object

Represents a utility which provides listener utilities augment node.

Method Summary

Modifier and Type	Method and Description
static void	clearOccurrenceCount() Resets occurrence count to one.
static String	createValidNameForAugment(YangNodeIdentifier nodeId, boolean isPrefix) Creates a name identifier for augment.
static String	generateNameForAugmentNode(Parsable curData, List<YangNodeIdentifier> targetNodes, TreeWalkListener listener) Generates name for augment node also detects collision for java file generation of augment node when augment is updating the same target node in same parent multiple times.
static List<String>	getAugmentJavaFileNameList() Returns augment java file name list.
static String	getParentsPrefix(YangNode curNode) Returns parent nodes prefix.
static ParserException	parserException(GeneratedYangParser.AugmentStatementContext ctx) Builds parser exception.
static String	updateNameWhenHasMultipleOuccrrence(YangNodeIdentifier nodeId, boolean isPrefix) Updates the list of name when augment has occurred multiple times to update the same target node and returns a valid name for augment node's generated java file.
static void	validateNodeInTargetPath(YangNode curNode, List<YangNodeIdentifier> targetNodes, GeneratedYangParser.AugmentStatementContext ctx) Validates whether current node in target path is valid or not.

Methods inherited from class java.lang.Object

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

Method Detail

getAugmentJavaFileNameList

public static List<String> getAugmentJavaFileNameList()

Returns augment java file name list.

Returns:

augment java file name list

generateNameForAugmentNode

public static String generateNameForAugmentNode(Parsable curData,
                                                List<YangNodeIdentifier> targetNodes,
                                                TreeWalkListener listener)

Generates name for augment node also detects collision for java file generation of augment node when augment is updating the same target node in same parent multiple times.

Parameters:

curData - parsable data

targetNodes - list of target nodes

listener - tree walk listener

Returns:

name for augment node

createValidNameForAugment

public static String createValidNameForAugment(YangNodeIdentifier nodeId,
                                               boolean isPrefix)

Creates a name identifier for augment.

Parameters:

nodeId - node identifier

isPrefix - if prefix is present or it is not equals to parent's prefix

Returns:

valid name for augment

updateNameWhenHasMultipleOuccrrence

public static String updateNameWhenHasMultipleOuccrrence(YangNodeIdentifier nodeId,
                                                         boolean isPrefix)

Updates the list of name when augment has occurred multiple times to update the same target node and returns a valid name for augment node's generated java file.

Parameters:

nodeId - YANG node identifier

isPrefix - true if a prefix is present and it is not equals to parents prefix

Returns:

valid name for augment node

clearOccurrenceCount

public static void clearOccurrenceCount()

Resets occurrence count to one.

validateNodeInTargetPath

public static void validateNodeInTargetPath(YangNode curNode,
                                            List<YangNodeIdentifier> targetNodes,
                                            GeneratedYangParser.AugmentStatementContext ctx)

Validates whether current node in target path is valid or not.

Parameters:

curNode - current YANG node

targetNodes - list of target nodes

ctx - augment statement context

parserException

public static ParserException parserException(GeneratedYangParser.AugmentStatementContext ctx)

Builds parser exception.

Parameters:

ctx - augment statement context

Returns:

parser exception

getParentsPrefix

public static String getParentsPrefix(YangNode curNode)

Returns parent nodes prefix.

Parameters:

curNode - current YANG node

Returns:

parent nodes prefix