Assignment or return of field with mutable type

Reports return of, or assignment from a method parameter to an array or a mutable type like Collection, Date, Map, Calendar, etc.

Because such types are mutable, this construct may result in unexpected modifications of an object's state from outside the owning class. Although this construct may be useful for performance reasons, it is inherently prone to bugs.

The following mutable types are reported:

java.util.Date
java.util.Calendar
java.util.Collection
java.util.Map
com.google.common.collect.Multimap
com.google.common.collect.Table

The quick-fix adds a call to the field's .clone() method.

Example:

  class Log {
    String[] messages;
    ...

    String[] getMessages() {
      return messages; // warning: Return of String[] field 'messages'
    }
  }

After the quick-fix is applied:

  class Log {
    String[] messages;
    ...

    String[] getMessages() {
      return messages.clone();
    }
  }

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

AssignmentOrReturnOfFieldWithMutableType

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Java | Encapsulation

Use the Ignore assignments in and returns from private methods option to ignore assignments and returns in private methods.

Inspection options

Here you can find the description of settings available for the Assignment or return of field with mutable type inspection, and the reference of their default values.

Ignore assignments in and returns from private methods: Default: Selected

Availability

By default bundled with: IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,
Can be installed with plugin: Java, 241.18072

Last modified: 18 June 2024