Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jdereg committed Jan 9, 2025
1 parent 476c3ce commit f8c31b0
Showing 1 changed file with 0 additions and 21 deletions.
21 changes: 0 additions & 21 deletions userguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,24 +126,3 @@ System.out.println(mixedSet); // Outputs: [Apple, 123]
- String comparisons are case-insensitive but preserve original case
- Set operations use the underlying `CaseInsensitiveMap` for consistent behavior
- Maintains proper `Set` contract while providing case-insensitive functionality for strings

### Best Practices

1. **Choose Appropriate Constructor**
- Use default constructor for general use
- Specify initial capacity when approximate size is known
- Use collection constructor to maintain specific ordering or concurrency properties

2. **Performance Considerations**
- Consider backing map selection for concurrent access needs
- Initialize with appropriate capacity to minimize resizing
- Use appropriate load factor for memory/performance trade-offs

3. **Type Safety**
- Prefer homogeneous collections when possible
- Be aware of case-insensitive behavior when mixing String and non-String elements

### Related Components
- `CaseInsensitiveMap`: The underlying map implementation used by this set
- `ConcurrentSet`: For concurrent access needs
- `TreeMap`: For sorted set behavior

0 comments on commit f8c31b0

Please sign in to comment.