Coding gudilines for class and methods javadocs fixed.
Change-Id: I0153e6391c9ec9eacaac65c3989834b6bf5c65bf
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerCollisionDetector.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerCollisionDetector.java
index 1e2d225..98b3429 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerCollisionDetector.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerCollisionDetector.java
@@ -20,13 +20,14 @@
import org.onosproject.yangutils.datamodel.exceptions.DataModelException;
import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.utils.YangConstructType;
+
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.EXIT;
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER;
-import org.onosproject.yangutils.utils.YangConstructType;
/**
- * Check the YANG construct collision in a YANG file.
+ * Represents the detector of YANG construct collision in a YANG file.
*/
public final class ListenerCollisionDetector {
@@ -52,7 +53,7 @@
*/
public static void detectCollidingChildUtil(TreeWalkListener listener, int line, int charPosition,
String identifierName, YangConstructType constructType)
- throws ParserException {
+ throws ParserException {
if (listener.getParsedDataStack().peek() instanceof CollisionDetector) {
try {
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java
index 1c29fa6..c1c2888 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java
@@ -17,7 +17,7 @@
package org.onosproject.yangutils.parser.impl.parserutils;
/**
- * Maintains listener error location.
+ * Represents listener error location.
*/
public enum ListenerErrorLocation {
/**
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
index 7064e3b..141e3dc 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
@@ -18,17 +18,17 @@
import org.onosproject.yangutils.utils.YangConstructType;
-import static org.onosproject.yangutils.utils.YangConstructType.getYangConstructType;
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.getErrorLocationMessage;
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.getErrorType;
+import static org.onosproject.yangutils.utils.YangConstructType.getYangConstructType;
/**
- * It's a utility to help construct detailed error message.
+ * Represents a utility to help construct detailed error message.
*/
public final class ListenerErrorMessageConstruction {
/**
- * Private constructor.
+ * Creates a object of listen error message.
*/
private ListenerErrorMessageConstruction() {
}
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java
index 6b520d9..f1cb284 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java
@@ -17,7 +17,7 @@
package org.onosproject.yangutils.parser.impl.parserutils;
/**
- * Maintains listener error type.
+ * Represents listener error type.
*/
public enum ListenerErrorType {
/**
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
index fd81898..ffb50e9 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
@@ -26,13 +26,14 @@
import org.antlr.v4.runtime.ParserRuleContext;
import org.onosproject.yangutils.datamodel.YangNodeIdentifier;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
-import org.onosproject.yangutils.utils.YangConstructType;
import org.onosproject.yangutils.parser.exceptions.ParserException;
+import org.onosproject.yangutils.utils.YangConstructType;
/**
- * It's a utility for listener.
+ * Represents an utility for listener.
*/
public final class ListenerUtil {
+
private static final Pattern IDENTIFIER_PATTERN = Pattern.compile("[a-zA-Z_][a-zA-Z0-9_.-]*");
private static final String NON_NEGATIVE_INTEGER_PATTERN = "[0-9]+";
private static final String PLUS = "+";
@@ -154,7 +155,7 @@
* @return valid non negative integer value
*/
public static int getValidNonNegativeIntegerValue(String integerValue, YangConstructType yangConstruct,
- ParserRuleContext ctx) {
+ ParserRuleContext ctx) {
String value = removeQuotesAndHandleConcat(integerValue);
if (!value.matches(NON_NEGATIVE_INTEGER_PATTERN)) {
@@ -178,7 +179,7 @@
* @return boolean value either true or false
*/
public static boolean getValidBooleanValue(String booleanValue, YangConstructType yangConstruct,
- ParserRuleContext ctx) {
+ ParserRuleContext ctx) {
String value = removeQuotesAndHandleConcat(booleanValue);
if (value.equals(TRUE_KEYWORD)) {
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
index 26d3088..f2c0e7c 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
@@ -16,6 +16,9 @@
package org.onosproject.yangutils.parser.impl.parserutils;
+import java.util.Iterator;
+import java.util.List;
+
import org.antlr.v4.runtime.ParserRuleContext;
import org.onosproject.yangutils.datamodel.YangContainer;
import org.onosproject.yangutils.datamodel.YangList;
@@ -23,15 +26,13 @@
import org.onosproject.yangutils.parser.Parsable;
import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
-import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
import org.onosproject.yangutils.utils.YangConstructType;
+
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
import static org.onosproject.yangutils.utils.YangConstructType.getYangConstructType;
-import java.util.Iterator;
-import java.util.List;
-
/**
- * It's a utility to carry out listener validation.
+ * Represents a utility to carry out listener validation.
*/
public final class ListenerValidation {
@@ -54,6 +55,7 @@
public static void checkStackIsNotEmpty(TreeWalkListener listener, ListenerErrorType errorType,
YangConstructType yangConstructType, String parsableDataTypeName,
ListenerErrorLocation errorLocation) {
+
if (listener.getParsedDataStack().empty()) {
/*
* If stack is empty it indicates error condition, value of
@@ -100,6 +102,7 @@
* @return true/false parent's config value
*/
public static boolean getParentNodeConfig(TreeWalkListener listener) {
+
YangNode parentNode;
Parsable curData = listener.getParsedDataStack().peek();
if (curData instanceof YangNode) {
@@ -125,7 +128,7 @@
* @throws ParserException exception if cardinality check fails
*/
public static void validateCardinalityMaxOne(List<?> childContext, YangConstructType yangChildConstruct,
- YangConstructType yangParentConstruct, String parentName)
+ YangConstructType yangParentConstruct, String parentName)
throws ParserException {
if (!childContext.isEmpty() && childContext.size() != 1) {
@@ -152,8 +155,8 @@
* @throws ParserException exception if cardinality check fails
*/
public static void validateCardinalityEqualsOne(List<?> childContext, YangConstructType yangChildConstruct,
- YangConstructType yangParentConstruct, String parentName,
- ParserRuleContext parentContext)
+ YangConstructType yangParentConstruct, String parentName,
+ ParserRuleContext parentContext)
throws ParserException {
if (childContext.isEmpty()) {
@@ -187,8 +190,8 @@
* @throws ParserException exception if cardinality check fails
*/
public static void validateCardinalityNonZero(List<?> childContext, YangConstructType yangChildConstruct,
- YangConstructType yangParentConstruct, String parentName,
- ParserRuleContext parentContext)
+ YangConstructType yangParentConstruct, String parentName,
+ ParserRuleContext parentContext)
throws ParserException {
if (childContext.isEmpty()) {
@@ -216,8 +219,8 @@
* @throws ParserException exception if cardinality check fails
*/
public static void validateMutuallyExclusiveChilds(List<?> child1Context, YangConstructType yangChild1Construct,
- List<?> child2Context, YangConstructType yangChild2Construct,
- YangConstructType yangParentConstruct, String parentName)
+ List<?> child2Context, YangConstructType yangChild2Construct,
+ YangConstructType yangParentConstruct, String parentName)
throws ParserException {
if (!child1Context.isEmpty() && !child2Context.isEmpty()) {
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
index 89afb78..af81d6f 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
@@ -22,6 +22,7 @@
import org.onosproject.yangutils.parser.exceptions.ParserException;
/**
+ * Represent the parse tree error listener.
* By default, ANTLR sends all errors to standard error, this is changed by
* providing this new implementation of interface ANTLRErrorListener. The
* interface has a syntaxError() method that applies to both lexer and parser.