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

Class ListenerValidation

java.lang.Object

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

public final class ListenerValidation
extends Object

Represents a utility to carry out listener validation.

Method Summary

Modifier and Type	Method and Description
static void	checkStackIsEmpty(TreeWalkListener listener, ListenerErrorType errorType, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType, String parsableDataTypeName, ListenerErrorLocation errorLocation) Checks parsed data stack is empty.
static void	checkStackIsNotEmpty(TreeWalkListener listener, ListenerErrorType errorType, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType, String parsableDataTypeName, ListenerErrorLocation errorLocation) Checks parsed data stack is not empty.
static boolean	getParentNodeConfig(TreeWalkListener listener) Returns parent node config value, if top node does not specify a config statement then default value true is returned.
static void	validateCardinalityEitherOne(List<?> child1Context, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChild1Construct, List<?> child2Context, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChild2Construct, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct, String parentName, org.antlr.v4.runtime.ParserRuleContext parentContext) Checks if a either of one construct occurrence.
static void	validateCardinalityEqualsOne(List<?> childContext, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct, String parentName, org.antlr.v4.runtime.ParserRuleContext parentContext) Checks if a rule occurrences is exactly 1.
static void	validateCardinalityMaxOne(List<?> childContext, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct, String parentName) Checks if a rule occurrences is as per the expected YANG grammar's cardinality.
static void	validateCardinalityMutuallyExclusive(List<?> ctx1, org.onosproject.yang.compiler.datamodel.utils.YangConstructType type1, List<?> ctx2, org.onosproject.yang.compiler.datamodel.utils.YangConstructType type2, org.onosproject.yang.compiler.datamodel.utils.YangConstructType type, String parentName, org.antlr.v4.runtime.ParserRuleContext ctx) Checks if a either of one construct occurrence.
static void	validateCardinalityNonZero(List<?> childContext, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct, org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct, String parentName, org.antlr.v4.runtime.ParserRuleContext parentContext) Checks if a rule occurrences is minimum 1.

Methods inherited from class java.lang.Object

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

Method Detail

checkStackIsNotEmpty

public static void checkStackIsNotEmpty(TreeWalkListener listener,
                                        ListenerErrorType errorType,
                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType,
                                        String parsableDataTypeName,
                                        ListenerErrorLocation errorLocation)

Checks parsed data stack is not empty.

Parameters:

listener - Listener's object

errorType - error type needs to be set in error message

yangConstructType - type of parsable data in which error occurred

parsableDataTypeName - name of parsable data type in which error occurred

errorLocation - location where error occurred

checkStackIsEmpty

public static void checkStackIsEmpty(TreeWalkListener listener,
                                     ListenerErrorType errorType,
                                     org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangConstructType,
                                     String parsableDataTypeName,
                                     ListenerErrorLocation errorLocation)

Checks parsed data stack is empty.

Parameters:

listener - Listener's object

errorType - error type needs to be set in error message

yangConstructType - type of parsable data in which error occurred

parsableDataTypeName - name of parsable data type in which error occurred

errorLocation - location where error occurred

getParentNodeConfig

public static boolean getParentNodeConfig(TreeWalkListener listener)

Returns parent node config value, if top node does not specify a config statement then default value true is returned.

Parameters:

listener - listener's object

Returns:

true/false parent's config value

validateCardinalityMaxOne

public static void validateCardinalityMaxOne(List<?> childContext,
                                             org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct,
                                             org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct,
                                             String parentName)
                                      throws ParserException

Checks if a rule occurrences is as per the expected YANG grammar's cardinality.

Parameters:

childContext - child's context

yangChildConstruct - child construct for whom cardinality is to be validated

yangParentConstruct - parent construct

parentName - parent name

Throws:

ParserException - exception if cardinality check fails

validateCardinalityEqualsOne

public static void validateCardinalityEqualsOne(List<?> childContext,
                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct,
                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct,
                                                String parentName,
                                                org.antlr.v4.runtime.ParserRuleContext parentContext)
                                         throws ParserException

Checks if a rule occurrences is exactly 1.

Parameters:

childContext - child's context

yangChildConstruct - child construct for whom cardinality is to be validated

yangParentConstruct - parent construct

parentName - parent name

parentContext - parents's context

Throws:

ParserException - exception if cardinality check fails

validateCardinalityNonZero

public static void validateCardinalityNonZero(List<?> childContext,
                                              org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChildConstruct,
                                              org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct,
                                              String parentName,
                                              org.antlr.v4.runtime.ParserRuleContext parentContext)
                                       throws ParserException

Checks if a rule occurrences is minimum 1.

Parameters:

childContext - child's context

yangChildConstruct - child construct for whom cardinality is to be validated

yangParentConstruct - parent construct

parentName - parent name

parentContext - parents's context

Throws:

ParserException - exception if cardinality check fails

validateCardinalityEitherOne

public static void validateCardinalityEitherOne(List<?> child1Context,
                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChild1Construct,
                                                List<?> child2Context,
                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangChild2Construct,
                                                org.onosproject.yang.compiler.datamodel.utils.YangConstructType yangParentConstruct,
                                                String parentName,
                                                org.antlr.v4.runtime.ParserRuleContext parentContext)
                                         throws ParserException

Checks if a either of one construct occurrence.

Parameters:

child1Context - first optional child's context

yangChild1Construct - first child construct for whom cardinality is to be validated

child2Context - second optional child's context

yangChild2Construct - second child construct for whom cardinality is to be validated

yangParentConstruct - parent construct

parentName - parent name

parentContext - parents's context

Throws:

ParserException - exception if cardinality check fails

validateCardinalityMutuallyExclusive

public static void validateCardinalityMutuallyExclusive(List<?> ctx1,
                                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType type1,
                                                        List<?> ctx2,
                                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType type2,
                                                        org.onosproject.yang.compiler.datamodel.utils.YangConstructType type,
                                                        String parentName,
                                                        org.antlr.v4.runtime.ParserRuleContext ctx)
                                                 throws ParserException

Checks if a either of one construct occurrence.

Parameters:

ctx1 - first optional child's context

type1 - first child construct for whom cardinality is to be validated

ctx2 - second optional child's context

type2 - second child construct for whom cardinality is to be validated

type - parent construct

parentName - parent name

ctx - parents's context

Throws:

ParserException - exception if cardinality check fails