File: SelfAlwaysReturnsThis.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 (29 lines) | stat: -rw-r--r-- 733 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
A common pattern for abstract `Builders` is to declare an instance method named
`self()`, which subtypes override and implement as `return this` (see Effective
Java 3rd Edition, Item 2).

Returning anything other than `this` from an instance method named `self()` with
a return type that matches the enclosing class will be confusing for readers and
callers.

## Casting

If an unchecked cast is required, prefer a single-statement cast, with the
suppression on the method (rather than the statement). For example:

```java
  @SuppressWarnings("unchecked")
  default U self() {
    return (U) this;
  }
```

Instead of:

```java
  default U self() {
    @SuppressWarnings("unchecked")
    U self = (U) this;
    return self;
  }
```