_java.learnMoreAboutCleanUps.md

Java Clean Ups

Java clean ups are run on the current document whenever it's saved. They can fix a wide variety of issues, from code style to programming mistakes, and can even modernize the sources based on new Java language features. Here is some information on the supported cleanups and the details of what they do.

qualifyMembers

Whenever a member (field or method) of a class is accessed from within the class, prefix the access with this. This is similar to how Python requires the programmer to access members using self.

For instance:

private int value;

public void getValue() {
	return value;
}

becomes:

private int value;

public void getValue() {
	return this.value;
}

qualifyStaticMembers

Whenever there is a static variable or function, prefix the access with the name of the class that the static variable or function belongs to.

For instance:

import static java.lang.System.out;

public class MyClass {
	public static final double FACTOR = 0.5;

	public double getNumber(double value) {
		out.println("moo");
		return value * FACTOR;
	}
}

becomes:

import static java.lang.System.out;

public class MyClass {
	public static final double FACTOR = 0.5;

	public double getNumber(double value) {
		System.out.println("moo");
		return value * MyClass.FACTOR;
	}
}

addOverride

When a method of a class that overrides a method from a parent class or provides an implementation for a method from an interface, add the @Override annotation.

For example:

public class MyRunner implements Runnable {
	public void run() {
		System.out.println("Hello, World!");
	}
}

becomes:

public class MyRunner implements Runnable {
	@Override
	public void run() {
		System.out.println("Hello, World!");
	}
}

addDeprecated

When a method is marked @deprecated in the Javadoc, but doesn't have the @Deprecated annotation, add the @Deprecated annotation. This only works if the compiler has been configured to mark deprecated methods without the deprecated annotation as an info/warning/error in the JDT settings.

For example:

/**
 * Not used anymore, please stop using.
 *
 * @deprecated
 */
public boolean isAGoat() {
	return false;
}

becomes:

/**
 * Not used anymore, please stop using.
 *
 * @deprecated
 */
@Deprecated
public boolean isAGoat() {
	return false;
}

stringConcatToTextBlock

Appropriate String concatenations will be converted into Java Text Blocks. Appropriate String concatenations must have at least 3 non-empty substrings with one per line and the Java level must be 15 or higher. Line comments for all substrings but the last line will be lost after conversion. Spaces at the end of substrings preceding the newline will result in \s being substituted while substrings that do not end with newlines will have a \ added at the end of the line to preserve concatenation.

For example:

String x = "" +
	"public class A {\n" +
	"    public void m() {\n" +
	"        System.out.println(\"abc\");\n" +
	"    }\n" +
	"}";

becomes:

String x = """
	public class A {
		public void m() {
			System.out.println("abc");
		}
	}""";

invertEquals

Inverts calls to Object.equals(Object) and String.equalsIgnoreCase(String) to avoid useless null pointer exception.

The caller must be nullable and the parameter must not be nullable.

By avoiding null pointer exceptions, the behavior may change.

For example:

String message = getMessage();
boolean result1 = message.equals("text");
boolean result2 = message.equalsIgnoreCase("text");

becomes:

String message = getMessage();
boolean result1 = "text".equals(message);
boolean result2 = "text".equalsIgnoreCase(message);

addFinalModifier

Use the final modifier for variable declarations wherever it is possible.

For example:

private int i= 0;
public void foo(int j) {
    int k, h;
    h= 0;
}

becomes:

private final int i= 0;
public void foo(final int j) {
    final int k;
    int h;
    h= 0;
}

instanceofPatternMatch

Use pattern matching for the instanceof operator wherever possible. It is only applicable for Java level 15 or higher.

For example:

if (object instanceof Integer) {
    Integer i = (Integer) object;
    return i.intValue();
}

becomes:

if (object instanceof Integer i) {
    return i.intValue();
}

lambdaExpression

Convert anonymous class declarations for functional interfaces to lambda expressions wherever possible. It is only applicable for Java level 8 or above.

For example:

IntConsumer c = new IntConsumer() {
    @Override public void accept(int value) {
        System.out.println(i);
    }
};

becomes:

IntConsumer c = i -> {
    System.out.println(i);
};

switchExpression

Convert switch statements to switch expressions wherever possible. It is only applicable for Java level 14 or above.

Note : Switch statements that use control statements such as nested switch statements, if/else blocks, for/while loops are not considered as is the case for return/continue statements. All cases of the switch statement must either have a last assignment statement that sets the same variable/field as other cases, or else has a throw statement. Fall-through is allowed between cases but only if there are no other statements in between. The switch statement must have a default case unless the switch expression is an enum type and all possible enum values are represented in the cases.

For example:

int i;
switch(j) {
    case 1:
        i = 3;
        break;
    case 2:
        i = 4;
        break;
    default:
        i = 0;
        break;
}

becomes:

int i = switch(j) {
    case 1 -> 3;
    case 2 -> 4;
    default -> 0;
};

tryWithResource

Simplifies the finally block to use the try-with-resource statement.

For example:

final FileInputStream inputStream = new FileInputStream("out.txt");
try {
    System.out.println(inputStream.read());
} finally {
    inputStream.close();
}

becomes:

final FileInputStream inputStream = new FileInputStream("out.txt");
try (inputStream) {
    System.out.println(inputStream.read());
}