[ONOS-3880, 3881] Yang Listener for Module and Sub-Module
Change-Id: Iee75c3e04af9b66ebc38acb3396aa4c54af5a268
diff --git a/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java b/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
new file mode 100644
index 0000000..1de8f44
--- /dev/null
+++ b/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.parserutils;
+
+import org.onosproject.yangutils.parser.ParsableDataType;
+
+/**
+ * It's a utility to help construct detailed error message.
+ */
+public final class ListenerErrorMessageConstruction {
+
+ /**
+ * Private constructor.
+ */
+ private ListenerErrorMessageConstruction() {
+ }
+
+ /**
+ * Constructs message for error with extended information and returns the same.
+ *
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName identifier/string of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
+ * @param extendedErrorInformation extended error information.
+ * @return constructed error message.
+ */
+ public static String constructExtendedListenerErrorMessage(ListenerErrorType errorType,
+ ParsableDataType parsableDataType,
+ String parsableDataTypeName,
+ ListenerErrorLocation errorLocation,
+ String extendedErrorInformation) {
+ String newErrorMessage;
+ newErrorMessage = constructListenerErrorMessage(errorType, parsableDataType, parsableDataTypeName,
+ errorLocation) + "\n" + "Error Information: " + extendedErrorInformation;
+ return newErrorMessage;
+ }
+
+ /**
+ * Constructs message for error during listener based tree walk and returns the same.
+ *
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName identifier/string of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
+ * @return constructed error message.
+ */
+ public static String constructListenerErrorMessage(ListenerErrorType errorType,
+ ParsableDataType parsableDataType,
+ String parsableDataTypeName,
+ ListenerErrorLocation errorLocation) {
+
+ String errorMessage;
+
+ errorMessage = "Internal parser error detected: " + ListenerErrorType.getErrorType(errorType) + " "
+ + ParsableDataType.getParsableDataType(parsableDataType);
+
+
+ if (!parsableDataTypeName.isEmpty()) {
+ errorMessage = errorMessage + " \"" + parsableDataTypeName + "\" ";
+ } else {
+ errorMessage = errorMessage + " ";
+
+ }
+ errorMessage = errorMessage + ListenerErrorLocation.getErrorLocationMessage(errorLocation) + " processing.";
+ return errorMessage;
+ }
+}
\ No newline at end of file