Java Generics Best Practices
Review and improve Java code using comprehensive generics best practices that enforce compile-time type safety and enable flexible, reusable APIs.
What is covered in this Skill?
- Type safety: avoiding raw types, eliminating unsafe casts
- Code reusability: generic methods and types for multiple type contexts
- PECS wildcards:
? extends for producers, ? super for consumers
- Diamond operator for type inference
- Type erasure awareness: type tokens, factory patterns, array creation
- Generic inheritance and variance: invariance, covariance, contravariance
@SafeVarargs for heap pollution prevention- Wildcard capture helpers, self-bounded generics (CRTP) for fluent builders
- Proper wildcard API design:
Comparator<? super T>, Function<? super T, ? extends R>
- Arrays-vs-generics covariance pitfalls, serialization with
TypeReference/TypeToken
- Generic naming conventions (
T, E, K/V, ?), typesafe heterogeneous containers
- Integration with Records, sealed types, and pattern matching
Scope: The reference is organized by examples (good/bad code patterns) for each core area. Apply recommendations based on applicable examples.
Constraints
Before applying any generics changes, ensure the project compiles. If compilation fails, stop immediately — do not proceed until resolved. After applying improvements, run full verification.
- MANDATORY: Run
./mvnw compile or mvn compile before applying any change
- SAFETY: If compilation fails, stop immediately and do not proceed — compilation failure is a blocking condition
- VERIFY: Run
./mvnw clean verify or mvn clean verify after applying improvements
- BEFORE APPLYING: Read the reference for detailed examples, good/bad patterns, and constraints
- EDGE CASE: If request scope is ambiguous, stop and ask a clarifying question before applying changes
- EDGE CASE: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance
When to use this skill
- Improve the code with Generics
- Apply Generics
- Refactor the code with Generics
Workflow
- Compile project before generics changes
Run ./mvnw compile or mvn compile and stop immediately if compilation fails.
- Read generics reference and assess type safety
Read references/128-java-generics.md and identify raw types, unsafe casts, wildcard misuse, and API variance opportunities.
- Apply generics refactorings
Implement selected generic type and API improvements while preserving behavior.
- Verify with full build
Run ./mvnw clean verify or mvn clean verify after applying improvements.
Reference
For detailed guidance, examples, and constraints, see references/128-java-generics.md.
1---2name: 128-java-generics3description: Use when you need to review, improve, or refactor Java code for generics quality — including avoiding raw types, applying the PECS (Producer Extends Consumer Super) principle for wildcards, using bounded type parameters, designing effective generic methods, leveraging the diamond operator, understanding type erasure implications, handling generic inheritance correctly, preventing heap pollution with @SafeVarargs, and integrating generics with modern Java features like Records, sealed types, and pattern matching. This should trigger for requests such as Improve the code with Generics; Apply Generics; Refactor the code with Generics. Part of cursor-rules-java project4license: Apache-2.05---6# Java Generics Best Practices
7
8Review and improve Java code using comprehensive generics best practices that enforce compile-time type safety and enable flexible, reusable APIs.
9
10**What is covered in this Skill?**
11
12- Type safety: avoiding raw types, eliminating unsafe casts
13- Code reusability: generic methods and types for multiple type contexts
14- PECS wildcards: `? extends` for producers, `? super` for consumers
15- Diamond operator for type inference
16- Type erasure awareness: type tokens, factory patterns, array creation
17- Generic inheritance and variance: invariance, covariance, contravariance
18- `@SafeVarargs` for heap pollution prevention
19- Wildcard capture helpers, self-bounded generics (CRTP) for fluent builders
20- Proper wildcard API design: `Comparator<? super T>`, `Function<? super T, ? extends R>`
21- Arrays-vs-generics covariance pitfalls, serialization with `TypeReference`/`TypeToken`
22- Generic naming conventions (`T`, `E`, `K/V`, `?`), typesafe heterogeneous containers
23- Integration with Records, sealed types, and pattern matching
24
25**Scope:** The reference is organized by examples (good/bad code patterns) for each core area. Apply recommendations based on applicable examples.
26
27## Constraints
28
29Before applying any generics changes, ensure the project compiles. If compilation fails, stop immediately — do not proceed until resolved. After applying improvements, run full verification.
30
31- **MANDATORY**: Run `./mvnw compile` or `mvn compile` before applying any change
32- **SAFETY**: If compilation fails, stop immediately and do not proceed — compilation failure is a blocking condition
33- **VERIFY**: Run `./mvnw clean verify` or `mvn clean verify` after applying improvements
34- **BEFORE APPLYING**: Read the reference for detailed examples, good/bad patterns, and constraints
35- **EDGE CASE**: If request scope is ambiguous, stop and ask a clarifying question before applying changes
36- **EDGE CASE**: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance
37
38## When to use this skill
39
40- Improve the code with Generics
41- Apply Generics
42- Refactor the code with Generics
43
44## Workflow
45
461. **Compile project before generics changes**
47
48Run `./mvnw compile` or `mvn compile` and stop immediately if compilation fails.
49
502. **Read generics reference and assess type safety**
51
52Read `references/128-java-generics.md` and identify raw types, unsafe casts, wildcard misuse, and API variance opportunities.
53
543. **Apply generics refactorings**
55
56Implement selected generic type and API improvements while preserving behavior.
57
584. **Verify with full build**
59
60Run `./mvnw clean verify` or `mvn clean verify` after applying improvements.
61
62## Reference
63
64For detailed guidance, examples, and constraints, see [references/128-java-generics.md](references/128-java-generics.md).
majiayu000