Performance | PMD Source Code Analyzer

Rules that flag suboptimal code.

AddEmptyString

Since: PMD 4.0

Priority: Medium (3)

The conversion of literals to strings by concatenating them with empty strings is inefficient. It is much better to use one of the type-specific toString() methods instead or String.valueOf().

This rule is defined by the following XPath expression:

//AdditiveExpression/PrimaryExpression/PrimaryPrefix/Literal[@Image='""' and not(ancestor::Annotation)]
|
//AdditiveExpression/PrimaryExpression/PrimaryPrefix/Name
  [@Image = (//FieldDeclaration[@Final = true()]|ancestor::MethodDeclaration//LocalVariableDeclaration[@Final = true()])
                /VariableDeclarator[@Initializer = true()]
                    [VariableInitializer/Expression/PrimaryExpression/PrimaryPrefix/Literal[@Image='""']]
                    /VariableDeclaratorId/@Name]

Example(s):

String s = "" + 123;                // inefficient
String t = Integer.toString(456);   // preferred approach

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AddEmptyString" />

AppendCharacterWithChar

Since: PMD 3.5

Priority: Medium (3)

Avoid concatenating characters as strings in StringBuffer/StringBuilder.append methods.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.AppendCharacterWithCharRule

Example(s):

StringBuffer sb = new StringBuffer();
sb.append("a");     // avoid this

StringBuffer sb = new StringBuffer();
sb.append('a');     // use this instead

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AppendCharacterWithChar" />

AvoidArrayLoops

Since: PMD 3.5

Priority: Medium (3)

Instead of manually copying data between two arrays, use the more efficient Arrays.copyOf or System.arraycopy method instead.

To copy only part of the array, use Arrays.copyOfRange or System.arraycopy.

If you want to copy/move elements inside the same array (e.g. shift the elements), use System.arraycopy.

This rule is defined by the following XPath expression:

//Statement
  [(ForStatement or WhileStatement or DoStatement)]
  [count(*/Statement//AssignmentOperator[@Image = '='])=1]
  [*/Statement/Block/BlockStatement/Statement
        /StatementExpression[AssignmentOperator[@Image = '=']]
        (: LHS - left hand side :)
        [PrimaryExpression[count(PrimarySuffix) = 1]/PrimarySuffix[@ArrayDereference = true()]
        /Expression[PrimaryExpression or AdditiveExpression]
                   [count(.//PrimaryPrefix/Name) = 1 or
                    (count(.//PrimaryPrefix/Name) = 2 and .//PrimaryPrefix/Name/@Image = (ancestor::MethodDeclaration|//FieldDeclaration)//VariableDeclarator[VariableInitializer//Literal]/VariableDeclaratorId[@Final = true()]/@Name)
                   ]
        //PrimaryPrefix/Name/@Image]
        (: RHS - right hand side :)
        [Expression/PrimaryExpression/PrimarySuffix[@ArrayDereference = true()][count(..//PrimarySuffix) = 1]
        /Expression[PrimaryExpression or AdditiveExpression]
                   [count(.//PrimaryPrefix/Name) = 1 or
                    (count(.//PrimaryPrefix/Name) = 2 and .//PrimaryPrefix/Name/@Image = (ancestor::MethodDeclaration|//FieldDeclaration)//VariableDeclarator[VariableInitializer//Literal]/VariableDeclaratorId[@Final = true()]/@Name)
                   ]
        //PrimaryPrefix/Name/@Image]
  ]

Example(s):

class Scratch {
    void copy_a_to_b() {
        int[] a = new int[10];
        int[] b = new int[10];
        for (int i = 0; i < a.length; i++) {
            b[i] = a[i];
        }
        // equivalent
        b = Arrays.copyOf(a, a.length);
        // equivalent
        System.arraycopy(a, 0, b, 0, a.length);

        int[] c = new int[10];
        // this will not trigger the rule
        for (int i = 0; i < c.length; i++) {
            b[i] = a[c[i]];
        }
    }
}

class Scratch {
    void shift_left(int[] a) {
        for (int i = 0; i < a.length - 1; i++) {
            a[i] = a[i + 1];
        }
        // equivalent
        System.arraycopy(a, 1, a, 0, a.length - 1);
    }
    void shift_right(int[] a) {
        for (int i = a.length - 1; i > 0; i--) {
            a[i] = a[i - 1];
        }
        // equivalent
        System.arraycopy(a, 0, a, 1, a.length - 1);
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AvoidArrayLoops" />

AvoidCalendarDateCreation

Since: PMD 6.25.0

Priority: Medium (3)

Problem: A Calendar is a heavyweight object and expensive to create.

Solution: Use new Date(), Java 8+ java.time.LocalDateTime.now() or ZonedDateTime.now().

This rule is defined by the following XPath expression:

//PrimaryPrefix[Name[ends-with(@Image, 'Calendar.getInstance')]] [count(../PrimarySuffix) > 2 and ../PrimarySuffix[last()-1][@Image = 'getTime' or @Image='getTimeInMillis']]
|
//MethodDeclaration[not(MethodDeclarator/FormalParameters//ClassOrInterfaceType[pmd-java:typeIs('java.util.Calendar')])]
  /Block/BlockStatement//PrimaryExpression
  /PrimaryPrefix/Name
    [pmd-java:typeIs('java.util.Calendar')]
    [every $var in @Image satisfies (
       (ends-with($var, '.getTime') or ends-with($var, '.getTimeInMillis'))
       and
       (: ignore if .set* or .add* or .clear is called on the variable :)
       not(ancestor::Block/BlockStatement//Name[
          starts-with(@Image, concat((tokenize($var, '\.'), $var)[1], '.set'))
          or
          starts-with(@Image, concat((tokenize($var, '\.'), $var)[1], '.add'))
          or
          starts-with(@Image, concat((tokenize($var, '\.'), $var)[1], '.clear'))
       ])
    )]
|
//ClassOrInterfaceType[pmd-java:typeIs('org.joda.time.DateTime') or pmd-java:typeIs('org.joda.time.LocalDateTime')][../Arguments/ArgumentList/Expression/PrimaryExpression/PrimaryPrefix/Name[ends-with(@Image, 'Calendar.getInstance')]]

Example(s):

import java.time.LocalDateTime;
import java.util.Calendar;
import java.util.Date;

public class DateStuff {
    private Date bad1() {
        return Calendar.getInstance().getTime(); // now
    }
    private Date good1a() {
        return new Date(); // now
    }
    private LocalDateTime good1b() {
        return LocalDateTime.now();
    }
    private long bad2() {
        return Calendar.getInstance().getTimeInMillis();
    }
    private long good2() {
        return System.currentTimeMillis();
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AvoidCalendarDateCreation" />

AvoidFileStream

Since: PMD 6.0.0

Priority: High (1)

Minimum Language Version: Java 1.7

The FileInputStream and FileOutputStream classes contains a finalizer method which will cause garbage collection pauses. See JDK-8080225 for details.

The FileReader and FileWriter constructors instantiate FileInputStream and FileOutputStream, again causing garbage collection issues while finalizer methods are called.

Use Files.newInputStream(Paths.get(fileName)) instead of new FileInputStream(fileName).
Use Files.newOutputStream(Paths.get(fileName)) instead of new FileOutputStream(fileName).
Use Files.newBufferedReader(Paths.get(fileName)) instead of new FileReader(fileName).
Use Files.newBufferedWriter(Paths.get(fileName)) instead of new FileWriter(fileName).

Please note, that the java.nio API does not throw a FileNotFoundException anymore, instead it throws a NoSuchFileException. If your code dealt explicitly with a FileNotFoundException, then this needs to be adjusted. Both exceptions are subclasses of IOException, so catching that one covers both.

This rule is defined by the following XPath expression:

//PrimaryPrefix/AllocationExpression/ClassOrInterfaceType[
       pmd-java:typeIs('java.io.FileInputStream')
    or pmd-java:typeIs('java.io.FileOutputStream')
    or pmd-java:typeIs('java.io.FileReader')
    or pmd-java:typeIs('java.io.FileWriter')
  ]

Example(s):

// these instantiations cause garbage collection pauses, even if properly closed

    FileInputStream fis = new FileInputStream(fileName);
    FileOutputStream fos = new FileOutputStream(fileName);
    FileReader fr = new FileReader(fileName);
    FileWriter fw = new FileWriter(fileName);

    // the following instantiations help prevent Garbage Collection pauses, no finalization

    try(InputStream is = Files.newInputStream(Paths.get(fileName))) {
    }
    try(OutputStream os = Files.newOutputStream(Paths.get(fileName))) {
    }
    try(BufferedReader br = Files.newBufferedReader(Paths.get(fileName), StandardCharsets.UTF_8)) {
    }
    try(BufferedWriter wr = Files.newBufferedWriter(Paths.get(fileName), StandardCharsets.UTF_8)) {
    }

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AvoidFileStream" />

AvoidInstantiatingObjectsInLoops

Since: PMD 2.2

Priority: Medium (3)

New objects created within loops should be checked to see if they can created outside them and reused.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.AvoidInstantiatingObjectsInLoopsRule

Example(s):

public class Something {
    public static void main( String as[] ) {
        for (int i = 0; i < 10; i++) {
            Foo f = new Foo(); // Avoid this whenever you can it's really expensive
        }
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AvoidInstantiatingObjectsInLoops" />

AvoidUsingShortType

Deprecated

Since: PMD 4.1

Priority: High (1)

Note: This rule is deprecated since PMD 6.31.0 and will be removed with PMD 7.0.0. There is no planned replacement. This rule is deprecated, as its rationale does not hold.

Java uses the ‘short’ type to reduce memory usage, not to optimize calculation. In fact, the JVM does not have any arithmetic capabilities for the short type: the JVM must convert the short into an int, do the proper calculation and convert the int back to a short. Thus any storage gains found through use of the ‘short’ type may be offset by adverse impacts on performance.

This rule is defined by the following XPath expression:

//FieldDeclaration/Type/PrimitiveType[@Image = 'short']
|
//ClassOrInterfaceBodyDeclaration[not(Annotation/MarkerAnnotation/Name[pmd-java:typeIs('java.lang.Override')])]
    /MethodDeclaration/ResultType/Type/PrimitiveType[@Image = 'short']
|
//ClassOrInterfaceBodyDeclaration[not(Annotation/MarkerAnnotation/Name[pmd-java:typeIs('java.lang.Override')])]
    /MethodDeclaration/MethodDeclarator/FormalParameters/FormalParameter/Type/PrimitiveType[@Image = 'short']
|
//LocalVariableDeclaration/Type/PrimitiveType[@Image = 'short']
|
//AnnotationMethodDeclaration/Type/PrimitiveType[@Image = 'short']

Example(s):

public class UsingShort {
   private short doNotUseShort = 0;

   public UsingShort() {
    short shouldNotBeUsed = 1;
    doNotUseShort += shouldNotBeUsed;
  }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/AvoidUsingShortType" />

BigIntegerInstantiation

Since: PMD 3.9

Priority: Medium (3)

Don’t create instances of already existing BigInteger (BigInteger.ZERO, BigInteger.ONE) and for Java 1.5 onwards, BigInteger.TEN and BigDecimal (BigDecimal.ZERO, BigDecimal.ONE, BigDecimal.TEN)

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.BigIntegerInstantiationRule

Example(s):

BigInteger bi = new BigInteger(1);       // reference BigInteger.ONE instead
BigInteger bi2 = new BigInteger("0");    // reference BigInteger.ZERO instead
BigInteger bi3 = new BigInteger(0.0);    // reference BigInteger.ZERO instead
BigInteger bi4;
bi4 = new BigInteger(0);                 // reference BigInteger.ZERO instead

Use this rule by referencing it:

<rule ref="category/java/performance.xml/BigIntegerInstantiation" />

BooleanInstantiation

Deprecated

Since: PMD 1.2

Priority: Medium High (2)

Avoid instantiating Boolean objects; you can reference Boolean.TRUE, Boolean.FALSE, or call Boolean.valueOf() instead. Note that new Boolean() is deprecated since JDK 9 for that reason.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. Use PrimitiveWrapperInstantiation instead.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.BooleanInstantiationRule

Example(s):

Boolean bar = new Boolean("true");        // unnecessary creation, just reference Boolean.TRUE;
Boolean buz = Boolean.valueOf(false);    // ...., just reference Boolean.FALSE;

Use this rule by referencing it:

<rule ref="category/java/performance.xml/BooleanInstantiation" />

ByteInstantiation

Deprecated

Since: PMD 4.0

Priority: Medium High (2)

Calling new Byte() causes memory allocation that can be avoided by the static Byte.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Byte() is deprecated since JDK 9 for that reason.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. Use PrimitiveWrapperInstantiation instead.

This rule is defined by the following XPath expression:

//AllocationExpression
[not (ArrayDimsAndInits)
and ClassOrInterfaceType[pmd-java:typeIs('java.lang.Byte')]]

Example(s):

public class Foo {
    private Byte i = new Byte(0); // change to Byte i = Byte.valueOf(0);
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/ByteInstantiation" />

ConsecutiveAppendsShouldReuse

Since: PMD 5.1

Priority: Medium (3)

Consecutive calls to StringBuffer/StringBuilder .append should be chained, reusing the target object. This can improve the performance by producing a smaller bytecode, reducing overhead and improving inlining. A complete analysis can be found here

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.ConsecutiveAppendsShouldReuseRule

Example(s):

String foo = " ";

StringBuffer buf = new StringBuffer();
buf.append("Hello"); // poor
buf.append(foo);
buf.append("World");

StringBuffer buf = new StringBuffer();
buf.append("Hello").append(foo).append("World"); // good

Use this rule by referencing it:

<rule ref="category/java/performance.xml/ConsecutiveAppendsShouldReuse" />

ConsecutiveLiteralAppends

Since: PMD 3.5

Priority: Medium (3)

Consecutively calling StringBuffer/StringBuilder.append(…) with literals should be avoided. Since the literals are constants, they can already be combined into a single String literal and this String can be appended in a single method call.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.ConsecutiveLiteralAppendsRule

Example(s):

StringBuilder buf = new StringBuilder();
buf.append("Hello").append(" ").append("World");    // poor
buf.append("Hello World");                          // good

buf.append('h').append('e').append('l').append('l').append('o'); // poor
buf.append("hello");                                             // good

buf.append(1).append('m');  // poor
buf.append("1m");           // good

This rule has the following properties:

Name	Default Value	Description	Multivalued
threshold	1	Max consecutive appends	no

Use this rule with the default properties by just referencing it:

<rule ref="category/java/performance.xml/ConsecutiveLiteralAppends" />

Use this rule and customize it:

<rule ref="category/java/performance.xml/ConsecutiveLiteralAppends">
    <properties>
        <property name="threshold" value="1" />
    </properties>
</rule>

InefficientEmptyStringCheck

Since: PMD 3.6

Priority: Medium (3)

String.trim().length() == 0 (or String.trim().isEmpty() for the same reason) is an inefficient way to check if a String is really blank, as it creates a new String object just to check its size. Consider creating a static function that loops through a string, checking Character.isWhitespace() on each character and returning false if a non-whitespace character is found. A Smarter code to check for an empty string would be:

private boolean checkTrimEmpty(String str) {
    for(int i = 0; i < str.length(); i++) {
        if(!Character.isWhitespace(str.charAt(i))) {
            return false;
        }
    }
    return true;
}

You can refer to Apache’s StringUtils#isBlank (in commons-lang), Spring’s StringUtils#hasText (in the Spring framework) or Google’s CharMatcher#whitespace (in Guava) for existing implementations (some might include the check for != null).

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.InefficientEmptyStringCheckRule

Example(s):

public void bar(String string) {
    if (string != null && string.trim().length() > 0) {
        doSomething();
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/InefficientEmptyStringCheck" />

InefficientStringBuffering

Since: PMD 3.4

Priority: Medium (3)

Avoid concatenating non-literals in a StringBuffer constructor or append() since intermediate buffers will need to be be created and destroyed by the JVM.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.InefficientStringBufferingRule

Example(s):

// Avoid this, two buffers are actually being created here
StringBuffer sb = new StringBuffer("tmp = "+System.getProperty("java.io.tmpdir"));

// do this instead
StringBuffer sb = new StringBuffer("tmp = ");
sb.append(System.getProperty("java.io.tmpdir"));

Use this rule by referencing it:

<rule ref="category/java/performance.xml/InefficientStringBuffering" />

InsufficientStringBufferDeclaration

Since: PMD 3.6

Priority: Medium (3)

Failing to pre-size a StringBuffer or StringBuilder properly could cause it to re-size many times during runtime. This rule attempts to determine the total number the characters that are actually passed into StringBuffer.append(), but represents a best guess "worst case" scenario. An empty StringBuffer/StringBuilder constructor initializes the object to 16 characters. This default is assumed if the length of the constructor can not be determined.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.InsufficientStringBufferDeclarationRule

Example(s):

StringBuilder bad = new StringBuilder();
bad.append("This is a long string that will exceed the default 16 characters");

StringBuilder good = new StringBuilder(41);
good.append("This is a long string, which is pre-sized");

Use this rule by referencing it:

<rule ref="category/java/performance.xml/InsufficientStringBufferDeclaration" />

IntegerInstantiation

Deprecated

Since: PMD 3.5

Priority: Medium High (2)

Calling new Integer() causes memory allocation that can be avoided by the static Integer.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Integer() is deprecated since JDK 9 for that reason.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. Use PrimitiveWrapperInstantiation instead.

This rule is defined by the following XPath expression:

//AllocationExpression
  [not (ArrayDimsAndInits)
   and ClassOrInterfaceType[pmd-java:typeIs('java.lang.Integer')]]

Example(s):

public class Foo {
    private Integer i = new Integer(0); // change to Integer i = Integer.valueOf(0);
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/IntegerInstantiation" />

LongInstantiation

Deprecated

Since: PMD 4.0

Priority: Medium High (2)

Calling new Long() causes memory allocation that can be avoided by the static Long.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Long() is deprecated since JDK 9 for that reason.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. Use PrimitiveWrapperInstantiation instead.

This rule is defined by the following XPath expression:

//AllocationExpression
[not (ArrayDimsAndInits)
and ClassOrInterfaceType[pmd-java:typeIs('java.lang.Long')]]

Example(s):

public class Foo {
    private Long i = new Long(0); // change to Long i = Long.valueOf(0);
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/LongInstantiation" />

OptimizableToArrayCall

Since: PMD 1.8

Priority: Medium (3)

Minimum Language Version: Java 1.6

Calls to a collection’s toArray(E[]) method should specify a target array of zero size. This allows the JVM to optimize the memory allocation and copying as much as possible.

Previous versions of this rule (pre PMD 6.0.0) suggested the opposite, but current JVM implementations perform always better, when they have full control over the target array. And allocation an array via reflection is nowadays as fast as the direct allocation.

Note: If you don’t need an array of the correct type, then the simple toArray() method without an array is faster, but returns only an array of type Object[].

This rule is defined by the following XPath expression:

//PrimaryExpression
[PrimaryPrefix/Name[ends-with(@Image, 'toArray')]]
[
PrimarySuffix/Arguments/ArgumentList/Expression
 /PrimaryExpression/PrimaryPrefix/AllocationExpression
 /ArrayDimsAndInits/Expression/PrimaryExpression/PrimaryPrefix[not(Literal[@Image='0'])]
]

Example(s):

List<Foo> foos = getFoos();

// much better; this one allows the jvm to allocate an array of the correct size and effectively skip
// the zeroing, since each array element will be overridden anyways
Foo[] fooArray = foos.toArray(new Foo[0]);

// inefficient, the array needs to be zeroed out by the jvm before it is handed over to the toArray method
Foo[] fooArray = foos.toArray(new Foo[foos.size()]);

Use this rule by referencing it:

<rule ref="category/java/performance.xml/OptimizableToArrayCall" />

RedundantFieldInitializer

Since: PMD 5.0

Priority: Medium (3)

Java will initialize fields with known default values so any explicit initialization of those same defaults is redundant and results in a larger class file (approximately three additional bytecode instructions per field).

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.RedundantFieldInitializerRule

Example(s):

public class C {
    boolean b   = false;    // examples of redundant initializers
    byte by     = 0;
    short s     = 0;
    char c      = 0;
    int i       = 0;
    long l      = 0;

    float f     = .0f;    // all possible float literals
    doable d    = 0d;     // all possible double literals
    Object o    = null;

    MyClass mca[] = null;
    int i1 = 0, ia1[] = null;

    class Nested {
        boolean b = false;
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/RedundantFieldInitializer" />

ShortInstantiation

Deprecated

Since: PMD 4.0

Priority: Medium High (2)

Calling new Short() causes memory allocation that can be avoided by the static Short.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Short() is deprecated since JDK 9 for that reason.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. Use PrimitiveWrapperInstantiation instead.

This rule is defined by the following XPath expression:

//AllocationExpression
[not (ArrayDimsAndInits)
and ClassOrInterfaceType[pmd-java:typeIs('java.lang.Short')]]

Example(s):

public class Foo {
    private Short i = new Short(0); // change to Short i = Short.valueOf(0);
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/ShortInstantiation" />

SimplifyStartsWith

Deprecated

Since: PMD 3.1

Priority: Medium (3)

Note: This rule is deprecated since PMD 6.31.0 and will be removed with PMD 7.0.0. There is no planned replacement. The rule is deprecated for removal, as the optimization is insignificant.

Calls to string.startsWith("x") with a string literal of length 1 can be rewritten using string.charAt(0), at the expense of some readability. To prevent IndexOutOfBoundsException being thrown by the charAt method, ensure that the string is not empty by making an additional check first.

This rule is defined by the following XPath expression:

//PrimaryExpression
 [PrimaryPrefix/Name
  [ends-with(@Image, '.startsWith')] or PrimarySuffix[@Image='startsWith']]
 [PrimarySuffix/Arguments/ArgumentList
  /Expression/PrimaryExpression/PrimaryPrefix
  /Literal
   [string-length(@Image)=3]
   [starts-with(@Image, '"')]
   [ends-with(@Image, '"')]
 ]

Example(s):

public class Foo {

    boolean checkIt(String x) {
        return x.startsWith("a");   // suboptimal
    }

    boolean fasterCheckIt(String x) {
        return !x.isEmpty() && x.charAt(0) == 'a';  // faster approach
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/SimplifyStartsWith" />

StringInstantiation

Since: PMD 1.0

Priority: Medium High (2)

Avoid instantiating String objects; this is usually unnecessary since they are immutable and can be safely shared.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.StringInstantiationRule

Example(s):

private String bar = new String("bar"); // just do a String bar = "bar";

Use this rule by referencing it:

<rule ref="category/java/performance.xml/StringInstantiation" />

StringToString

Since: PMD 1.0

Priority: Medium (3)

Avoid calling toString() on objects already known to be string instances; this is unnecessary.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.StringToStringRule

Example(s):

private String baz() {
    String bar = "howdy";
    return bar.toString();
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/StringToString" />

TooFewBranchesForASwitchStatement

Since: PMD 4.2

Priority: Medium (3)

Switch statements are intended to be used to support complex branching behaviour. Using a switch for only a few cases is ill-advised, since switches are not as easy to understand as if-else statements. In these cases use the if-else statement to increase code readability.

This rule is defined by the following XPath expression:

//SwitchStatement[
    (count(.//SwitchLabel) < $minimumNumberCaseForASwitch)
]

Example(s):

// With a minimumNumberCaseForASwitch of 3
public class Foo {
    public void bar() {
        switch (condition) {
            case ONE:
                instruction;
                break;
            default:
                break; // not enough for a 'switch' stmt, a simple 'if' stmt would have been more appropriate
        }
    }
}

This rule has the following properties:

Name	Default Value	Description	Multivalued
minimumNumberCaseForASwitch	3	Minimum number of branches for a switch	no

Use this rule with the default properties by just referencing it:

<rule ref="category/java/performance.xml/TooFewBranchesForASwitchStatement" />

Use this rule and customize it:

<rule ref="category/java/performance.xml/TooFewBranchesForASwitchStatement">
    <properties>
        <property name="minimumNumberCaseForASwitch" value="3" />
    </properties>
</rule>

UnnecessaryWrapperObjectCreation

Deprecated

Since: PMD 3.8

Priority: Medium (3)

Most wrapper classes provide static conversion methods that avoid the need to create intermediate objects just to create the primitive forms. Using these avoids the cost of creating objects that also need to be garbage-collected later.

Note: This rule is deprecated since PMD 6.37.0 and will be removed with PMD 7.0.0. The planned replacement is not expected before PMD 7.0.0. In PMD 7 the new rule UnnecessaryBoxing can be used instead.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.UnnecessaryWrapperObjectCreationRule

Example(s):

public int convert(String s) {
    int i, i2;

    i = Integer.valueOf(s).intValue();  // this wastes an object
    i = Integer.parseInt(s);            // this is better

    i2 = Integer.valueOf(i).intValue(); // this wastes an object
    i2 = i;                             // this is better

    String s3 = Integer.valueOf(i2).toString(); // this wastes an object
    s3 = Integer.toString(i2);                  // this is better

    return i2;
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UnnecessaryWrapperObjectCreation" />

UseArrayListInsteadOfVector

Since: PMD 3.0

Priority: Medium (3)

ArrayList is a much better Collection implementation than Vector if thread-safe operation is not required.

This rule is defined by the following XPath expression:

//AllocationExpression/ClassOrInterfaceType[pmd-java:typeIsExactly('java.util.Vector')]

Example(s):

import java.util.*;
public class SimpleTest extends TestCase {
    public void testX() {
    Collection c1 = new Vector();
    Collection c2 = new ArrayList();    // achieves the same with much better performance
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseArrayListInsteadOfVector" />

UseArraysAsList

Since: PMD 3.5

Priority: Medium (3)

The java.util.Arrays class has a asList() method that should be used when you want to create a new List from an array of objects. It is faster than executing a loop to copy all the elements of the array one by one.

Note that the result of Arrays.asList() is backed by the specified array, changes in the returned list will result in the array to be modified. For that reason, it is not possible to add new elements to the returned list of Arrays.asList() (UnsupportedOperationException). You must use new ArrayList<>(Arrays.asList(...)) if that is inconvenient for you (e.g. because of concurrent access).

This rule is defined by the following XPath expression:

//Statement/ForStatement
    [not(.//IfStatement)]
    [count(Statement//StatementExpression)=1]
    [@Foreach = true() or ForInit//VariableInitializer//Literal[@IntLiteral= true() and @Image='0']]
    (: skip primitive types :)
    [@Foreach = true() and Expression[pmd-java:typeIs('java.lang.Object[]')]
        or Expression/RelationalExpression/PrimaryExpression/PrimaryPrefix/Name[substring-before(@Image, '.length') =
           ancestor::MethodDeclaration[1]//VariableDeclaratorId[pmd-java:typeIs('java.lang.Object[]')]
           /@Name]
    ]
    //StatementExpression
      [PrimaryExpression
        [PrimaryPrefix/Name
            (: method call foo.add(), where foo is initialized as a new ArrayList :)
            [ends-with(@Image, '.add')]
            [substring-before(@Image, '.add') = ancestor::MethodDeclaration[1]//VariableDeclarator
                [VariableInitializer/Expression/PrimaryExpression/PrimaryPrefix/AllocationExpression[pmd-java:typeIs('java.util.ArrayList')]]
            /@Name]
        ]
        [PrimarySuffix/Arguments/ArgumentList/Expression/PrimaryExpression
            (: checking arguments of method call foo.add() :)
            [
                (: foreach loop var :)
                PrimaryPrefix/Name/@Image = ancestor::ForStatement[1][@Foreach = true()]/LocalVariableDeclaration/VariableDeclarator/@Name
                and (
                    (: foreach loop over local var which is an array :)
                    ancestor::ForStatement[1][@Foreach = true()]/Expression/PrimaryExpression/PrimaryPrefix/Name/@Image = ancestor::MethodDeclaration[1]//LocalVariableDeclaration/VariableDeclarator/VariableDeclaratorId[@ArrayType=true()]/@Name
                    (: foreach loop over method parameter which is an array :)
                    or ancestor::ForStatement[1][@Foreach = true()]/Expression/PrimaryExpression/PrimaryPrefix/Name/@Image = ancestor::MethodDeclaration[1]//FormalParameter/VariableDeclaratorId[@ArrayType=true()]/@Name
                )
                or
                (: local var which is an array :)
                PrimaryPrefix/Name/@Image = ancestor::MethodDeclaration[1]//LocalVariableDeclaration/VariableDeclarator/VariableDeclaratorId[@ArrayType=true()]/@Name
                and PrimarySuffix/Expression/PrimaryExpression/PrimaryPrefix/Name
                or
                (: method parameter which is an array :)
                PrimaryPrefix/Name/@Image = ancestor::MethodDeclaration[1]//FormalParameter/VariableDeclaratorId[@ArrayType=true()]/@Name
                and PrimarySuffix/Expression/PrimaryExpression/PrimaryPrefix/Name
            ]
            (: ignore method calls :)
            [not(PrimarySuffix/Arguments)]
        ]
      ]

Example(s):

public class Test {
    public void foo(Integer[] ints) {
        // could just use Arrays.asList(ints)
        List<Integer> l = new ArrayList<>(100);
        for (int i = 0; i < ints.length; i++) {
            l.add(ints[i]);
        }

        List<Integer> anotherList = new ArrayList<>();
        for (int i = 0; i < ints.length; i++) {
            anotherList.add(ints[i].toString()); // won't trigger the rule
        }
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseArraysAsList" />

UseIndexOfChar

Since: PMD 3.5

Priority: Medium (3)

Use String.indexOf(char) when checking for the index of a single character; it executes faster.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.UseIndexOfCharRule

Example(s):

String s = "hello world";
// avoid this
if (s.indexOf("d") {}
// instead do this
if (s.indexOf('d') {}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseIndexOfChar" />

UseIOStreamsWithApacheCommonsFileItem

Since: PMD 6.25.0

Priority: Medium (3)

Problem: Use of FileItem.get() and FileItem.getString() could exhaust memory since they load the entire file into memory.

Solution: Use FileItem.getInputStream() and buffering.

This rule is defined by the following XPath expression:

//PrimaryPrefix/Name
[ends-with(@Image, '.get') or ends-with(@Image, '.getString')]
[
    starts-with(@Image, concat(
        ancestor::MethodDeclaration//FormalParameter/Type/ReferenceType/ClassOrInterfaceType[pmd-java:typeIs('org.apache.commons.fileupload.FileItem')]/../../..//VariableDeclaratorId/@Name,
        '.')
    ) or
    starts-with(@Image, concat(
        ancestor::MethodDeclaration//LocalVariableDeclaration/Type/ReferenceType/ClassOrInterfaceType[pmd-java:typeIs('org.apache.commons.fileupload.FileItem')]/../../..//VariableDeclaratorId/@Name,
        '.')
    ) or
    starts-with(@Image, concat(
        ancestor::ClassOrInterfaceBody/ClassOrInterfaceBodyDeclaration/FieldDeclaration/Type/ReferenceType/ClassOrInterfaceType[pmd-java:typeIs('org.apache.commons.fileupload.FileItem')]/../../..//VariableDeclaratorId/@Name,
        '.')
    )
]

Example(s):

import org.apache.commons.fileupload.FileItem;

public class FileStuff {
   private String bad(FileItem fileItem) {
        return fileItem.getString();
   }

   private InputStream good(FileItem fileItem) {
        return fileItem.getInputStream();
   }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseIOStreamsWithApacheCommonsFileItem" />

UselessStringValueOf

Since: PMD 3.8

Priority: Medium (3)

No need to call String.valueOf to append to a string; just use the valueOf() argument directly.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.UselessStringValueOfRule

Example(s):

public String convert(int i) {
    String s;
    s = "a" + String.valueOf(i);    // not required
    s = "a" + i;                    // preferred approach
    return s;
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UselessStringValueOf" />

UseStringBufferForStringAppends

Since: PMD 3.1

Priority: Medium (3)

The use of the ‘+=’ operator for appending strings causes the JVM to create and use an internal StringBuffer. If a non-trivial number of these concatenations are being used then the explicit use of a StringBuilder or threadsafe StringBuffer is recommended to avoid this.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.UseStringBufferForStringAppendsRule

Example(s):

public class Foo {
    String inefficientConcatenation() {
        String result = "";
        for (int i = 0; i < 10; i++) {
            // warning: this concatenation will create one new StringBuilder per iteration
            result += getStringFromSomeWhere(i);
        }
        return result;
    }

    String efficientConcatenation() {
        // better would be to use one StringBuilder for the entire loop
        StringBuilder result = new StringBuilder();
        for (int i = 0; i < 10; i++) {
            result.append(getStringFromSomeWhere(i));
        }
        return result.toString();
    }
}

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseStringBufferForStringAppends" />

UseStringBufferLength

Since: PMD 3.4

Priority: Medium (3)

Use StringBuffer.length() to determine StringBuffer length rather than using StringBuffer.toString().equals("") or StringBuffer.toString().length() == …

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.performance.UseStringBufferLengthRule

Example(s):

StringBuffer sb = new StringBuffer();

if (sb.toString().equals("")) {}        // inefficient

if (sb.length() == 0) {}                // preferred

Use this rule by referencing it:

<rule ref="category/java/performance.xml/UseStringBufferLength" />