Merge pull request github#3634 from Marcono1234/MagicConstants-code-style

aschackmull · web-flow · commit e444bcc92301 · 2020-06-08T09:34:48.000+02:00
Fix Java code style of MagicConstants examples
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicConstantsNumbers.java b/java/ql/src/Violations of Best Practice/Magic Constants/MagicConstantsNumbers.java
@@ -1,9 +1,9 @@
 // Problem version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
@@ -20,17 +20,16 @@ public static void main(String[] args) {
 // Fixed version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
-	final static public int TIMEOUT = 60000;  // Magic number is replaced by named constant
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
+	public static final int TIMEOUT = 60000;  // Magic number is replaced by named constant
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-
 		new MagicConstants().serve(IP, PORT, USERNAME, TIMEOUT);  // Use 'TIMEOUT' constant
 	}
 }
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicConstantsString.java b/java/ql/src/Violations of Best Practice/Magic Constants/MagicConstantsString.java
@@ -1,9 +1,9 @@
 // Problem version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
@@ -20,17 +20,16 @@ public static void main(String[] args) {
 // Fixed version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public int USERNAME = "test";  // Magic string is replaced by named constant
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final int USERNAME = "test";  // Magic string is replaced by named constant
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-
 		new MagicConstants().serve(IP, PORT, USERNAME, TIMEOUT);  // Use 'USERNAME' constant
 	}
 }
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicNumbersUseConstant.java b/java/ql/src/Violations of Best Practice/Magic Constants/MagicNumbersUseConstant.java
@@ -1,37 +1,36 @@
 // Problem version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-		int internal_port = 8080;  // AVOID: Magic number
+		int internalPort = 8080;  // AVOID: Magic number
 
-		new MagicConstants().serve(IP, internal_port, USERNAME, TIMEOUT);
+		new MagicConstants().serve(IP, internalPort, USERNAME, TIMEOUT);
 	}
 }
 
 
 // Fixed version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-
 		new MagicConstants().serve(IP, PORT, USERNAME, TIMEOUT);  // Use 'PORT' constant
 	}
 }
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicNumbersUseConstant.qhelp b/java/ql/src/Violations of Best Practice/Magic Constants/MagicNumbersUseConstant.qhelp
@@ -35,7 +35,7 @@ update if the requirements change, because you have to update the number in only
 </recommendation>
 <example>
 
-<p>The following example shows a magic number <code>internal_port</code>. This should be replaced by  
+<p>The following example shows a magic number <code>internalPort</code>. This should be replaced by  
 the existing named constant, as shown in the fixed version.</p>
 
 <sample src="MagicNumbersUseConstant.java" />
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicStringsUseConstant.java b/java/ql/src/Violations of Best Practice/Magic Constants/MagicStringsUseConstant.java
@@ -1,37 +1,36 @@
 // Problem version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-		String internal_ip = "127.0.0.1";  // AVOID: Magic string
+		String internalIp = "127.0.0.1";  // AVOID: Magic string
 
-		new MagicConstants().serve(internal_ip, PORT, USERNAME, TIMEOUT);
+		new MagicConstants().serve(internalIp, PORT, USERNAME, TIMEOUT);
 	}
 }
 
 
 // Fixed version
 public class MagicConstants
 {
-	final static public String IP = "127.0.0.1";
-	final static public int PORT = 8080;
-	final static public String USERNAME = "test";
-	final static public int TIMEOUT = 60000;
+	public static final String IP = "127.0.0.1";
+	public static final int PORT = 8080;
+	public static final String USERNAME = "test";
+	public static final int TIMEOUT = 60000;
 
 	public void serve(String ip, int port, String user, int timeout) {
 		// ...
 	}
 
 	public static void main(String[] args) {
-
 		new MagicConstants().serve(IP, PORT, USERNAME, TIMEOUT);  //Use 'IP' constant
 	}
 }
diff --git a/java/ql/src/Violations of Best Practice/Magic Constants/MagicStringsUseConstant.qhelp b/java/ql/src/Violations of Best Practice/Magic Constants/MagicStringsUseConstant.qhelp
@@ -35,7 +35,7 @@ update if the requirements change, because you have to update the string in only
 </recommendation>
 <example>
 
-<p>The following example shows a magic string <code>internal_ip</code>. This should be replaced by  
+<p>The following example shows a magic string <code>internalIp</code>. This should be replaced by  
 the existing named constant, as shown in the fixed version.</p>
 
 <sample src="MagicStringsUseConstant.java" />

Original file line number	Diff line number	Diff line change
`@@ -1,37 +1,36 @@`
`1`	`1`	`// Problem version`
`2`	`2`	`public class MagicConstants`
`3`	`3`	`{`
`4`		`- final static public String IP = "127.0.0.1";`
`5`		`- final static public int PORT = 8080;`
`6`		`- final static public String USERNAME = "test";`
`7`		`- final static public int TIMEOUT = 60000;`
	`4`	`+ public static final String IP = "127.0.0.1";`
	`5`	`+ public static final int PORT = 8080;`
	`6`	`+ public static final String USERNAME = "test";`
	`7`	`+ public static final int TIMEOUT = 60000;`
`8`	`8`
`9`	`9`	`public void serve(String ip, int port, String user, int timeout) {`
`10`	`10`	`// ...`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public static void main(String[] args) {`
`14`		`- int internal_port = 8080; // AVOID: Magic number`
	`14`	`+ int internalPort = 8080; // AVOID: Magic number`
`15`	`15`
`16`		`- new MagicConstants().serve(IP, internal_port, USERNAME, TIMEOUT);`
	`16`	`+ new MagicConstants().serve(IP, internalPort, USERNAME, TIMEOUT);`
`17`	`17`	`}`
`18`	`18`	`}`
`19`	`19`
`20`	`20`
`21`	`21`	`// Fixed version`
`22`	`22`	`public class MagicConstants`
`23`	`23`	`{`
`24`		`- final static public String IP = "127.0.0.1";`
`25`		`- final static public int PORT = 8080;`
`26`		`- final static public String USERNAME = "test";`
`27`		`- final static public int TIMEOUT = 60000;`
	`24`	`+ public static final String IP = "127.0.0.1";`
	`25`	`+ public static final int PORT = 8080;`
	`26`	`+ public static final String USERNAME = "test";`
	`27`	`+ public static final int TIMEOUT = 60000;`
`28`	`28`
`29`	`29`	`public void serve(String ip, int port, String user, int timeout) {`
`30`	`30`	`// ...`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public static void main(String[] args) {`
`34`		`-`
`35`	`34`	`new MagicConstants().serve(IP, PORT, USERNAME, TIMEOUT); // Use 'PORT' constant`
`36`	`35`	`}`
`37`	`36`	`}`