> For the complete documentation index, see [llms.txt](https://www.pranaypourkar.co.in/the-programmers-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.pranaypourkar.co.in/the-programmers-guide/java/java-basics/java-data-types/others/enum/enumset-and-enummap.md). # EnumSet and EnumMap ## **EnumSet** `EnumSet` is a **Set** implementation specifically designed for use with **enum types**. It is a highly optimized collection that is more efficient than `HashSet` when dealing with enums. ### **Features of `EnumSet`** * **Specialized for Enums**: It can only store enum values. * **Efficient**: It uses bit vectors internally, making it much faster and more memory efficient than `HashSet` when working with enums. * **No Null Values**: It does not allow `null` elements. Attempting to add `null` will throw a `NullPointerException`. * **Order**: The order of the enum constants in the `EnumSet` is determined by their **natural order** (the order in which the constants are declared in the enum class). We can also use a specific ordering by providing a comparator. ```java import java.util.EnumSet; public enum LogLevel { ERROR, WARNING, INFO, DEBUG; } public class EnumSetExample { public static void main(String[] args) { // Create an EnumSet containing some enum constants EnumSet logLevels = EnumSet.of(LogLevel.ERROR, LogLevel.WARNING); // Print the EnumSet System.out.println("Log levels: " + logLevels); // Add more values logLevels.add(LogLevel.INFO); System.out.println("After adding INFO: " + logLevels); // Remove a value logLevels.remove(LogLevel.WARNING); System.out.println("After removing WARNING: " + logLevels); // Create an EnumSet with all values EnumSet allLogLevels = EnumSet.allOf(LogLevel.class); System.out.println("All log levels: " + allLogLevels); } } ``` ```less Log levels: [ERROR, WARNING] After adding INFO: [ERROR, WARNING, INFO] After removing WARNING: [ERROR, INFO] All log levels: [ERROR, WARNING, INFO, DEBUG] ``` ### **Methods in `EnumSet`:** * **`EnumSet.of(E... elements)`**: Creates an `EnumSet` with the specified enum constants. * **`EnumSet.allOf(Class elementType)`**: Creates an `EnumSet` containing all constants of the specified enum class. * **`EnumSet.noneOf(Class elementType)`**: Creates an empty `EnumSet`. * **`EnumSet.copyOf(Collection c)`**: Creates an `EnumSet` containing all of the elements in the specified collection that are also enum constants of the same type. ## **EnumMap** `EnumMap` is a **Map** implementation that uses **enum constants** as keys. It is optimized for use with enums as keys and provides superior performance over regular `HashMap` when the keys are enums. ### **Features of `EnumMap`:** * **Specialized for Enums**: The keys in an `EnumMap` must be enum constants. * **Efficient**: It is faster and uses less memory than a `HashMap` when the keys are enums, because it internally stores the mappings in an array, making lookups and insertions much faster. * **Ordering**: The map is **ordered** based on the natural order of the enum constants (the order in which the constants are defined). * **Null Keys Not Allowed**: It does not allow `null` keys. However, `null` values are allowed. ```java import java.util.EnumMap; public enum LogLevel { ERROR, WARNING, INFO, DEBUG; } public class EnumMapExample { public static void main(String[] args) { // Create an EnumMap where the key is LogLevel, and the value is a description EnumMap logLevelDescriptions = new EnumMap<>(LogLevel.class); // Add entries to the EnumMap logLevelDescriptions.put(LogLevel.ERROR, "Critical error"); logLevelDescriptions.put(LogLevel.WARNING, "Warning message"); logLevelDescriptions.put(LogLevel.INFO, "Informational message"); // Print the EnumMap System.out.println("Log level descriptions: " + logLevelDescriptions); // Retrieve a value System.out.println("INFO level description: " + logLevelDescriptions.get(LogLevel.INFO)); } } ``` ```vbnet Log level descriptions: {ERROR=Critical error, WARNING=Warning message, INFO=Informational message} INFO level description: Informational message ``` ### **Methods in `EnumMap`:** * **`EnumMap(Class keyType)`**: Creates an empty `EnumMap` with the specified enum type as the key. * **`EnumMap.put(K key, V value)`**: Adds a key-value pair to the map. * **`EnumMap.get(Object key)`**: Retrieves the value associated with the given key. * **`EnumMap.remove(Object key)`**: Removes the entry for the specified key. ## Comparison of `EnumSet` vs `EnumMap`:
FeatureEnumSetEnumMap
TypeA Set of enum valuesA Map where keys are enum values
Null HandlingDoes not allow null elementsDoes not allow null keys, but allows null values
UsageUsed when you need a collection of enum values without duplicatesUsed when you need to associate values with enum constants
EfficiencyMore memory-efficient and faster than HashSetMore memory-efficient and faster than HashMap for enums as keys
OrderingFollows the natural order of enum constantsFollows the natural order of enum constants
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://www.pranaypourkar.co.in/the-programmers-guide/java/java-basics/java-data-types/others/enum/enumset-and-enummap.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.