Merge remote-tracking branch 'upstream/master'

Author: nafep

it.baeyens.arduino.common/src/it/baeyens/arduino/common/Common.java

@@ -2,7 +2,8 @@
 
 import java.io.File;
 import java.util.HashSet;
-import java.util.Vector;
+import java.util.List;
+import java.util.Set;
 
 import org.eclipse.cdt.core.CCorePlugin;
 import org.eclipse.cdt.core.envvar.EnvironmentVariable;
@@ -37,16 +38,18 @@ public class Common extends InstancePreferences {
 					       // request him to disconnect
 					       // when we need the serial port
 
+    static Set<IProject> fProjects = new HashSet<>();
+
     /**
      * This method is used to register a serial user. A serial user is alerted
      * when the serial port will be disconnected (for instance for a upload) The
      * serial user is requested to act appropriately Only 1 serial user can be
      * registered at a given time. No check is done.
      * 
-     * @param SerialUser
+     * @param serialUser
      */
-    public static void registerSerialUser(ISerialUser SerialUser) {
-	OtherSerialUser = SerialUser;
+    public static void registerSerialUser(ISerialUser serialUser) {
+	OtherSerialUser = serialUser;
     }
 
     /**
@@ -85,14 +88,14 @@ public static void UnRegisterSerialUser() {
      * redirect input, allowed in Unix filenames, see Note 1 > greater than used
      * to redirect output, allowed in Unix filenames, see Note 1 . period or dot
      * 
-     * @param Name
+     * @param name
      *            the string that needs to be checked
      * @return a name safe to create files or folders
      */
-    public static String MakeNameCompileSafe(String Name) {
-	char badChars[] = { ' ', '/', '.', '/', ':', ' ', '\\', '(', ')', '*', '?', '%', '|', '<', '>', ',', '-' };
+    public static String MakeNameCompileSafe(String name) {
+	char[] badChars = { ' ', '/', '.', '/', ':', ' ', '\\', '(', ')', '*', '?', '%', '|', '<', '>', ',', '-' };
 
-	String ret = Name.trim();
+	String ret = name.trim();
 	for (char curchar : badChars) {
 	    ret = ret.replace(curchar, '_');
 	}
@@ -105,39 +108,37 @@ public static String MakeNameCompileSafe(String Name) {
      * @param project
      *            The project for which the property is needed
      * 
-     * @param Tag
+     * @param tag
      *            The tag identifying the property to read
      * @return returns the property when found. When not found returns an empty
      *         string
      */
-    public static String getPersistentProperty(IProject project, String Tag) {
+    public static String getPersistentProperty(IProject project, String tag) {
 	try {
-	    String sret = project.getPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, Tag));
+	    String sret = project.getPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, tag));
 	    if (sret == null) {
-		sret = project.getPersistentProperty(new QualifiedName(EMPTY_STRING, Tag)); // for
+		sret = project.getPersistentProperty(new QualifiedName(EMPTY_STRING, tag)); // for
 		// downwards
 		// compatibility
 		if (sret == null)
 		    sret = EMPTY_STRING;
 	    }
 	    return sret;
 	} catch (CoreException e) {
-	    log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, "Failed to read persistent setting " + Tag, e)); //$NON-NLS-1$
-	    // e.printStackTrace();
+	    log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, "Failed to read persistent setting " + tag, e)); //$NON-NLS-1$
 	    return EMPTY_STRING;
 	}
     }
 
-    public static int getPersistentPropertyInt(IProject project, String Tag, int defaultValue) {
+    public static int getPersistentPropertyInt(IProject project, String tag, int defaultValue) {
 	try {
-	    String sret = project.getPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, Tag));
+	    String sret = project.getPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, tag));
 	    if (sret == null) {
 		return defaultValue;
 	    }
 	    return Integer.parseInt(sret);
 	} catch (CoreException e) {
-	    log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, "Failed to read persistent setting " + Tag, e)); //$NON-NLS-1$
-	    // e.printStackTrace();
+	    log(new Status(IStatus.ERROR, Const.CORE_PLUGIN_ID, "Failed to read persistent setting " + tag, e)); //$NON-NLS-1$
 	    return defaultValue;
 	}
     }
