From f8c31b0abba8001b02d609ad8a974fb9f1796fdf Mon Sep 17 00:00:00 2001 From: John DeRegnaucourt Date: Thu, 9 Jan 2025 01:06:25 -0500 Subject: [PATCH] Javadoc --- userguide.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/userguide.md b/userguide.md index ed5023ba..eb7ce049 100644 --- a/userguide.md +++ b/userguide.md @@ -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 \ No newline at end of file