refactor messages name with _TAG suffix

jantje · jantje · commit 5a2f2c7579c3 · 2021-06-18T03:27:41.000+02:00
diff --git a/io.sloeber.core/src/cc/arduino/packages/ssh/SSHPwdSetup.java b/io.sloeber.core/src/cc/arduino/packages/ssh/SSHPwdSetup.java
@@ -59,7 +59,7 @@ public Session setup(BoardPort port, JSch jSch) throws JSchException {
 			// The user should set the password in the project
 			// properties->arduino
 			Common.log(
-					new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, Messages.Upload_login_credentials_missing.replace(Messages.HOST,  host)));
+					new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, Messages.Upload_login_credentials_missing.replace(Messages.HOST_TAG,  host)));
 
 			return null;
 		}
diff --git a/io.sloeber.core/src/io/sloeber/core/Messages.java b/io.sloeber.core/src/io/sloeber/core/Messages.java
@@ -4,26 +4,26 @@
 
 public class Messages extends NLS {
 	private static final String BUNDLE_NAME = "io.sloeber.core.messages"; //$NON-NLS-1$
-	public static final String PORT = "{PORT}"; //$NON-NLS-1$
-	public static final String MENUITEMID = "{MENUITEMID}"; //$NON-NLS-1$
-	public static final String MENUID = "{MENUID}"; //$NON-NLS-1$
-	public static final String BOARDID = "{BOARDID}"; //$NON-NLS-1$
-	public static final String MENUITEMNAME = "{MENUITEMNAME}"; //$NON-NLS-1$
-	public static final String LIB = "{LIB}"; //$NON-NLS-1$
-	public static final String PROJECT = "{PROJECT}"; //$NON-NLS-1$
-	public static final String UPLOADER = "{UPLOADER}"; //$NON-NLS-1$
-	public static final String MS = "{MS}"; //$NON-NLS-1$
-	public static final String NAMEFIELD = "{NAME}"; //$NON-NLS-1$
-	public static final String ID = "{ID}"; //$NON-NLS-1$
-	public static final String COMMAND = "{COMMAND}"; //$NON-NLS-1$
-	public static final String TOOL = "{TOOL}"; //$NON-NLS-1$
-	public static final String FILE = "{FILE}"; //$NON-NLS-1$
-	public static final String BOARD = "{BOARD}"; //$NON-NLS-1$
-	public static final String CONFIG = "{CONFIG}"; //$NON-NLS-1$
-	public static final String KEY = "{KEY}"; //$NON-NLS-1$
-	public static final String FOLDER =  "{FOLDER}"; //$NON-NLS-1$
-	public static final String VERSION =  "{VERSION}"; //$NON-NLS-1$
-	public static final String HOST =  "{HOST}"; //$NON-NLS-1$
+    public static final String PORT_TAG = "{PORT}"; //$NON-NLS-1$
+    public static final String MENUITEMID_TAG = "{MENUITEMID}"; //$NON-NLS-1$
+    public static final String MENUID_TAG = "{MENUID}"; //$NON-NLS-1$
+	public static final String BOARDID_TAG = "{BOARDID}"; //$NON-NLS-1$
+	public static final String MENUITEMNAME_TAG = "{MENUITEMNAME}"; //$NON-NLS-1$
+	public static final String LIB_TAG = "{LIB}"; //$NON-NLS-1$
+	public static final String PROJECT_TAG = "{PROJECT}"; //$NON-NLS-1$
+	public static final String UPLOADER_TAG = "{UPLOADER}"; //$NON-NLS-1$
+	public static final String MS_TAG = "{MS}"; //$NON-NLS-1$
+    public static final String NAME_TAG = "{NAME}"; //$NON-NLS-1$
+    public static final String ID_TAG = "{ID}"; //$NON-NLS-1$
+    public static final String COMMAND_TAG = "{COMMAND}"; //$NON-NLS-1$
+	public static final String TOOL_TAG = "{TOOL}"; //$NON-NLS-1$
+    public static final String FILE_TAG = "{FILE}"; //$NON-NLS-1$
+    public static final String BOARD_TAG = "{BOARD}"; //$NON-NLS-1$
+    public static final String CONFIG_TAG = "{CONFIG}"; //$NON-NLS-1$
+    public static final String KEY_TAG = "{KEY}"; //$NON-NLS-1$
+    public static final String FOLDER_TAG = "{FOLDER}"; //$NON-NLS-1$
+    public static final String VERSION_TAG = "{VERSION}"; //$NON-NLS-1$
+    public static final String HOST_TAG = "{HOST}"; //$NON-NLS-1$
 	
 	
 	public static String ArduinoSerial_Comport_Appeared_and_disappeared;
diff --git a/io.sloeber.core/src/io/sloeber/core/api/LibraryManager.java b/io.sloeber.core/src/io/sloeber/core/api/LibraryManager.java
@@ -295,7 +295,7 @@ static public void loadJson(File jsonFile) {
 			libraryIndices.add(index);
 		} catch (Exception e) {
 			Common.log(new Status(IStatus.ERROR, Activator.getId(),
-                    Manager_Failed_to_parse.replace(FILE, jsonFile.getAbsolutePath()), e));
+                    Manager_Failed_to_parse.replace(FILE_TAG, jsonFile.getAbsolutePath()), e));
 			jsonFile.delete();// Delete the file so it stops damaging
 		}
 	}
