How To Purpose Enumset Inwards Coffee Amongst Example

EnumSet is 1 of the specialized implementation of Set interface for an enumeration type, introduced inwards Java 1.5 along amongst enumeration type itself. Programmer oftentimes stores Enum into mutual collection classes e.g. HashSet or ArrayList, to a greater extent than oftentimes than non because they are unaware of this petty gem. Even I wasn't aware of this course of didactics few years agone until I come upward across 1 of the finest books for Java programmers, bitwise operator. Since Enum constants are unique too guide hold pre-defined length, every bit you lot tin dismiss non define a novel enum constant at runtime; it allows Java API designer to highly optimize EnumSet.

If you lot await closely, EnumSet too teaches you lot a twosome of proficient blueprint practices to do flexible too maintainable code. For example, EnumSet is an abstract class, too it provides lots of static manufactory method to do an instance of EnumSet e.g. EnumSet.of(...). This method takes wages of method overloading too variable argument to furnish Set of solely provided Enum constants.

Second proficient matter is at that topographic point are ii concrete subclasses of EnumSet e.g. RegularEnumSet and JumboEnumSet, but both are package-private, which way a customer tin dismiss non purpose them directly.

The solely way to purpose them is via EnumSet. At runtime, depending upon the key size of requested Enum, implementation automatically determine which implementation to use. This provides you lot immense flexibility too command to curl out a novel ameliorate version of EnumSet implementation without whatever alter on the customer side.

Anyway, this article is non merely nigh blueprint lessons from this course of didactics but to a greater extent than importantly how too when to purpose EnumSet inwards Java program. I guide hold shared a uncomplicated instance to demonstrate the might of EnumSet, which you lot volition meet inwards adjacent section.

EnumSet Example inwards Java

In this example, nosotros guide hold used basic colours RED, GREEN too BLUE to do a custom color past times using EnumSet. As I said, EnumSet is really proficient for combining effects, whether it's text styles e.g. BOLD and UNDERLINE, every bit described inwards Effective Java, or combining basic colours to do custom color here. If you lot guide hold MS paint, you lot tin dismiss fifty-fifty evidence the combination of colours e.g. you lot tin dismiss combine RED and BLUE to do YELLOW, combine all 3 to do WHITE, or combining RED and BLUE to do PINK.

import java.util.EnumSet; import java.util.Set;  /**  * Simple Java Program to demonstrate how to purpose EnumSet.  * It has about interesting purpose cases too it's specialized collection for  * Enumeration types. Using Enum amongst EnumSet volition hand you lot far ameliorate  * functioning than using Enum amongst HashSet, or LinkedHashSet.  *  * @author Javin Paul  */ populace class EnumSetDemo {      private enum Color {         RED(255, 0, 0), GREEN(0, 255, 0), BLUE(0, 0, 255);         private int r;         private int g;         private int b;         private Color(int r, int g, int b) {             this.r = r;             this.g = g;             this.b = b;         }         populace int getR() {             return r;         }         populace int getG() {             return g;         }         populace int getB() {             return b;         }     }       populace static void main(String args[]) {         // this volition clit trouble inwards yellowish color         EnumSet<Color> yellowish = EnumSet.of(Color.RED, Color.GREEN);         drawLine(yellow);         // RED + GREEN + BLUE = WHITE         EnumSet<Color> white = EnumSet.of(Color.RED, Color.GREEN, Color.BLUE);         drawLine(white);         // RED + BLUE = PINK         EnumSet<Color> pinkish = EnumSet.of(Color.RED, Color.BLUE);         drawLine(pink);     }       populace static void drawLine(Set<Color> colors) {         System.out.println("Requested Colors to clit lines : " + colors);         for (Color c : colors) {             System.out.println("drawing trouble inwards color : " + c);         }     } }  Output: Requested Colors to draw lines : [RED, GREEN] drawing trouble inwards color : RED drawing trouble inwards color : GREEN  Requested Colors to clit lines : [RED, GREEN, BLUE] drawing trouble inwards color : RED drawing trouble inwards color : GREEN drawing trouble inwards color : BLUE  Requested Colors to clit lines : [RED, BLUE] drawing trouble inwards color : RED drawing trouble inwards color : BLUE

Important properties of EnumSet inwards Java

Like whatever other Collection class, EnumSet too has about exceptional properties, which assist you lot to determine when to purpose EnumSet inwards your Java application. Keep a banking concern complaint of these properties, behaviours:

1) EnumSet is a exceptional Set implementation, solely applicable for Enums inwards Java, but you lot tin dismiss solely shop instances of the unmarried enum type. Adding an instance of unlike enum volition final result inwards compile fourth dimension error, every bit EnumSet furnish type-safety.

2) EnumSet internal representation is extremely efficient too represented every bit fleck vectors. Library itself chooses 1 of ii implementations available depending upon the size of a key universe. RegularEnumSet has chosen if a number of instances are less than 64, otherwise JumboEnumSet is used.

3) As described inwards Effective Java, EnumSet tin dismiss last safely used every bit a type-safe choice of traditional int based "bit flags". EnumSet provides much-needed readability, without compromising performance.

4) Iterator returned past times EnumSet traverse the elements inwards their natural order, i.e. the club on which enum constants are declared, or the club returned past times ordinal() method.

5) An EnumSet iterator is weakly consistent too never throws ConcurrentModificationException, too may or may non demo the number of whatever change to the Set piece the iteration is inwards progress.

6) EnumSet is too non synchronized inwards Java. Though if you lot need, you lot tin dismiss brand EnumSet synchronized similar to other collection past times using utility methods from Collections class. Here is how to do that :

Set<YourEnum> s = Collections.synchronizedSet(EnumSet.noneOf(YourEnum.class));

7) EnumSet is an abstract class, which way you lot cannot do its instance using new() operator. This is genuinely carefully idea to furnish exceptional implementation, too that's why EnumSet provides several static manufactory methods for creating instance e.g. noneOf() returns an empty EnumSet amongst specified enum type, EnumSet.of(....) returns Set of specified enum constants too allOf() method creates an enum ready containing all elements of specified enum.

8) EnumSet too provides methods similar complementOf(EnumSet es) too copyOf(EnumSet es) to do EnumSet from other EnumSet, coplementOf() returns enum ready amongst containing all the elements of this type that are non contained inwards the specified set.

That's all nigh EnumSet inwards Java. It's 1 of the useful class, which is perfect for for certain purpose cases, but it too teaches a lot of lesson on course of didactics blueprint too purpose of the package. I genuinely similar how they shielded implementation course of didactics RegularEnumSet too JumboEnumSet too provides manufactory methods to do EnumSet. This way tidings of choosing implementation remains amongst the library itself, past times making both of these classes package-private, at that topographic point is no worry of the customer direct accessing them. You tin dismiss purpose EnumSet to piece of job past times arguments to methods too to do meaningful groups from enum.

Further Learning
Java In-Depth: Become a Complete Java Engineer
Java Fundamentals: Collections
Data Structures too Algorithms: Deep Dive Using Java
Algorithms too Data Structures - Part 1 too 2
Data Structures inwards Java nine past times Heinz Kabutz

Share this post