112-java-type-design

Type Design Thinking in Java

Type design thinking in Java applies typography principles to code structure and organization. Just as typography creates readable, accessible text, thoughtful type design in Java produces maintainable, comprehensible code.

Implementing These Principles

1. Start with domain modeling: Sketch your type system before coding.
2. Create a type style guide: Document naming conventions and patterns.
3. Review for type consistency: Periodically check for style adherence.
4. Refactor toward clearer type expressions: Improve existing code.
5. Use tools to enforce style: Configure linters and static analyzers.

Remember, good type design in Java is about communication - making your code's intent clear both to the compiler and to other developers.

Table of contents

• Rule 1: Establish a Clear Type Hierarchy
• Rule 2: Use Consistent Naming Conventions (Your Type's "Font Family")
• Rule 3: Embrace Whitespace (Kerning and Leading)
• Rule 4: Create Type-Safe Wrappers (Type as Communication)
• Rule 5: Leverage Generic Type Parameters (Responsive Typography)
• Rule 6: Create Domain-Specific Languages (Typography with Character)
• Rule 7: Use Consistent Type "Weights" (Bold, Regular, Light)
• Rule 8: Apply Type Contrast Through Interfaces
• Rule 9: Create Type Alignment Through Method Signatures
• Rule 10: Design for Clear Type Readability and Comprehension
• Rule 11: Use BigDecimal for Precision-Sensitive Calculations
• Rule 12: Strategic Type Selection for Methods and Algorithms

Rule 1: Establish a Clear Type Hierarchy

Title: Establish a Clear Type Hierarchy Description: This rule focuses on organizing classes and interfaces into a logical structure using inheritance and composition. A clear hierarchy makes the relationships between types explicit, improving code navigation and understanding. It often involves using nested static classes for closely related types.

Good example:

// GOOD: Clear type hierarchy with descriptive names
public class OrderManagement {
    public static class Order {
        private List<OrderItem> items;
        private Customer customer;
        // ...
    }

    public static class OrderItem {
        private Product product;
        private int quantity;
        // ...
    }
}