diff --git a/io.sloeber.core/src/io/sloeber/core/api/PackageManager.java b/io.sloeber.core/src/io/sloeber/core/api/PackageManager.java
@@ -243,7 +243,7 @@ public static File[] getAllBoardsFiles() {
         }
         if (boardFiles.size() == 0) {
             Common.log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID,
-                    Helpers_No_boards_txt_found.replace(FILE, String.join("\n", hardwareFolders)), null)); //$NON-NLS-1$
+                    Helpers_No_boards_txt_found.replace(FILE_TAG, String.join("\n", hardwareFolders)), null)); //$NON-NLS-1$
             return null;
         }
         return boardFiles.toArray(new File[boardFiles.size()]);
@@ -255,7 +255,7 @@ private static void searchFiles(File folder, TreeSet<File> Hardwarelists, String
             if (a == null) {
                 if (!myHasbeenLogged) {
                     Common.log(new Status(IStatus.INFO, Const.CORE_PLUGIN_ID,
-                            Helpers_Error_The_folder_is_empty.replace(FOLDER, folder.toString()), null));
+                            Helpers_Error_The_folder_is_empty.replace(FOLDER_TAG, folder.toString()), null));
                     myHasbeenLogged = true;
                 }
                 return;
@@ -691,7 +691,7 @@ static private void loadPackage(File jsonFile) {
             packageIndices.add(index);
         } catch (Exception e) {
             Common.log(new Status(IStatus.ERROR, Activator.getId(),
-                    Manager_Failed_to_parse.replace(FILE, jsonFile.getAbsolutePath()), e));
+                    Manager_Failed_to_parse.replace(FILE_TAG, jsonFile.getAbsolutePath()), e));
             jsonFile.delete();// Delete the file so it stops damaging
         }
     }