@@ -148,15 +149,15 @@ public static int getPersistentPropertyInt(IProject project, String Tag, int def
      * @param project
      *            The project for which the property needs to be set
      * 
-     * @param Tag
+     * @param tag
      *            The tag identifying the property to read
      * @return returns the property when found. When not found returns an empty
      *         string
      */
-    public static void setPersistentProperty(IProject project, String Tag, String Value) {
+    public static void setPersistentProperty(IProject project, String tag, String value) {
 	try {
-	    project.setPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, Tag), Value);
-	    project.setPersistentProperty(new QualifiedName(EMPTY_STRING, Tag), Value); // for
+	    project.setPersistentProperty(new QualifiedName(CORE_PLUGIN_ID, tag), value);
+	    project.setPersistentProperty(new QualifiedName(EMPTY_STRING, tag), value); // for
 	    // downwards
 	    // compatibility
 	} catch (CoreException e) {
@@ -166,8 +167,8 @@ public static void setPersistentProperty(IProject project, String Tag, String Va
 	}
     }
 
-    public static void setPersistentProperty(IProject project, String Tag, int Value) {
-	setPersistentProperty(project, Tag, Integer.toString(Value));
+    public static void setPersistentProperty(IProject project, String tag, int value) {
+	setPersistentProperty(project, tag, Integer.toString(value));
     }
 
     /**
@@ -177,7 +178,7 @@ public static void setPersistentProperty(IProject project, String Tag, int Value
      *            the status information to log
      */
     public static void log(IStatus status) {
-	int style = StatusManager.LOG;
+	int style;
 
 	if (status.getSeverity() == IStatus.ERROR) {
 	    style = StatusManager.LOG | StatusManager.SHOW | StatusManager.BLOCK;
@@ -209,20 +210,20 @@ public static String UploadPortPrefix() {
     /**
      * ToInt converts a string to a integer in a save way
      * 
-     * @param Number
+     * @param number
      *            is a String that will be converted to an integer. Number can
      *            be null or empty and can contain leading and trailing white
      *            space
      * @return The integer value represented in the string based on parseInt
      * @see parseInt. After error checking and modifications parseInt is used
      *      for the conversion
      **/
-    public static int ToInt(String Number) {
-	if (Number == null)
+    public static int ToInt(String number) {
+	if (number == null)
 	    return 0;
-	if (Number.isEmpty())
+	if (number.isEmpty())
 	    return 0;
-	return Integer.parseInt(Number.trim());
+	return Integer.parseInt(number.trim());
     }
 
     public static IWorkbenchWindow getActiveWorkbenchWindow() {
@@ -237,8 +238,6 @@ public static IWorkbenchPage getActivePage() {
 	return null;
     }
 
-    static HashSet<IProject> fProjects = new HashSet<>();
-
     public static boolean StopSerialMonitor(String mComPort) {
 	if (OtherSerialUser != null) {
 	    return OtherSerialUser.PauzePort(mComPort);
@@ -254,9 +253,9 @@ public static void StartSerialMonitor(String mComPort) {
     }
 
     public static String[] listComPorts() {
-	Vector<String> SerialList = Serial.list();
-	String outgoing[] = new String[SerialList.size()];
-	SerialList.copyInto(outgoing);
+	List<String> serialList = Serial.list();
+	String[] outgoing = new String[serialList.size()];
+	serialList.toArray(outgoing);
 	return outgoing;
     }
 
@@ -294,16 +293,16 @@ public static String getLineEnding(int selectionIndex) {
      *            the project that contains the environment variable
      * @param configName
      *            the project configuration to use
-     * @param EnvName
+     * @param envName
      *            the key that describes the variable
      * @param defaultvalue
      *            The return value if the variable is not found.
      * @return The expanded build environment variable
      */
-    static public String getBuildEnvironmentVariable(IProject project, String configName, String EnvName,
+    static public String getBuildEnvironmentVariable(IProject project, String configName, String envName,
 	    String defaultvalue) {
 	ICProjectDescription prjDesc = CoreModel.getDefault().getProjectDescription(project);
-	return getBuildEnvironmentVariable(prjDesc.getConfigurationByName(configName), EnvName, defaultvalue);
+	return getBuildEnvironmentVariable(prjDesc.getConfigurationByName(configName), envName, defaultvalue);
     }
 
     /**
@@ -314,15 +313,15 @@ static public String getBuildEnvironmentVariable(IProject project, String config
      * @param project
      *            the project that contains the environment variable
      * 
-     * @param EnvName
+     * @param envName
      *            the key that describes the variable
      * @param defaultvalue
      *            The return value if the variable is not found.
      * @return The expanded build environment variable
      */
-    static public String getBuildEnvironmentVariable(IProject project, String EnvName, String defaultvalue) {
+    static public String getBuildEnvironmentVariable(IProject project, String envName, String defaultvalue) {
 	ICProjectDescription prjDesc = CoreModel.getDefault().getProjectDescription(project);
-	return getBuildEnvironmentVariable(prjDesc.getDefaultSettingConfiguration(), EnvName, defaultvalue);
+	return getBuildEnvironmentVariable(prjDesc.getDefaultSettingConfiguration(), envName, defaultvalue);
     }
 
     /**
@@ -332,24 +331,24 @@ static public String getBuildEnvironmentVariable(IProject project, String EnvNam
      * 
      * @param project
      *            the project that contains the environment variable
-     * @param EnvName
+     * @param envName
      *            the key that describes the variable
      * @param defaultvalue
      *            The return value if the variable is not found.
      * @return The expanded build environment variable
      */
     static public String getBuildEnvironmentVariable(ICConfigurationDescription configurationDescription,
-	    String EnvName, String defaultvalue) {
+	    String envName, String defaultvalue) {
 
-	return getBuildEnvironmentVariable(configurationDescription, EnvName, defaultvalue, true);
+	return getBuildEnvironmentVariable(configurationDescription, envName, defaultvalue, true);
     }
 
     static public String getBuildEnvironmentVariable(ICConfigurationDescription configurationDescription,
-	    String EnvName, String defaultvalue, boolean expanded) {
+	    String envName, String defaultvalue, boolean expanded) {
 
 	IEnvironmentVariableManager envManager = CCorePlugin.getDefault().getBuildEnvironmentManager();
 	try {
-	    return envManager.getVariable(EnvName, configurationDescription, expanded).getValue();
+	    return envManager.getVariable(envName, configurationDescription, expanded).getValue();
 	} catch (Exception e) {// ignore all errors and return the default value
 	}
 	return defaultvalue;
@@ -374,8 +373,7 @@ public static String getDefaultPrivateHardwarePath() {
 
     public static File getWorkspaceRoot() {
 	IWorkspaceRoot myWorkspaceRoot = ResourcesPlugin.getWorkspace().getRoot();
-	File ret = myWorkspaceRoot.getLocation().toFile();
-	return ret;
+	return myWorkspaceRoot.getLocation().toFile();
     }
 
     public static void setBuildEnvironmentVariable(IContributedEnvironment contribEnv,

it.baeyens.arduino.common/src/it/baeyens/arduino/common/InstancePreferences.java

@@ -17,7 +17,8 @@
 import org.osgi.service.prefs.BackingStoreException;
 
 /**
- * ArduinoPreferences is a class containing only static methods that help managing the preferences.
+ * ArduinoPreferences is a class containing only static methods that help
+ * managing the preferences.
  * 
  * @author jan Baeyens
  * 
@@ -46,10 +47,12 @@ public static void setAutomaticallyIncludeLibraries(boolean value) {
     }
 
     /***
-     * get the stored option whether a build before the upload is wanted or not. If nothing is stored the option is ask and this method will pop up a
+     * get the stored option whether a build before the upload is wanted or not.
+     * If nothing is stored the option is ask and this method will pop up a
      * dialogbox
      * 
-     * @return true if a build is wanted before upload false if no build is wanted before upload
+     * @return true if a build is wanted before upload false if no build is
+     *         wanted before upload
      */
     public static boolean getBuildBeforeUploadOption() {
 
@@ -93,7 +96,8 @@ public void run() {
     }
 
     /**
-     * This method reads the name of the last used arduino board from the instance preferences
+     * This method reads the name of the last used arduino board from the
+     * instance preferences
      * 
      * @return the Arduino Board name
      * @author Jan Baeyens
@@ -164,7 +168,8 @@ public static void setGlobalValue(String key, String Value) {
 	try {
 	    myScope.flush();
 	} catch (BackingStoreException e) {
-	    Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID, "failed to set global variable of type string " + key)); //$NON-NLS-1$
+	    Common.log(
+		    new Status(IStatus.WARNING, CORE_PLUGIN_ID, "failed to set global variable of type string " + key)); //$NON-NLS-1$
 	    e.printStackTrace();
 	}
     }
@@ -186,7 +191,8 @@ protected static void setGlobalValue(String key, boolean Value) {
 	try {
 	    myScope.flush();
 	} catch (BackingStoreException e) {
-	    Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID, "failed to set global variable of type boolean " + key)); //$NON-NLS-1$
+	    Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID,
+		    "failed to set global variable of type boolean " + key)); //$NON-NLS-1$
 	    e.printStackTrace();
 	}
     }
@@ -197,13 +203,15 @@ protected static void setGlobalValue(String key, long Value) {
 	try {
 	    myScope.flush();
 	} catch (BackingStoreException e) {
-	    Common.log(new Status(IStatus.WARNING, CORE_PLUGIN_ID, "failed to set global variable of type long " + key)); //$NON-NLS-1$
+	    Common.log(
+		    new Status(IStatus.WARNING, CORE_PLUGIN_ID, "failed to set global variable of type long " + key)); //$NON-NLS-1$
 	    e.printStackTrace();
 	}
     }
 
     /**
-     * This method returns the index of the last used line ending options are CR LF CR+LF none
+     * This method returns the index of the last used line ending options are CR
+     * LF CR+LF none
      * 
      * @return the index of the last used setting
      */
@@ -212,7 +220,8 @@ public static int GetLastUsedSerialLineEnd() {
     }
 
     /**
-     * This method returns the index of the last used line ending options are CR LF CR+LF none
+     * This method returns the index of the last used line ending options are CR
+     * LF CR+LF none
      * 
      * @return the index of the last used setting
      */
@@ -269,7 +278,8 @@ public static void setConfigured() {
     }
 
     /**
-     * This method returns boolean whether the plugin is properly configured The plugin is configured properly if a board has been installed
+     * This method returns boolean whether the plugin is properly configured The
+     * plugin is configured properly if a board has been installed
      * 
      * @return
      */
@@ -326,15 +336,17 @@ public static void setLastUsedExamples(String[] exampleNames) {
     }
 
     public static String[] getPrivateLibraryPaths() {
-	return getGlobalString(KEY_PRIVATE_LIBRARY_PATHS, Common.getDefaultPrivateLibraryPath()).split(File.pathSeparator);
+	return getGlobalString(KEY_PRIVATE_LIBRARY_PATHS, Common.getDefaultPrivateLibraryPath())
+		.split(File.pathSeparator);
     }
 
     public static void setPrivateLibraryPaths(String[] folderName) {
-	setGlobalValue(KEY_PRIVATE_LIBRARY_PATHS, String.join(File.pathSeparator, folderName)); //$NON-NLS-1$
+	setGlobalValue(KEY_PRIVATE_LIBRARY_PATHS, String.join(File.pathSeparator, folderName));
     }
 
     public static String[] getPrivateHardwarePaths() {
-	return getGlobalString(KEY_PRIVATE_HARDWARE_PATHS, Common.getDefaultPrivateHardwarePath()).split(File.pathSeparator);
+	return getGlobalString(KEY_PRIVATE_HARDWARE_PATHS, Common.getDefaultPrivateHardwarePath())
+		.split(File.pathSeparator);
     }
 
     public static void setPrivateHardwarePaths(String[] folderName) {
@@ -347,8 +359,8 @@ public static void setPrivateHardwarePaths(String[] folderName) {
      * @return a list of all the folder locations that can contain hardware
      */
     public static String[] getHardwarePaths() {
-	return (getGlobalString(KEY_PRIVATE_HARDWARE_PATHS, EMPTY_STRING) + File.pathSeparator + ConfigurationPreferences.getInstallationPath())
-		.split(File.pathSeparator);
+	return (getGlobalString(KEY_PRIVATE_HARDWARE_PATHS, EMPTY_STRING) + File.pathSeparator
+		+ ConfigurationPreferences.getInstallationPath()).split(File.pathSeparator);
     }
 
 }