improve Recorder

Signed-off-by: Stefan Bischof <[email protected]>

Author: stbischof

mondrian/src/main/java/mondrian/recorder/AbstractRecorder.java

@@ -1,13 +1,27 @@
 /*
-// This software is subject to the terms of the Eclipse Public License v1.0
-// Agreement, available at the following URL:
-// http://www.eclipse.org/legal/epl-v10.html.
-// You must accept the terms of that agreement to use this software.
-//
-// Copyright (C) 2005-2005 Julian Hyde
-// Copyright (C) 2005-2017 Hitachi Vantara and others
-// All Rights Reserved.
-*/
+ * This software is subject to the terms of the Eclipse Public License v1.0
+ * Agreement, available at the following URL:
+ * http://www.eclipse.org/legal/epl-v10.html.
+ * You must accept the terms of that agreement to use this software.
+ *
+ * Copyright (C) 2005-2005 Julian Hyde
+ * Copyright (c) 2002-2017 Hitachi Vantara..  All rights reserved.
+ *
+ * ---- All changes after Fork in 2023 ------------------------
+ *
+ * Project: Eclipse daanse
+ *
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors after Fork in 2023:
+ *   SmartCity Jena - initial
+ */
 
 package mondrian.recorder;
 
@@ -23,20 +37,14 @@
  */
 public abstract class AbstractRecorder implements MessageRecorder {
 
-    private final static String tooManyMessageRecorderErrors =
-        "Context ''{0}'': Exceeded number of allowed errors ''{1,number}''";
-    private final static String forceMessageRecorderError =
-        "Context ''{0}'': Client forcing return with errors ''{1,number}''";
+    private final static String tooManyMessageRecorderErrors = "Context ''{0}'': Exceeded number of allowed errors ''{1,number}''";
+    private final static String forceMessageRecorderError = "Context ''{0}'': Client forcing return with errors ''{1,number}''";
 
     /**
      * Helper method to format a message and write to logger.
      */
-    public static void logMessage(
-        final String context,
-        final String msg,
-        final MsgType msgType,
-        final Logger logger)
-    {
+    public static void logMessage(final String context, final String msg, final MessageType msgType,
+            final Logger logger) {
         StringBuilder buf = new StringBuilder(64);
         buf.append(context);
         buf.append(": ");
@@ -53,15 +61,12 @@ public static void logMessage(
             logger.error(logMsg);
             break;
         default:
-            logger.warn(
-                "Unknown message type enum \"{}\" for message: {}", msgType, logMsg);
+            logger.warn("Unknown message type enum \"{}\" for message: {}", msgType, logMsg);
         }
     }
 
-    enum MsgType {
-        INFO,
-        WARN,
-        ERROR
+    enum MessageType {
+        INFO, WARN, ERROR
     }
 
     public static final int DEFAULT_MSG_LIMIT = 10;
@@ -88,7 +93,7 @@ protected AbstractRecorder(final int errorMsgLimit) {
      * Resets this MessageRecorder.
      */
     @Override
-	public void clear() {
+    public void clear() {
         errorMsgCount = 0;
         warningMsgCount = 0;
         infoMsgCount = 0;
@@ -98,27 +103,27 @@ public void clear() {
     }
 
     @Override
-	public long getStartTimeMillis() {
+    public long getStartTimeMillis() {
         return this.startTime;
     }
 
     @Override
-	public long getRunTimeMillis() {
+    public long getRunTimeMillis() {
         return (System.currentTimeMillis() - this.startTime);
     }
 
     @Override
-	public boolean hasInformation() {
+    public boolean hasInformation() {
         return (infoMsgCount > 0);
     }
 
     @Override
-	public boolean hasWarnings() {
+    public boolean hasWarnings() {
         return (warningMsgCount > 0);
     }
 
     @Override
-	public boolean hasErrors() {
+    public boolean hasErrors() {
         return (errorMsgCount > 0);
     }
 
@@ -135,7 +140,7 @@ public int getErrorCount() {
     }
 
     @Override
-	public String getContext() {
+    public String getContext() {
         // heavy weight
         if (contextMsgCache == null) {
             final StringBuilder buf = new StringBuilder();
@@ -152,100 +157,83 @@ public String getContext() {
     }
 
     @Override
-	public void pushContextName(final String name) {
+    public void pushContextName(final String name) {
         // light weight
         contexts.add(name);
         contextMsgCache = null;
     }
 
     @Override
-	public void popContextName() {
+    public void popContextName() {
         // light weight
         contexts.remove(contexts.size() - 1);
         contextMsgCache = null;
     }
 
     @Override
-	public void throwRTException() throws RecorderException {
+    public void throwRTException() throws RecorderException {
         if (hasErrors()) {
-            final String errorMsg =
-                MessageFormat.format(forceMessageRecorderError,
-                    getContext(),
-                    errorMsgCount);
+            final String errorMsg = MessageFormat.format(forceMessageRecorderError, getContext(), errorMsgCount);
             throw new RecorderException(errorMsg);
         }
     }
 
     @Override
-	public void reportError(final Exception ex)
-        throws RecorderException
-    {
+    public void reportError(final Exception ex) throws RecorderException {
         reportError(ex, null);
     }
 
     @Override
-	public void reportError(final Exception ex, final Object info)
-        throws RecorderException
-    {
+    public void reportError(final Exception ex, final Object info) throws RecorderException {
         reportError(ex.toString(), info);
     }
 
     @Override
-	public void reportError(final String msg)
-        throws RecorderException
-    {
+    public void reportError(final String msg) throws RecorderException {
         reportError(msg, null);
     }
 
     @Override
-	public void reportError(final String msg, final Object info)
-        throws RecorderException
-    {
+    public void reportError(final String msg, final Object info) throws RecorderException {
         errorMsgCount++;
-        recordMessage(msg, info, MsgType.ERROR);
+        recordMessage(msg, info, MessageType.ERROR);
 
         if (errorMsgCount >= errorMsgLimit) {
-            final String errorMsg =
-                MessageFormat.format(tooManyMessageRecorderErrors,
-                    getContext(),
+            final String errorMsg = MessageFormat.format(tooManyMessageRecorderErrors, getContext(),
                     String.valueOf(errorMsgCount));
             throw new RecorderException(errorMsg);
         }
     }
 
     @Override
-	public void reportWarning(final String msg) {
+    public void reportWarning(final String msg) {
         reportWarning(msg, null);
     }
 
     @Override
-	public void reportWarning(final String msg, final Object info) {
+    public void reportWarning(final String msg, final Object info) {
         warningMsgCount++;
-        recordMessage(msg, info, MsgType.WARN);
+        recordMessage(msg, info, MessageType.WARN);
     }
 
     @Override
-	public void reportInfo(final String msg) {
+    public void reportInfo(final String msg) {
         reportInfo(msg, null);
     }
 
     @Override
-	public void reportInfo(final String msg, final Object info) {
+    public void reportInfo(final String msg, final Object info) {
         infoMsgCount++;
-        recordMessage(msg, info, MsgType.INFO);
+        recordMessage(msg, info, MessageType.INFO);
     }
 
     /**
-     * Handles a message.
-     * Classes implementing this abstract class must provide an implemention
-     * of this method; it receives all warning/error messages.
+     * Handles a message. Classes implementing this abstract class must provide an
+     * implemention of this method; it receives all warning/error messages.
      *
-     * @param msg the error or warning message.
-     * @param info the information Object which might be null.
+     * @param msg     the error or warning message.
+     * @param info    the information Object which might be null.
      * @param msgType one of the message type enum values
      */
-    protected abstract void recordMessage(
-        String msg,
-        Object info,
-        MsgType msgType);
+    protected abstract void recordMessage(String msg, Object info, MessageType msgType);
 }

mondrian/src/main/java/mondrian/recorder/ListRecorder.java

@@ -1,13 +1,27 @@
 /*
-// This software is subject to the terms of the Eclipse Public License v1.0
-// Agreement, available at the following URL:
-// http://www.eclipse.org/legal/epl-v10.html.
-// You must accept the terms of that agreement to use this software.
-//
-// Copyright (C) 2005-2005 Julian Hyde
-// Copyright (C) 2005-2017 Hitachi Vantara and others
-// All Rights Reserved.
-*/
+ * This software is subject to the terms of the Eclipse Public License v1.0
+ * Agreement, available at the following URL:
+ * http://www.eclipse.org/legal/epl-v10.html.
+ * You must accept the terms of that agreement to use this software.
+ *
+ * Copyright (C) 2005-2005 Julian Hyde
+ * Copyright (c) 2002-2017 Hitachi Vantara..  All rights reserved.
+ *
+ * ---- All changes after Fork in 2023 ------------------------
+ *
+ * Project: Eclipse daanse
+ *
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors after Fork in 2023:
+ *   SmartCity Jena - initial
+ */
 
 package mondrian.recorder;
 
@@ -18,9 +32,9 @@
 import org.slf4j.Logger;
 
 /**
- * Implementation of {@link MessageRecorder} that records each message
- * in a {@link List}. The calling code can then access the list and take
- * actions as needed.
+ * Implementation of {@link MessageRecorder} that records each message in a
+ * {@link List}. The calling code can then access the list and take actions as
+ * needed.
  */
 public class ListRecorder extends AbstractRecorder {
 
@@ -35,7 +49,7 @@ public ListRecorder() {
     }
 
     @Override
-	public void clear() {
+    public void clear() {
         super.clear();
         errorList.clear();
         warnList.clear();
@@ -55,11 +69,7 @@ public Iterator<Entry> getInfoEntries() {
     }
 
     @Override
-	protected void recordMessage(
-        final String msg,
-        final Object info,
-        final MsgType msgType)
-    {
+    protected void recordMessage(final String msg, final Object info, final MessageType msgType) {
         String context = getContext();
 
         Entry e = new Entry(context, msg, msgType, info);
@@ -74,12 +84,8 @@ protected void recordMessage(
             errorList.add(e);
             break;
         default:
-            e = new Entry(
-                context,
-                new StringBuilder("Unknown message type enum \"").append(msgType)
-                .append("\" for message: ").append(msg).toString(),
-                MsgType.WARN,
-                info);
+            e = new Entry(context, new StringBuilder("Unknown message type enum \"").append(msgType)
+                    .append("\" for message: ").append(msg).toString(), MessageType.WARN, info);
             warnList.add(e);
         }
     }
@@ -109,49 +115,15 @@ static void logMessage(Iterator<Entry> it, Logger logger) {
         }
     }
 
-    static void logMessage(
-        final Entry e,
-        final Logger logger)
-    {
-        logMessage(e.getContext(), e.getMessage(), e.getMsgType(), logger);
+    static void logMessage(final Entry e, final Logger logger) {
+        logMessage(e.context(), e.message(), e.msgType(), logger);
     }
 
     /**
-     * Entry is a Info, Warning or Error message. This is the object stored
-     * in the Lists MessageRecorder's info, warning and error message lists.
+     * Entry is a Info, Warning or Error message. This is the object stored in the
+     * Lists MessageRecorder's info, warning and error message lists.
      */
-    public static class Entry {
-        private final String context;
-        private final String msg;
-        private final MsgType msgType;
-        private final Object info;
-
-        private Entry(
-            final String context,
-            final String msg,
-            final MsgType msgType,
-            final Object info)
-        {
-            this.context = context;
-            this.msg = msg;
-            this.msgType = msgType;
-            this.info = info;
-        }
+    public static record Entry(String context, String message, MessageType msgType, Object info) {
 
-        public String getContext() {
-            return context;
-        }
-
-        public String getMessage() {
-            return msg;
-        }
-
-        public MsgType getMsgType() {
-            return msgType;
-        }
-
-        public Object getInfo() {
-            return info;
-        }
     }
 }