diff --git a/io.sloeber.core/src/io/sloeber/core/managers/InternalPackageManager.java b/io.sloeber.core/src/io/sloeber/core/managers/InternalPackageManager.java
@@ -54,8 +54,8 @@
 
 public class InternalPackageManager extends PackageManager {
 
-	private static final String FILE = Messages.FILE;
-	private static final String FOLDER = Messages.FOLDER;
+	private static final String FILE = Messages.FILE_TAG;
+	private static final String FOLDER = Messages.FOLDER_TAG;
 	private static boolean myIsReady = false;
 
 	public static boolean isReady() {
diff --git a/io.sloeber.core/src/io/sloeber/core/managers/Tool.java b/io.sloeber.core/src/io/sloeber/core/managers/Tool.java
@@ -21,7 +21,7 @@
 public class Tool {
 
 	private static final String TOOLS = "tools"; //$NON-NLS-1$
-	private static final String KEY = Messages.KEY;
+	private static final String KEY = Messages.KEY_TAG;
 	private String name;
 	private String version;
 	private List<ToolSystem> systems;
diff --git a/io.sloeber.core/src/io/sloeber/core/managers/ToolDependency.java b/io.sloeber.core/src/io/sloeber/core/managers/ToolDependency.java
@@ -54,7 +54,7 @@ public IStatus install(IProgressMonitor monitor) {
 		Tool tool = getTool();
 		if (tool == null) {
 			return new Status(IStatus.ERROR, Activator.getId(),
-                    ToolDependency_Tool_not_found.replace(NAMEFIELD, this.name).replace(VERSION, this.version));
+                    ToolDependency_Tool_not_found.replace(NAME_TAG, this.name).replace(VERSION_TAG, this.version));
 		}
 		return tool.install(monitor);
 	}
diff --git a/io.sloeber.core/src/io/sloeber/core/tools/ExternalCommandLauncher.java b/io.sloeber.core/src/io/sloeber/core/tools/ExternalCommandLauncher.java
@@ -57,7 +57,7 @@
  */
 @SuppressWarnings("unused")
 public class ExternalCommandLauncher {
-    private static final String COMMAND = Messages.COMMAND;
+    private static final String COMMAND = Messages.COMMAND_TAG;
 
     /** Lock for internal synchronization */
     protected final Object myRunLock;
diff --git a/io.sloeber.core/src/io/sloeber/core/tools/Helpers.java b/io.sloeber.core/src/io/sloeber/core/tools/Helpers.java
@@ -53,8 +53,8 @@
  */
 public class Helpers {
 
-    private static final String FILE = Messages.FILE;
-    private static final String FOLDER = Messages.FOLDER;
+    private static final String FILE = Messages.FILE_TAG;
+    private static final String FOLDER = Messages.FOLDER_TAG;
 
     private static boolean myHasBeenLogged = false;
 
diff --git a/io.sloeber.core/src/io/sloeber/core/tools/Libraries.java b/io.sloeber.core/src/io/sloeber/core/tools/Libraries.java
@@ -157,7 +157,7 @@ public static Map<String, IPath> findAllArduinoManagerLibraries() {
                         switch (versions.length) {
                         case 0:// A empty lib folder is hanging around
                             Common.log(
-                                    new Status(IStatus.WARNING, CORE_PLUGIN_ID, EmptyLibFolder.replace(LIB, curLib)));
+                                    new Status(IStatus.WARNING, CORE_PLUGIN_ID, EmptyLibFolder.replace(LIB_TAG, curLib)));
                             Lib_root.toFile().delete();
                             break;
                         case 1:// There should only be 1
@@ -170,7 +170,7 @@ public static Map<String, IPath> findAllArduinoManagerLibraries() {
                             int highestVersion = Version.getHighestVersion(versions);
                             ret.put(curLib, Lib_root.append(versions[highestVersion]));
                             Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID,
-                                    MultipleVersionsOfLib.replace(LIB, curLib)));
+                                    MultipleVersionsOfLib.replace(LIB_TAG, curLib)));
 
                         }
                     }
@@ -198,7 +198,7 @@ public static boolean removeLibrariesFromProject(IProject project, ICConfigurati
                 final IFolder folderHandle = project.getFolder(WORKSPACE_LIB_FOLDER + CurItem);
                 folderHandle.delete(true, null);
             } catch (CoreException e) {
-                Common.log(new Status(IStatus.ERROR, CORE_PLUGIN_ID, failed_to_remove_lib.replace(LIB, CurItem), e));
+                Common.log(new Status(IStatus.ERROR, CORE_PLUGIN_ID, failed_to_remove_lib.replace(LIB_TAG, CurItem), e));
             }
         }
         return Helpers.removeInvalidIncludeFolders(confdesc);
