org.onosproject.yang.compiler.parser.impl.parserutils

Class ListenerUtil

java.lang.Object

org.onosproject.yang.compiler.parser.impl.parserutils.ListenerUtil

public final class ListenerUtil
extends Object

Represents an utility for listener.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARACTER_POSITION
static String	FILE
static String	LINE_NUMBER
static String	SPACE

Method Summary

Modifier and Type	Method and Description
static void	addUniqueHolderToRoot(org.onosproject.yang.compiler.datamodel.YangUniqueHolder holder) Adds the unique holder to the module or sub-module node.
static void	checkAugNameCollision(org.onosproject.yang.compiler.datamodel.YangNode root, org.onosproject.yang.compiler.datamodel.YangAugment aug) Checks for the augment name name collision.
static Date	getCurrentDateForRevision() Returns current date and makes it in usable format for revision.
static String	getParsedPath(String nodeId, String path, List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomics, GeneratedYangParser.PathStatementContext pathCtx, org.onosproject.yang.compiler.datamodel.YangLeafRef yangLeafRef, org.onosproject.yang.compiler.datamodel.utils.YangConstructType pathType) Returns the path after taking all the path predicates of an atomic content.
static String	getPath(String path, List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomicList, org.onosproject.yang.compiler.datamodel.utils.YangConstructType pathType, GeneratedYangParser.PathStatementContext pathCtx) Returns the remaining path after parsing and processing an atomic content which doesn't have path-predicate.
static String	getPrefixRemovedName(List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomics, org.onosproject.yang.compiler.datamodel.YangNode root) Returns the augment name, after removing the prefix, in each atomic content, which is equal to the root prefix.
static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath>	getValidAbsoluteSchemaNodeId(String argumentString, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid absolute schema node id.
static boolean	getValidBooleanValue(String booleanValue, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates boolean value.
static Date	getValidDateFromString(String dateInString, org.antlr.v4.runtime.ParserRuleContext ctx) Returns date and makes it in usable format for revision.
static String	getValidIdentifier(String identifier, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates identifier and returns concatenated string if string contains plus symbol.
static int	getValidIntegerValue(String integerValue, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates integer value.
static org.onosproject.yang.compiler.datamodel.YangNodeIdentifier	getValidNodeIdentifier(String nodeIdentifierString, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid node identifier.
static int	getValidNonNegativeIntegerValue(String integerValue, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates non negative integer value.
static String	getValidPrefix(String inputString, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid prefix.
static String	getValidVersion(GeneratedYangParser.YangVersionStatementContext ctx) Validates YANG version.
static void	handleUnsupportedYangConstruct(org.onosproject.yang.compiler.datamodel.utils.YangConstructType type, org.antlr.v4.runtime.ParserRuleContext ctx, String errorInfo, String fileName, String identifier) Throws parser exception for unsupported YANG constructs.
static boolean	isDateValid(String dateToValidate) Validates the revision date.
static boolean	isDuplicateNode(org.onosproject.yang.compiler.datamodel.YangAugment augment) Checks if the augment node is a duplicate node.
static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath>	parseUsesAugment(org.onosproject.yang.compiler.datamodel.YangNode uses, GeneratedYangParser.AugmentStatementContext ctx) Parses the uses augment statement, validates the statement and creates a list of YANG atomic path.
static void	removeAugment(org.onosproject.yang.compiler.datamodel.YangAugment augment) Removes the duplicate YANG augment from the data tree by detaching it from its parent and from its sibling.
static String	removeQuotesAndHandleConcat(String yangStringData) Removes doubles quotes and concatenates if string has plus symbol.
static void	validatePath(String path, org.onosproject.yang.compiler.datamodel.utils.YangConstructType type, GeneratedYangParser.PathStatementContext ctx, org.onosproject.yang.compiler.datamodel.YangLeafRef leafRef) Validates path under leaf-ref and parses the path and stores in the leaf-ref.
static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath>	validateUniqueInList(org.onosproject.yang.compiler.datamodel.YangUniqueHolder holder, String val, org.antlr.v4.runtime.ParserRuleContext ctx) Validates unique from the list.

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

public static final String SPACE

See Also:

Constant Field Values

LINE_NUMBER

public static final String LINE_NUMBER

See Also:

Constant Field Values

CHARACTER_POSITION

public static final String CHARACTER_POSITION

See Also:

Constant Field Values

FILE

public static final String FILE

See Also:

Constant Field Values

Method Detail

removeQuotesAndHandleConcat

public static String removeQuotesAndHandleConcat(String yangStringData)

Removes doubles quotes and concatenates if string has plus symbol.

Parameters:

yangStringData - string from yang file

Returns:

concatenated string after removing double quotes

getValidIdentifier

public static String getValidIdentifier(String identifier,
                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                        org.antlr.v4.runtime.ParserRuleContext ctx)

Validates identifier and returns concatenated string if string contains plus symbol.

Parameters:

identifier - string from yang file

yangConstruct - yang construct for creating error message

ctx - yang construct's context to get the line number and character position

Returns:

concatenated string after removing double quotes

isDateValid

public static boolean isDateValid(String dateToValidate)

Validates the revision date.

Parameters:

dateToValidate - input revision date

Returns:

validation result, true for success, false for failure

getValidVersion

public static String getValidVersion(GeneratedYangParser.YangVersionStatementContext ctx)

Validates YANG version.

Parameters:

ctx - version context object of the grammar rule

Returns:

valid version

getValidNonNegativeIntegerValue

public static int getValidNonNegativeIntegerValue(String integerValue,
                                                  org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                                  org.antlr.v4.runtime.ParserRuleContext ctx)

Validates non negative integer value.

Parameters:

integerValue - integer to be validated

yangConstruct - yang construct for creating error message

ctx - context object of the grammar rule

Returns:

valid non negative integer value

getValidIntegerValue

public static int getValidIntegerValue(String integerValue,
                                       org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                       org.antlr.v4.runtime.ParserRuleContext ctx)

Validates integer value.

Parameters:

integerValue - integer to be validated

yangConstruct - yang construct for creating error message

ctx - context object of the grammar rule

Returns:

valid integer value

getValidBooleanValue

public static boolean getValidBooleanValue(String booleanValue,
                                           org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                           org.antlr.v4.runtime.ParserRuleContext ctx)

Validates boolean value.

Parameters:

booleanValue - value to be validated

yangConstruct - yang construct for creating error message

ctx - context object of the grammar rule

Returns:

boolean value either true or false

getCurrentDateForRevision

public static Date getCurrentDateForRevision()

Returns current date and makes it in usable format for revision.

Returns:

usable current date format for revision

getValidNodeIdentifier

public static org.onosproject.yang.compiler.datamodel.YangNodeIdentifier getValidNodeIdentifier(String nodeIdentifierString,
                                                                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                                                                                org.antlr.v4.runtime.ParserRuleContext ctx)

Checks and return valid node identifier.

Parameters:

nodeIdentifierString - string from yang file

yangConstruct - yang construct for creating error message

ctx - yang construct's context to get the line number and character position

Returns:

valid node identifier

parseUsesAugment

public static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> parseUsesAugment(org.onosproject.yang.compiler.datamodel.YangNode uses,
                                                                                            GeneratedYangParser.AugmentStatementContext ctx)

Parses the uses augment statement, validates the statement and creates a list of YANG atomic path.

Parameters:

uses - YANG uses

ctx - YANG construct

Returns:

YANG atomic path list

addUniqueHolderToRoot

public static void addUniqueHolderToRoot(org.onosproject.yang.compiler.datamodel.YangUniqueHolder holder)

Adds the unique holder to the module or sub-module node.

Parameters:

holder - unique holder

validateUniqueInList

public static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> validateUniqueInList(org.onosproject.yang.compiler.datamodel.YangUniqueHolder holder,
                                                                                                String val,
                                                                                                org.antlr.v4.runtime.ParserRuleContext ctx)

Validates unique from the list.

Parameters:

holder - unique holder

val - path of unique

ctx - yang construct's context

Returns:

list of yang atomic path

getValidAbsoluteSchemaNodeId

public static List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> getValidAbsoluteSchemaNodeId(String argumentString,
                                                                                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType,
                                                                                                        org.antlr.v4.runtime.ParserRuleContext ctx)

Checks and return valid absolute schema node id.

Parameters:

argumentString - string from yang file

yangConstructType - yang construct for creating error message

ctx - yang construct's context to get the line number and character position

Returns:

target nodes list of absolute schema node id

handleUnsupportedYangConstruct

public static void handleUnsupportedYangConstruct(org.onosproject.yang.compiler.datamodel.utils.YangConstructType type,
                                                  org.antlr.v4.runtime.ParserRuleContext ctx,
                                                  String errorInfo,
                                                  String fileName,
                                                  String identifier)

Throws parser exception for unsupported YANG constructs.

Parameters:

type - construct type

ctx - construct context

errorInfo - error msg

fileName - YANG file name

identifier - identifier of the node

getValidDateFromString

public static Date getValidDateFromString(String dateInString,
                                          org.antlr.v4.runtime.ParserRuleContext ctx)

Returns date and makes it in usable format for revision.

Parameters:

dateInString - date argument string from yang file

ctx - yang construct's context to get the line number and character position

Returns:

date format for revision

getValidPrefix

public static String getValidPrefix(String inputString,
                                    org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstruct,
                                    org.antlr.v4.runtime.ParserRuleContext ctx)

Checks and return valid prefix.

Parameters:

inputString - string from yang file

yangConstruct - yang construct for creating error message

ctx - yang construct's context to get the line number and character position

Returns:

valid prefix

validatePath

public static void validatePath(String path,
                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType type,
                                GeneratedYangParser.PathStatementContext ctx,
                                org.onosproject.yang.compiler.datamodel.YangLeafRef leafRef)

Validates path under leaf-ref and parses the path and stores in the leaf-ref.

Parameters:

path - path of leaf-ref

type - construct type

ctx - construct details

leafRef - YANG leaf-ref having path

getParsedPath

public static String getParsedPath(String nodeId,
                                   String path,
                                   List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomics,
                                   GeneratedYangParser.PathStatementContext pathCtx,
                                   org.onosproject.yang.compiler.datamodel.YangLeafRef yangLeafRef,
                                   org.onosproject.yang.compiler.datamodel.utils.YangConstructType pathType)

Returns the path after taking all the path predicates of an atomic content.

Parameters:

nodeId - atomic content nodeId

path - leaf-ref path

atomics - atomic content list

pathCtx - yang construct's context to get the line number and character position

yangLeafRef - YANG leaf-ref data model information

pathType - yang construct for creating error message

Returns:

parsed path after removing one atomic content.

getPath

public static String getPath(String path,
                             List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomicList,
                             org.onosproject.yang.compiler.datamodel.utils.YangConstructType pathType,
                             GeneratedYangParser.PathStatementContext pathCtx)

Returns the remaining path after parsing and processing an atomic content which doesn't have path-predicate.

Parameters:

path - leaf-ref path

atomicList - atomic content list

pathType - yang construct for creating error message

pathCtx - yang construct's context to get the line number and character position

Returns:

remaining path after parsing one atomic content

getPrefixRemovedName

public static String getPrefixRemovedName(List<org.onosproject.yang.compiler.datamodel.YangAtomicPath> atomics,
                                          org.onosproject.yang.compiler.datamodel.YangNode root)

Returns the augment name, after removing the prefix, in each atomic content, which is equal to the root prefix.

Parameters:

atomics - atomic content list

root - root node

Returns:

prefix removed augment name

isDuplicateNode

public static boolean isDuplicateNode(org.onosproject.yang.compiler.datamodel.YangAugment augment)

Checks if the augment node is a duplicate node. If the augment is duplicate, then it adds all its children to the logical node.

Parameters:

augment - YANG augment

Returns:

true if it is a duplicate node; false otherwise

checkAugNameCollision

public static void checkAugNameCollision(org.onosproject.yang.compiler.datamodel.YangNode root,
                                         org.onosproject.yang.compiler.datamodel.YangAugment aug)

Checks for the augment name name collision. If there are augments with the same name present, then the new augment will be set with a logical node.

Parameters:

root - augment parent node

aug - YANG augment node

removeAugment

public static void removeAugment(org.onosproject.yang.compiler.datamodel.YangAugment augment)

Removes the duplicate YANG augment from the data tree by detaching it from its parent and from its sibling.

Parameters:

augment - duplicate YANG augment