org.onosproject.yangutils.parser.impl.parserutils

Class ListenerUtil

java.lang.Object

org.onosproject.yangutils.parser.impl.parserutils.ListenerUtil

public final class ListenerUtil
extends Object

Represents an utility for listener.

Method Summary

Modifier and Type	Method and Description
static Date	getCurrentDateForRevision() Returns current date and makes it in usable format for revision.
static String	getPrefixInFileOfTheCurrentNode(YangNode node) Returns the prefix of the current file.
static List<YangAtomicPath>	getValidAbsoluteSchemaNodeId(String argumentString, YangConstructType yangConstructType, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid absolute schema node id.
static boolean	getValidBooleanValue(String booleanValue, 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, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates identifier and returns concatenated string if string contains plus symbol.
static String	getValidIdentifierForLeafref(String identifier, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx, YangLeafRef yangLeafRef) Validates identifier and returns concatenated string if string contains plus symbol.
static int	getValidIntegerValue(String integerValue, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates integer value.
static YangNodeIdentifier	getValidNodeIdentifier(String nodeIdentifierString, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid node identifier.
static YangNodeIdentifier	getValidNodeIdentifierForLeafref(String nodeIdentifierString, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx, YangLeafRef yangLeafRef) Checks and return valid node identifier specific to nodes in leafref path.
static int	getValidNonNegativeIntegerValue(String integerValue, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Validates non negative integer value.
static String	getValidPrefix(String inputString, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx) Checks and return valid prefix.
static byte	getValidVersion(GeneratedYangParser.YangVersionStatementContext ctx) Validates YANG version.
static void	handleUnsupportedYangConstruct(YangConstructType yangConstructType, org.antlr.v4.runtime.ParserRuleContext ctx, String errorInfo, String fileName) Throws parser exception for unsupported YANG constructs.
static boolean	isDateValid(String dateToValidate) Validates the revision date.
static String	removeQuotesAndHandleConcat(String yangStringData) Removes doubles quotes and concatenates if string has plus symbol.
static void	validatePathArgument(String pathString, YangConstructType yangConstruct, org.antlr.v4.runtime.ParserRuleContext ctx, YangLeafRef yangLeafRef) Validates the path argument.
static void	validateUniqueInList(YangList yangList, org.antlr.v4.runtime.ParserRuleContext ctx) Validates unique field from the list.

Methods inherited from class java.lang.Object

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

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,
                                        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

getValidIdentifierForLeafref

public static String getValidIdentifierForLeafref(String identifier,
                                                  YangConstructType yangConstruct,
                                                  org.antlr.v4.runtime.ParserRuleContext ctx,
                                                  YangLeafRef yangLeafRef)

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

yangLeafRef - instance of leafref where the path argument has to be set

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 byte 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,
                                                  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,
                                       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,
                                           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 YangNodeIdentifier getValidNodeIdentifier(String nodeIdentifierString,
                                                        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

getValidNodeIdentifierForLeafref

public static YangNodeIdentifier getValidNodeIdentifierForLeafref(String nodeIdentifierString,
                                                                  YangConstructType yangConstruct,
                                                                  org.antlr.v4.runtime.ParserRuleContext ctx,
                                                                  YangLeafRef yangLeafRef)

Checks and return valid node identifier specific to nodes in leafref path.

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

yangLeafRef - instance of leafref where the path argument has to be set

Returns:

valid node identifier

validatePathArgument

public static void validatePathArgument(String pathString,
                                        YangConstructType yangConstruct,
                                        org.antlr.v4.runtime.ParserRuleContext ctx,
                                        YangLeafRef yangLeafRef)

Validates the path argument. It can be either absolute or relative path.

Parameters:

pathString - the path string from the path type

yangConstruct - yang construct for creating error message

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

yangLeafRef - instance of leafref where the path argument has to be set

validateUniqueInList

public static void validateUniqueInList(YangList yangList,
                                        org.antlr.v4.runtime.ParserRuleContext ctx)

Validates unique field from the list.

Parameters:

yangList - instance of YANG list

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

getPrefixInFileOfTheCurrentNode

public static String getPrefixInFileOfTheCurrentNode(YangNode node)

Returns the prefix of the current file.

Parameters:

node - node where it needs to find the root node

Returns:

prefix of root node

getValidAbsoluteSchemaNodeId

public static List<YangAtomicPath> getValidAbsoluteSchemaNodeId(String argumentString,
                                                                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(YangConstructType yangConstructType,
                                                  org.antlr.v4.runtime.ParserRuleContext ctx,
                                                  String errorInfo,
                                                  String fileName)

Throws parser exception for unsupported YANG constructs.

Parameters:

yangConstructType - yang construct for creating error message

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

errorInfo - error information

fileName - YANG file name

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,
                                    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