Change log file format, categorize same caller, add line spacing

Change log file format, categorize same caller, add line spacing

Author: rondlh

src/main/java/com/neuronrobotics/sdk/common/Log.java

@@ -36,11 +36,9 @@
  *
  */
 public class Log {
-	
-	
-	
+
 	/** The Constant LOG. */
-	public static final int LOG =-1;
+	public static final int LOG = -1;
 
 	/** The Constant INFO. */
 	public static final int INFO = 0;
@@ -63,7 +61,7 @@ public class Log {
 
 	/** The date format. */
 	private DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss:SS");
-	
+
 	/** The minprintlevel. */
 	private int minprintlevel = WARNING;
 
@@ -80,15 +78,16 @@ public class Log {
 	/** The out stream. */
 	private static PrintStream mirrorStream = System.out;		
 	/** The use colored prints. */
-	private boolean useColoredPrints=false;
+	private boolean useColoredPrints = false;
 
 	private Thread logFileThread = null;
 
-	private File log=null;
+	private File log = null;
 
 	private ByteList incomingErr;
 	private ByteList incomingOut;
 
+	private String lastCallingClass = "";
 	/**
 	 * Instantiates a new log.
 	 */
@@ -159,23 +158,20 @@ public static void add(String message) {
 	 */
 	private void add(String message, int importance) {
 
-		if( importance < minprintlevel) {
+		if (importance < minprintlevel) {
 			return;
 		}
-		if(m==null)
+		if (m == null)
 			m = new Message(message, importance);
 		else{
 			m.init(message, importance);
 		}
 		//messages.add(m);
 
 
-		if( systemprint) {
+		if (systemprint) {
 			outStream.println(m.toString());
 		}
-		
-		
-		
 	}
 
 	/**
@@ -263,7 +259,7 @@ public static int getMinimumPrintLevel() {
 	 * @return The log instance.
 	 */
 	public static Log instance() {
-		if(instance == null) {
+		if (instance == null) {
 			instance = new Log();
 		}
 		return instance;
@@ -297,7 +293,7 @@ public String getImportance(int importance) {
 	 * @return the importance
 	 */
 	public String getImportanceColor(int importance) {
-		if(isUseColoredPrints()){
+		if (isUseColoredPrints()) {
 			switch(importance) {
 			case INFO:
 				return "\033[92m";// green
@@ -370,26 +366,40 @@ public Message(String message, int importance) {
 		 * @param message the message
 		 * @param importance the importance
 		 */
-		public void init(String message, int importance){
+		public void init(String message, int importance) {
 			this.message = message;
 			this.importance = importance;
 			datetime = new Date();
-		      try
-		      {
-		         throw new Exception("Who called me?");
-		      }
-		      catch( Exception e )
-		      {
-		    	 callingClass= e.getStackTrace()[3].getClassName()+":"+e.getStackTrace()[3].getMethodName();
-		      }
+
+			try
+			{
+				throw new Exception("Who called me?");
+			}
+			catch( Exception e )
+			{
+				callingClass = e.getStackTrace()[3].getClassName() + ":" + e.getStackTrace()[3].getMethodName();
+			}
 		}
 
 		/* (non-Javadoc)
 		 * @see java.lang.Object#toString()
 		 */
 		public String toString() {
-			//return "\t\t\t\t[" + dateFormat.format(datetime) + "] " + " " + getImportance(importance) +" "+callingClass+ " :\n"+ message;
-			return getImportanceColor(importance)+"[" + dateFormat.format(datetime) + "] " + " " + getImportance(importance) +" "+callingClass+ " :\n\t"+ message+getColorNormalizationCode();
+
+            // First logfile line
+            if (lastCallingClass.isEmpty()) {
+				lastCallingClass = "\n[" + dateFormat.format(datetime) + "] ======== Log file opened ========";
+				dateFormat = new SimpleDateFormat("HH:mm:ss.SS");
+
+                return lastCallingClass.toString();
+            }
+
+            if (lastCallingClass.equals(getImportance(importance) + " " + callingClass))
+				return getImportanceColor(importance) + "  [" + dateFormat.format(datetime) + "] " + message + getColorNormalizationCode();
+
+			lastCallingClass = getImportance(importance) + " " + callingClass;
+
+			return "\n" + getImportanceColor(importance) + lastCallingClass + ":\n  [" + dateFormat.format(datetime) + "] " + message + getColorNormalizationCode();
 		}
 	}
 
@@ -398,18 +408,16 @@ public String toString() {
 	 *
 	 * @return the color normalization code
 	 */
-	private String getColorNormalizationCode(){
-		if(isUseColoredPrints())
-			return "\033[39m";
-		return "";
+	private String getColorNormalizationCode() {
+		return isUseColoredPrints() ? "\033[39m" : "";
 	}
 
 	/**
 	 * Checks if is use colored prints.
 	 *
 	 * @return true, if is use colored prints
 	 */
-	public static  boolean isUseColoredPrints() {
+	public static boolean isUseColoredPrints() {
 		return instance().useColoredPrints;
 	}
 
@@ -441,9 +449,9 @@ public static void error(Throwable ex) {
 	}
 
 	public static void setFile(File logfile) {
-		instance().systemprint=true;
-		instance.log=null;
-		if(instance.logFileThread!=null) {
+		instance().systemprint = true;
+		instance.log = null;
+		if (instance.logFileThread != null) {
 			instance.logFileThread.interrupt();
 			try {
 				instance.logFileThread.join();
@@ -453,19 +461,19 @@ public static void setFile(File logfile) {
 			}
 		}
 
-		instance.log=logfile;
-		instance.logFileThread=new Thread(()->{
+		instance.log = logfile;
+		instance.logFileThread = new Thread(()->{
 			instance.incomingErr = new ByteList();
 
-			OutputStream streamErr =  new OutputStream() {
+			OutputStream streamErr = new OutputStream() {
 				@Override
 				public void write(int b) throws IOException {
 					instance.incomingErr.add(b);
 				}
 			};
 			instance.incomingOut = new ByteList();
 
-			OutputStream streamOut =  new OutputStream() {
+			OutputStream streamOut = new OutputStream() {
 				@Override
 				public void write(int b) throws IOException {
 					instance.incomingOut.add(b);
@@ -474,7 +482,7 @@ public void write(int b) throws IOException {
 			System.setOut(new PrintStream(streamOut));
 			System.setErr(new PrintStream(streamErr));
 			setOutStream(new PrintStream(streamErr));
-			while (instance.log!=null) {
+			while (instance.log != null) {
 				try {
 					Thread.sleep(149);
 				} catch (InterruptedException e) {
@@ -484,7 +492,7 @@ public void write(int b) throws IOException {
 					try {
 						String text = instance.incomingOut.asString();
 						instance.incomingOut.clear();
-						if (text != null && text.length() > 0){
+						if ((text != null) && (text.length() > 0)) {
 							//Files.writeString(logfile.toPath(), text, StandardCharsets.UTF_8, StandardOpenOption.APPEND); // java 11+
 							Files.write(logfile.toPath(), text.getBytes(StandardCharsets.UTF_8), StandardOpenOption.APPEND);
 							mirrorStream.println(text);
@@ -497,7 +505,7 @@ public void write(int b) throws IOException {
 					try {
 						String text = instance.incomingErr.asString();
 						instance.incomingErr.clear();
-						if (text != null && text.length() > 0){
+						if ((text != null) && (text.length() > 0)) {
 							//Files.writeString(logfile.toPath(), text, StandardCharsets.UTF_8, StandardOpenOption.APPEND); // java 11+
 							Files.write(logfile.toPath(), text.getBytes(StandardCharsets.UTF_8), StandardOpenOption.APPEND);
 							errStream.println(text);
@@ -514,8 +522,8 @@ public static void flush() {
 		setOutStream(outStream);
 		System.setOut(outStream);
 		System.setErr(outStream);
-		instance.log=null;
-		while(instance.incomingOut.size() > 0 ||instance.incomingErr.size() > 0 ) {
+		instance.log = null;
+		while((instance.incomingOut.size() > 0) || (instance.incomingErr.size() > 0 )) {
 			try {
 				Thread.sleep(10);
 			} catch (InterruptedException e) {