diff --git a/io.sloeber.core/src/io/sloeber/core/tools/uploaders/UploadSketchWrapper.java b/io.sloeber.core/src/io/sloeber/core/tools/uploaders/UploadSketchWrapper.java
@@ -133,9 +133,9 @@ protected IStatus run(IProgressMonitor monitor) {
 	 *
 	 */
 	private class UploadJobWrapper extends Job {
-		private static final String PROJECT = Messages.PROJECT;
-		private static final String UPLOADER = Messages.UPLOADER;
-		private static final String FILE = Messages.FILE;
+		private static final String PROJECT = Messages.PROJECT_TAG;
+		private static final String UPLOADER = Messages.UPLOADER_TAG;
+		private static final String FILE = Messages.FILE_TAG;
 		IProject myProject;
 		ICConfigurationDescription myConfDes;
 		String myNAmeTag;
diff --git a/io.sloeber.core/src/io/sloeber/core/txt/BoardTxtFile.java b/io.sloeber.core/src/io/sloeber/core/txt/BoardTxtFile.java
@@ -38,8 +38,8 @@ public String getMenuItemIDFromMenuItemName(String boardID, String menuID, Strin
                 return curOption.getKey();
             }
         }
-        return Boards_Get_menu_item_id_from_name_failed.replace(MENUITEMNAME, menuItemName)
-                .replace(MENUID, menuID).replace(BOARDID, boardID);
+        return Boards_Get_menu_item_id_from_name_failed.replace(MENUITEMNAME_TAG, menuItemName)
+                .replace(MENUID_TAG, menuID).replace(BOARDID_TAG, boardID);
     }
 
     /**
@@ -107,8 +107,8 @@ public String getMenuItemNameFromMenuItemID(String boardID, String menuID, Strin
         // if (curOption.getKey().equalsIgnoreCase(lookupValue))
         // return curOption.getValue();
         // }
-        return Boards_Get_menu_item_name_from_id_did_not_find.replace(MENUITEMID, menuItemID)
-                .replace(MENUID, menuID).replace(BOARDID, boardID);
+        return Boards_Get_menu_item_name_from_id_did_not_find.replace(MENUITEMID_TAG, menuItemID)
+                .replace(MENUID_TAG, menuID).replace(BOARDID_TAG, boardID);
     }
 
     public String getMenuNameFromID(String menuID) {
@@ -120,7 +120,7 @@ public String getMenuNameFromID(String menuID) {
                 }
             }
         }
-        return Boards_menu_ID_not_found.replace(ID, menuID);
+        return Boards_menu_ID_not_found.replace(ID_TAG, menuID);
     }
 
     /**
diff --git a/io.sloeber.core/src/io/sloeber/core/txt/TxtFile.java b/io.sloeber.core/src/io/sloeber/core/txt/TxtFile.java
@@ -72,7 +72,7 @@ public void mergeFile(File boardsFileName) {
             }
         } catch (Exception e) {
             Common.log(new Status(IStatus.WARNING, Const.CORE_PLUGIN_ID,
-                    Boards_Failed_to_read_boards.replace(FILE, boardsFileName.getName()), e));
+                    Boards_Failed_to_read_boards.replace(FILE_TAG, boardsFileName.getName()), e));
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public Session setup(BoardPort port, JSch jSch) throws JSchException {`
`59`	`59`	`// The user should set the password in the project`
`60`	`60`	`// properties->arduino`
`61`	`61`	`Common.log(`
`62`		`- new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, Messages.Upload_login_credentials_missing.replace(Messages.HOST, host)));`
	`62`	`+ new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, Messages.Upload_login_credentials_missing.replace(Messages.HOST_TAG, host)));`
`63`	`63`
`64`	`64`	`return null;`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ static public void loadJson(File jsonFile) {`
`295`	`295`	`libraryIndices.add(index);`
`296`	`296`	`} catch (Exception e) {`
`297`	`297`	`Common.log(new Status(IStatus.ERROR, Activator.getId(),`
`298`		`- Manager_Failed_to_parse.replace(FILE, jsonFile.getAbsolutePath()), e));`
	`298`	`+ Manager_Failed_to_parse.replace(FILE_TAG, jsonFile.getAbsolutePath()), e));`
`299`	`299`	`jsonFile.delete();// Delete the file so it stops damaging`
`300`	`300`	`}`
`301`	`301`	`}`
Original file line number	Diff line number	Diff line change
`@@ -243,7 +243,7 @@ public static File[] getAllBoardsFiles() {`
`243`	`243`	`}`
`244`	`244`	`if (boardFiles.size() == 0) {`
`245`	`245`	`Common.log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID,`
`246`		`- Helpers_No_boards_txt_found.replace(FILE, String.join("\n", hardwareFolders)), null)); //$NON-NLS-1$`
	`246`	`+ Helpers_No_boards_txt_found.replace(FILE_TAG, String.join("\n", hardwareFolders)), null)); //$NON-NLS-1$`
`247`	`247`	`return null;`
`248`	`248`	`}`
`249`	`249`	`return boardFiles.toArray(new File[boardFiles.size()]);`
`@@ -255,7 +255,7 @@ private static void searchFiles(File folder, TreeSet<File> Hardwarelists, String`
`255`	`255`	`if (a == null) {`
`256`	`256`	`if (!myHasbeenLogged) {`
`257`	`257`	`Common.log(new Status(IStatus.INFO, Const.CORE_PLUGIN_ID,`
`258`		`- Helpers_Error_The_folder_is_empty.replace(FOLDER, folder.toString()), null));`
	`258`	`+ Helpers_Error_The_folder_is_empty.replace(FOLDER_TAG, folder.toString()), null));`
`259`	`259`	`myHasbeenLogged = true;`
`260`	`260`	`}`
`261`	`261`	`return;`
`@@ -691,7 +691,7 @@ static private void loadPackage(File jsonFile) {`
`691`	`691`	`packageIndices.add(index);`
`692`	`692`	`} catch (Exception e) {`
`693`	`693`	`Common.log(new Status(IStatus.ERROR, Activator.getId(),`
`694`		`- Manager_Failed_to_parse.replace(FILE, jsonFile.getAbsolutePath()), e));`
	`694`	`+ Manager_Failed_to_parse.replace(FILE_TAG, jsonFile.getAbsolutePath()), e));`
`695`	`695`	`jsonFile.delete();// Delete the file so it stops damaging`
`696`	`696`	`}`
`697`	`697`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public IStatus install(IProgressMonitor monitor) {`
`54`	`54`	`Tool tool = getTool();`
`55`	`55`	`if (tool == null) {`
`56`	`56`	`return new Status(IStatus.ERROR, Activator.getId(),`
`57`		`- ToolDependency_Tool_not_found.replace(NAMEFIELD, this.name).replace(VERSION, this.version));`
	`57`	`+ ToolDependency_Tool_not_found.replace(NAME_TAG, this.name).replace(VERSION_TAG, this.version));`
`58`	`58`	`}`
`59`	`59`	`return tool.install(monitor);`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ public static Map<String, IPath> findAllArduinoManagerLibraries() {`
`157`	`157`	`switch (versions.length) {`
`158`	`158`	`case 0:// A empty lib folder is hanging around`
`159`	`159`	`Common.log(`
`160`		`- new Status(IStatus.WARNING, CORE_PLUGIN_ID, EmptyLibFolder.replace(LIB, curLib)));`
	`160`	`+ new Status(IStatus.WARNING, CORE_PLUGIN_ID, EmptyLibFolder.replace(LIB_TAG, curLib)));`
`161`	`161`	`Lib_root.toFile().delete();`
`162`	`162`	`break;`
`163`	`163`	`case 1:// There should only be 1`
`@@ -170,7 +170,7 @@ public static Map<String, IPath> findAllArduinoManagerLibraries() {`
`170`	`170`	`int highestVersion = Version.getHighestVersion(versions);`
`171`	`171`	`ret.put(curLib, Lib_root.append(versions[highestVersion]));`
`172`	`172`	`Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID,`
`173`		`- MultipleVersionsOfLib.replace(LIB, curLib)));`
	`173`	`+ MultipleVersionsOfLib.replace(LIB_TAG, curLib)));`
`174`	`174`
`175`	`175`	`}`
`176`	`176`	`}`
`@@ -198,7 +198,7 @@ public static boolean removeLibrariesFromProject(IProject project, ICConfigurati`
`198`	`198`	`final IFolder folderHandle = project.getFolder(WORKSPACE_LIB_FOLDER + CurItem);`
`199`	`199`	`folderHandle.delete(true, null);`
`200`	`200`	`} catch (CoreException e) {`
`201`		`- Common.log(new Status(IStatus.ERROR, CORE_PLUGIN_ID, failed_to_remove_lib.replace(LIB, CurItem), e));`
	`201`	`+ Common.log(new Status(IStatus.ERROR, CORE_PLUGIN_ID, failed_to_remove_lib.replace(LIB_TAG, CurItem), e));`
`202`	`202`	`}`
`203`	`203`	`}`
`204`	`204`	`return Helpers.removeInvalidIncludeFolders(confdesc);`