File: AvoidObjectArrays.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (40 lines) | stat: -rw-r--r-- 917 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Object arrays are inferior to collections in almost every way. Prefer `Set`,
`List`, or `Multiset` over an object array whenever possible.

A few of these issues are covered, in much greater detail, in
[Effective Java Item 28: Prefer lists to arrays][ej3e-28].

# Method Parameters

Don't use object arrays as method parameters:

```java
public void createUsers(User[] users) { ... }
```

Use an `Iterable` instead:

```java
public void createUsers(Iterable<User> users) { ... }
```

# Return Values

Don't use object arrays as method return values:

```java
public User[] loadUsers() { ... }
```

Use an `ImmutableList` (or `ImmutableSet`) instead:

```java
public ImmutableList<User> loadUsers() { ... }
```

# Additional Alternatives

If you have a 2-dimensional array (e.g., `Foo[][]`), consider using an
`ImmutableTable<Integer, Integer, Foo>` instead.

[ej3e-28]: https://books.google.com/books?id=BIpDDwAAQBAJ