- Java Enum with Strings
- Java enum get all constants
- Constructor Summary
- Method Summary
- Methods declared in class java.lang.Object
- Constructor Detail
- Enum
- Method Detail
- name
- ordinal
- toString
- equals
- hashCode
- clone
- compareTo
- getDeclaringClass
- valueOf
- finalize
- Java Enums
- Example
- Enum inside a Class
- Example
- Enum in a Switch Statement
- Example
- Loop Through an Enum
- Example
- Difference between Enums and Classes
- Why And When To Use Enums?
Java Enum with Strings
In this guide to Java enum with string values, learn to create enum using strings, iterate over all enum values, get enum value and perform a reverse lookup to find an enum by string parameter.
We should always create enum when we have a fixed set of related constants. Enums are inherently singleton, so they provide better performance.
1. Creating Enum with Strings
Java program to create an enum with strings. The given enum contains deployment environments and their respective URLs. URLs are passed to the enum constructor for each enum constant.
public enum Environment < PROD("https://prod.domain.com:1088/"), SIT("https://sit.domain.com:2019/"), CIT("https://cit.domain.com:8080/"), DEV("https://dev.domain.com:21323/"); private String url; Environment(String envUrl) < this.url = envUrl; >public String getUrl() < return url; >>
2. Iterating over Enum Constants
To iterate over enum list, use values() method on enum type which returns all enum constants in an array.
//Get all enums for(Environment env : Environment.values())
PROD :: https://prod.domain.com:1088/ SIT :: https://sit.domain.com:2019/ CIT :: https://cit.domain.com:8080/ DEV :: https://dev.domain.com:21323/
To get a single enum value (e.g., get production URL from enum constant), use the getUrl() method that we created.
String prodUrl = Environment.PROD.getUrl(); System.out.println(prodUrl);
If we want to get enum constant using its name, then we should use valueOf() method.
Environment sitUrl = Environment.valueOf("SIT"); System.out.println(sitUrl.getUrl());
5. Reverse Lookup – Get Enum Name from Value
We will often have the value of enum with us, and we will need to get the enum name by its value. This is achieved using a reverse lookup.
enum Environment < PROD("https://prod.domain.com:1088/"), SIT("https://sit.domain.com:2019/"), CIT("https://cit.domain.com:8080/"), DEV("https://dev.domain.com:21323/"); private String url; Environment(String envUrl) < this.url = envUrl; >public String getUrl() < return url; >//****** Reverse Lookup ************// public static Optional get(String url) < return Arrays.stream(Environment.values()) .filter(env ->env.url.equals(url)) .findFirst(); > >
To use the reverse lookup in the application code, use enum.get() method.
String url = "https://sit.domain.com:2019/"; Optional env = Environment.get(url); System.out.println(env.get());
Java enum get all constants
This is the common base class of all Java language enumeration types. More information about enums, including descriptions of the implicitly declared methods synthesized by the compiler, can be found in section 8.9 of The Java™ Language Specification . Note that when using an enumeration type as the type of a set or as the type of the keys in a map, specialized and efficient set and map implementations are available.
Constructor Summary
Method Summary
Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
Methods declared in class java.lang.Object
Constructor Detail
Enum
Sole constructor. Programmers cannot invoke this constructor. It is for use by code emitted by the compiler in response to enum type declarations.
Method Detail
name
Returns the name of this enum constant, exactly as declared in its enum declaration. Most programmers should use the toString() method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.
ordinal
Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures, such as EnumSet and EnumMap .
toString
Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn’t necessary or desirable. An enum type should override this method when a more «programmer-friendly» string form exists.
equals
hashCode
public final int hashCode()
clone
protected final Object clone() throws CloneNotSupportedException
Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their «singleton» status.
compareTo
Compares this enum with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Enum constants are only comparable to other enum constants of the same enum type. The natural order implemented by this method is the order in which the constants are declared.
getDeclaringClass
Returns the Class object corresponding to this enum constant’s enum type. Two enum constants e1 and e2 are of the same enum type if and only if e1.getDeclaringClass() == e2.getDeclaringClass(). (The value returned by this method may differ from the one returned by the Object.getClass() method for enum constants with constant-specific class bodies.)
valueOf
public static Enum> T valueOf(Class enumType, String name)
Returns the enum constant of the specified enum type with the specified name. The name must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Note that for a particular enum type T , the implicitly declared public static T valueOf(String) method on that enum may be used instead of this method to map from a name to the corresponding enum constant. All the constants of an enum type can be obtained by calling the implicit public static T[] values() method of that type.
finalize
protected final void finalize()
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2023, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.
Java Enums
An enum is a special «class» that represents a group of constants (unchangeable variables, like final variables).
To create an enum , use the enum keyword (instead of class or interface), and separate the constants with a comma. Note that they should be in uppercase letters:
Example
You can access enum constants with the dot syntax:
Enum is short for «enumerations», which means «specifically listed».
Enum inside a Class
You can also have an enum inside a class:
Example
public class Main < enum Level < LOW, MEDIUM, HIGH >public static void main(String[] args) < Level myVar = Level.MEDIUM; System.out.println(myVar); >>
Enum in a Switch Statement
Enums are often used in switch statements to check for corresponding values:
Example
enum Level < LOW, MEDIUM, HIGH >public class Main < public static void main(String[] args) < Level myVar = Level.MEDIUM; switch(myVar) < case LOW: System.out.println("Low level"); break; case MEDIUM: System.out.println("Medium level"); break; case HIGH: System.out.println("High level"); break; >> >
Loop Through an Enum
The enum type has a values() method, which returns an array of all enum constants. This method is useful when you want to loop through the constants of an enum:
Example
for (Level myVar : Level.values())
Difference between Enums and Classes
An enum can, just like a class , have attributes and methods. The only difference is that enum constants are public , static and final (unchangeable — cannot be overridden).
An enum cannot be used to create objects, and it cannot extend other classes (but it can implement interfaces).
Why And When To Use Enums?
Use enums when you have values that you know aren’t going to change, like month days, days, colors, deck of cards, etc.