¿Cómo obtener un valor de enumeración de un valor de cadena en Java?

Question

Digamos que tengo una enumeración que es solo

public enum Blah {
    A, B, C, D
}

y me gustaría encontrar el valor de enumeración de una cadena, por ejemplo " A " que sería Blah.A . ¿Cómo sería posible hacer esto?

¿Es el Enum.valueOf () el método que necesito? Si es así, ¿cómo usaría esto?

Answer 1

Sí, Blah.valueOf (" A ") te dará Blah.A .

Tenga en cuenta que el nombre debe coincidir con exacto , incluido el caso: Blah.valueOf (" a ") y Blah.valueOf (" A ") ambos lanzan una IllegalArgumentException .

Los métodos estáticos valueOf () y values ??() se crean en el momento de la compilación y no aparecen en el código fuente. Sin embargo, sí aparecen en Javadoc; por ejemplo, Dialog.ModalityType muestra ambos métodos.

Answer 2

Otra solución si el texto no coincide con el valor de enumeración:

public enum Blah {
    A("text1"),
    B("text2"),
    C("text3"),
    D("text4");

    private String text;

    Blah(String text) {
        this.text = text;
    }

    public String getText() {
        return this.text;
    }

    public static Blah fromString(String text) {
        for (Blah b : Blah.values()) {
            if (b.text.equalsIgnoreCase(text)) {
                return b;
            }
        }
        return null;
    }
}

Answer 3

Aquí hay una ingeniosa utilidad que uso:

/**
 * A common method for all enums since they can't have another base class
 * @param <T> Enum type
 * @param c enum type. All enums must be all caps.
 * @param string case insensitive
 * @return corresponding enum, or null
 */
public static <T extends Enum<T>> T getEnumFromString(Class<T> c, String string) {
    if( c != null && string != null ) {
        try {
            return Enum.valueOf(c, string.trim().toUpperCase());
        } catch(IllegalArgumentException ex) {
        }
    }
    return null;
}

Luego, en mi clase de enumeración, generalmente tengo esto para guardar algo de escritura:

public static MyEnum fromString(String name) {
    return getEnumFromString(MyEnum.class, name);
}

Si sus enumeraciones no son todas mayúsculas, solo cambie la línea Enum.valueOf .

Lástima que no pueda usar T.class para Enum.valueOf ya que T se borra.

Answer 4

También debes tener cuidado con tu caso. Permítanme explicar: hacer Blah.valueOf (" A ") funciona, pero Blah.valueOf (" a ") no funcionará. Luego, nuevamente Blah.valueOf (" a " .toUpperCase (Locale.ENGLISH)) funcionará.

editar
Se cambió toUpperCase a toUpperCase (Locale.ENGLISH) basado en tc. comentar y el documentos java

edit2 En Android, debe usar Locale.US , como sulai señala .

Answer 5

Utilice el patrón de Joshua Bloch, Eficaz Java :

(simplificado por brevedad)

enum MyEnum {
    ENUM_1("A"),
    ENUM_2("B");

    private String name;

    private static final Map<String,MyEnum> ENUM_MAP;

    MyEnum (String name) {
        this.name = name;
    }

    public String getName() {
        return this.name;
    }

    // Build an immutable map of String name to enum pairs.
    // Any Map impl can be used.

    static {
        Map<String,MyEnum> map = new ConcurrentHashMap<String, MyEnum>();
        for (MyEnum instance : MyEnum.values()) {
            map.put(instance.getName(),instance);
        }
        ENUM_MAP = Collections.unmodifiableMap(map);
    }

    public static MyEnum get (String name) {
        return ENUM_MAP.get(name);
    }
}

También vea:

Ejemplo de Oracle Java utilizando Enum y el Mapa de instancias

Orden de ejecución de de bloques estáticos en un tipo Enum

¿Cómo puedo buscar una enumeración de Java? desde su valor de cadena

Answer 6

Aquí hay un método que puede hacerlo para cualquier Enum, y no distingue entre mayúsculas y minúsculas.

/** 
 * Finds the value of the given enumeration by name, case-insensitive. 
 * Throws an IllegalArgumentException if no match is found.  
 **/
public static <T extends Enum<T>> T valueOfIgnoreCase(
        Class<T> enumeration, String name) {

    for (T enumValue : enumeration.getEnumConstants()) {
        if (enumValue.name().equalsIgnoreCase(name)) {
            return enumValue;
        }
    }

    throw new IllegalArgumentException(String.format(
        "There is no value with name '%s' in Enum %s",
        name, enumeration.getName()
    ));
}

Answer 7

Utilizar Blah.valueOf (cadena) es mejor, pero también puede usar Enum.valueOf (Blah.class, cadena) .

Answer 8

Si no desea escribir su propia utilidad, use biblioteca de guayaba :

Enums.getIfPresent(Blah.class, "A")

A diferencia de la función Java incorporada, le permite comprobar si A está presente en Blah y no arroja una excepción.

Answer 9

Mis 2 centavos aquí: usando Java8 Streams + comprobando una cadena exacta:

public enum MyEnum {
    VALUE_1("Super"),
    VALUE_2("Rainbow"),
    VALUE_3("Dash"),
    VALUE_3("Rocks");

    private final String value;

    MyEnum(String value) {
        this.value = value;
    }

    /**
     * @return the Enum representation for the given string.
     * @throws IllegalArgumentException if unknown string.
     */
    public static MyEnum fromString(String s) throws IllegalArgumentException {
        return Arrays.stream(MyEnum.values())
                .filter(v -> v.value.equals(s))
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException("unknown value: " + s));
    }
}

** EDIT ** **

Cambió el nombre de la función a fromString () desde que le asignó un nombre usando esa convención, obtendrá algunos beneficios del lenguaje Java en sí; por ejemplo:

1. Conversión directa de tipos en la anotación HeaderParam

Answer 10

En Java 8 o posterior, usa Streams :

public enum Blah
{
    A("text1"),
    B("text2"),
    C("text3"),
    D("text4");

    private String text;

    Blah(String text) {
        this.text = text;
    }

    public String getText() {
        return this.text;
    }

    public static Optional<Blah> fromText(String text) {
        return Arrays.stream(values())
          .filter(bl -> bl.text.equalsIgnoreCase(text))
          .findFirst();
    }
}

Answer 11

Puede que necesites esto:

public enum ObjectType {
    PERSON("Person");

    public String parameterName;

    ObjectType(String parameterName) {
        this.parameterName = parameterName;
    }

    public String getParameterName() {
        return this.parameterName;
    }

    //From String method will return you the Enum for the provided input string
    public static ObjectType fromString(String parameterName) {
        if (parameterName != null) {
            for (ObjectType objType : ObjectType.values()) {
                if (parameterName.equalsIgnoreCase(objType.parameterName)) {
                    return objType;
                }
            }
        }
        return null;
    }
}

Una adición más:

   public static String fromEnumName(String parameterName) {
        if (parameterName != null) {
            for (DQJ objType : DQJ.values()) {
                if (parameterName.equalsIgnoreCase(objType.name())) {
                    return objType.parameterName;
                }
            }
        }
        return null;
    }

Esto le devolverá el Valor por un Nombre de enumeración Stringified para, p. si proporciona " PERSONA " en el fromEnumName le devolverá el valor de Enum, es decir, " Persona "

Answer 12

Otra forma de hacerlo mediante el método estático implícito name () de Enum. nombre devolverá la cadena exacta utilizada para crear esa enumeración que se puede usar para verificar la cadena proporcionada:

public enum Blah {

    A, B, C, D;

    public static Blah getEnum(String s){
        if(A.name().equals(s)){
            return A;
        }else if(B.name().equals(s)){
            return B;
        }else if(C.name().equals(s)){
            return C;
        }else if (D.name().equals(s)){
            return D;
        }
        throw new IllegalArgumentException("No Enum specified for this string");
    }
}

Pruebas:

System.out.println (Blah.getEnum (" B "). name ());

//it will print B  B

inspiración: 10 ejemplos de Enum en Java

Answer 13

Solución utilizando bibliotecas de guayaba. El método getPlanet () no distingue entre mayúsculas y minúsculas, por lo que getPlanet (" MerCUrY ") devolverá Planet.MERCURY.

package com.universe.solarsystem.planets;
import org.apache.commons.lang3.StringUtils;
import com.google.common.base.Enums;
import com.google.common.base.Optional;

//Pluto and Eris are dwarf planets, who cares!
public enum Planet {
   MERCURY,
   VENUS,
   EARTH,
   MARS,
   JUPITER,
   SATURN,
   URANUS,
   NEPTUNE;

   public static Planet getPlanet(String name) {
      String val = StringUtils.trimToEmpty(name).toUpperCase();
      Optional <Planet> possible = Enums.getIfPresent(Planet.class, val);
      if (!possible.isPresent()) {
         throw new IllegalArgumentException(val + "? There is no such planet!");
      }
      return possible.get();
   }
}

Answer 14

Para agregar a las respuestas anteriores y abordar algunas de las discusiones sobre nulos y NPE, estoy usando Guava Optionals para manejar casos ausentes / inválidos. Esto funciona muy bien para el análisis de URI / parámetros.

public enum E {
    A,B,C;
    public static Optional<E> fromString(String s) {
        try {
            return Optional.of(E.valueOf(s.toUpperCase()));
        } catch (IllegalArgumentException|NullPointerException e) {
            return Optional.absent();
        }
    }
}

Para aquellos que no lo saben, aquí hay más información sobre cómo evitar nulos con Opcional: https: // code.google.com/p/guava-libraries/wiki/UsingAndAvoidingNullExplained#Optional

Answer 15

En Java 8, el patrón de Mapa estático es aún más fácil y es mi método preferido. Si desea utilizar Enum with Jackson, puede anular toString y usar ese nombre en lugar del nombre, luego anotar con @JsonValue

public enum MyEnum {
    BAR,
    BAZ;
    private static final Map<String, MyEnum> MAP = Stream.of(MyEnum.values()).collect(Collectors.toMap(Enum::name, Function.identity()));
    public static MyEnum fromName(String name){
        return MAP.get(name);
    }
}

public enum MyEnumForJson {
    BAR("bar"),
    BAZ("baz");
    private static final Map<String, MyEnumForJson> MAP = Stream.of(MyEnumForJson.values()).collect(Collectors.toMap(Object::toString, Function.identity()));
    private final String value;

    MyEnumForJson(String value) {
        this.value = value;
    }

    @JsonValue
    @Override
    public String toString() {
        return value;
    }

    public static MyEnumForJson fromValue(String value){
        return MAP.get(value);
    }
}

Answer 16

public static MyEnum getFromValue(String value) {
    MyEnum resp = null;
    MyEnum nodes[] = values();
    for(int i = 0; i < nodes.length; i++) {
        if(nodes[i].value.equals(value)) {
            resp = nodes[i];
            break;
        }
    }
    return resp;
}

Answer 17

Método O (1) inspirado en el código generado por ahorro que utiliza un mapa de hash.

public enum USER {
        STUDENT("jon",0),TEACHER("tom",1);

        private static final Map<String, Integer> map = new HashMap<>();

        static {
                for (USER user : EnumSet.allOf(USER.class)) {
                        map.put(user.getTypeName(), user.getIndex());
                }
        }

        public static int findIndexByTypeName(String typeName) {
                return map.get(typeName);
        }

        private USER(String typeName,int index){
                this.typeName = typeName;
                this.index = index;
        }
        private String typeName;
        private int index;
        public String getTypeName() {
                return typeName;
        }
        public void setTypeName(String typeName) {
                this.typeName = typeName;
        }
        public int getIndex() {
                return index;
        }
        public void setIndex(int index) {
                this.index = index;
        }

}

Answer 18

java.lang.Enum define varios métodos útiles, que están disponibles para todo tipo de enumeración en Java:

• Puede usar el método name () para obtener el nombre de las constantes Enum. El literal de cadena utilizado para escribir constantes de enumeración es su nombre.
• De manera similar, el método values ??() se puede utilizar para obtener una matriz de todas las constantes Enum de un tipo Enum.
• Y para la pregunta formulada, puede usar el método valueOf () para convertir cualquier cadena a constante de Enum en Java, como se muestra a continuación.

public class EnumDemo06 {
    public static void main(String args[]) {
        Gender fromString = Gender.valueOf("MALE");
        System.out.println("Gender.MALE.name() : " + fromString.name());
    }

    private enum Gender {
        MALE, FEMALE;
    }
}

Output:
Gender.MALE.name() : MALE

En este fragmento de código, el método valueOf () devuelve una constante Enum Gender.MALE, llamando al nombre que devuelve " MALE " .

Answer 19

La biblioteca commons-lang de Apache tiene una función estática org.apache.commons.lang3.EnumUtils.getEnum que asignará una Cadena a su tipo de Enum. Esencialmente, la misma respuesta que Geoffreys, pero ¿por qué tirar la tuya cuando ya está en la naturaleza?

Answer 20

Agregando a la respuesta mejor calificada, con una útil utilidad ...

valueOf () lanza dos excepciones diferentes en los casos en que no le gusta su entrada.

• IllegalArgumentException
• NullPointerExeption

Si sus requisitos son tales que no tiene ninguna garantía de que su String definitivamente coincida con un valor de enumeración, por ejemplo, si los datos de String provienen de una base de datos y podrían contener una versión antigua del enum, entonces necesitará para manejar esto a menudo ...

Este es un método reutilizable que escribí que nos permite definir un Enum predeterminado que se devolverá si la cadena que pasamos no coincide.

private static <T extends Enum<T>> T valueOf( String name , T defaultVal) {
        try {
            return Enum.valueOf(defaultVal.getDeclaringClass() , name);
        } catch (IllegalArgumentException | NullPointerException e) {
            return defaultVal;
        }
    }

Úsalo así:

public enum MYTHINGS {
    THINGONE,
    THINGTWO
}

public static void main(String [] asd) {
  valueOf("THINGTWO" , MYTHINGS.THINGONE);//returns MYTHINGS.THINGTWO
  valueOf("THINGZERO" , MYTHINGS.THINGONE);//returns MYTHINGS.THINGONE
}

Answer 21

¿Qué pasa?

public enum MyEnum {
    FIRST,
    SECOND,
    THIRD;

    public static Optional<MyEnum> fromString(String value){
        try{
            return Optional.of(MyEnum.valueOf(value));
        }catch(Exception e){
            return Optional.empty();
        }
    }
}

Answer 22

Otra utilidad que captura en forma inversa. Usando un valor que identifique ese Enum, no por su nombre.

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.EnumSet;

public class EnumUtil {

    /**
     * Returns the <code>Enum</code> of type <code>enumType</code> whose a 
     * public method return value of this Enum is 
     * equal to <code>valor</code>.<br/>
     * Such method should be unique public, not final and static method 
     * declared in Enum.
     * In case of more than one method in match those conditions
     * its first one will be chosen.
     * 
     * @param enumType
     * @param value
     * @return 
     */
    public static <E extends Enum<E>> E from(Class<E> enumType, Object value) {
        String methodName = getMethodIdentifier(enumType);
        return from(enumType, value, methodName);
    }

    /**
     * Returns the <code>Enum</code> of type <code>enumType</code> whose  
     * public method <code>methodName</code> return is 
     * equal to <code>value</code>.<br/>
     *
     * @param enumType
     * @param value
     * @param methodName
     * @return
     */
    public static <E extends Enum<E>> E from(Class<E> enumType, Object value, String methodName) {
        EnumSet<E> enumSet = EnumSet.allOf(enumType);
        for (E en : enumSet) {
            try {
                String invoke = enumType.getMethod(methodName).invoke(en).toString();
                if (invoke.equals(value.toString())) {
                    return en;
                }
            } catch (Exception e) {
                return null;
            }
        }
        return null;
    }

    private static String getMethodIdentifier(Class<?> enumType) {
        Method[] methods = enumType.getDeclaredMethods();
        String name = null;
        for (Method method : methods) {
            int mod = method.getModifiers();
            if (Modifier.isPublic(mod) && !Modifier.isStatic(mod) && !Modifier.isFinal(mod)) {
                name = method.getName();
                break;
            }
        }
        return name;
    }
}

Ejemplo:

public enum Foo {
    ONE("eins"), TWO("zwei"), THREE("drei");

    private String value;

    private Foo(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}

EnumUtil.from (Foo.class, " drei ") devuelve Foo.THREE , porque usará getValue para hacer coincidir " ; drei '', que es un método público único, no final y no estático en Foo. En caso de que Foo tenga más de un método público, no final y no estático, por ejemplo, getTranslate que devuelve "drei", se puede usar el otro método: EnumUtil.from (Foo. class, " drei " ;, " getTranslate ") .

Answer 23

Como todavía no se ha mencionado la versión switch , la presento (reutilizando la enumeración de OP):

  private enum Blah {
    A, B, C, D;

    public static Blah byName(String name) {
      switch (name) {
        case "A":
          return A;
        case "B":
          return B;
        case "C":
          return C;
        case "D":
          return D;
        default:
          throw new IllegalArgumentException(
            "No enum constant " + Blah.class.getCanonicalName() + "." + name);
      }
    }
  }

Como esto no le da ningún valor adicional al método valueOf (String name) , solo tiene sentido definir un método adicional si queremos tener un comportamiento diferente. Si no queremos generar una IllegalArgumentException , podemos cambiar la implementación a:

  private enum Blah {
    A, B, C, D;

    public static Blah valueOfOrDefault(String name, Blah defaultValue) {
      switch (name) {
        case "A":
          return A;
        case "B":
          return B;
        case "C":
          return C;
        case "D":
          return D;
        default:
          if (defaultValue == null) {
            throw new NullPointerException();
          }
          return defaultValue;
      }
    }
  }

Al proporcionar un valor predeterminado, mantenemos la contrato de Enum.valueOf (String name) sin lanzar una IllegalArgumentException de esa manera que en no se devuelve ningún caso null . Por lo tanto, lanzamos una NullPointerException si el nombre es null y en el caso de predeterminado si defaultValue es null . Así es como funciona valueOfOrDefault .

Este enfoque adopta el diseño del Map -Interface que proporciona un método Map.getOrDefault (Clave de objeto, V defaultValue) a partir de Java 8.

Answer 24

Me gusta usar este tipo de proceso para analizar comandos como cadenas en enumeraciones. Normalmente tengo una de las enumeraciones como "desconocido" por lo tanto, es útil que se devuelva cuando no se encuentran los otros (incluso en una base que no distingue entre mayúsculas y minúsculas) en lugar de nulo (lo que significa que no hay valor). Por lo tanto, uso este enfoque.

static <E extends Enum<E>> Enum getEnumValue(String what, Class<E> enumClass) {
    Enum<E> unknown=null;
    for (Enum<E> enumVal: enumClass.getEnumConstants()) {  
        if (what.compareToIgnoreCase(enumVal.name()) == 0) {
            return enumVal;
        }
        if (enumVal.name().compareToIgnoreCase("unknown") == 0) {
            unknown=enumVal;
        }
    }  
    return unknown;
}

Answer 25

La forma más rápida de obtener el nombre de enum es crear un mapa de texto y valor de enumeración cuando se inicia la aplicación, y obtener el nombre de llamar a la función Blah.getEnumName ():

public enum Blah {
    A("text1"),
    B("text2"),
    C("text3"),
    D("text4");

    private String text;
    private HashMap<String, String> map;
    Blah(String text) {
    this.text = text;
    }

    public String getText() {
      return this.text;
    }

    static{
      createMapOfTextAndName();
    }

    public static void createMapOfTextAndName() {
        map = new HashMap<String, String>();
        for (Blah b : Blah.values()) {
             map.put(b.getText(),b.toString());
        }
    }
    public static String getEnumName(String text) {
        return map.get(text.toLowerCase());
    } 
}

Answer 26

Enum es muy útil, he estado usando Enum mucho para agregar una descripción para algunos campos en diferentes idiomas, como el siguiente ejemplo:

public enum Status {

    ACT(new String[] { "Accepted", "مقبول" }),
    REJ(new String[] { "Rejected", "مرفوض" }),
    PND(new String[] { "Pending", "في الانتظار" }),
    ERR(new String[] { "Error", "خطأ" }),
    SNT(new String[] { "Sent", "أرسلت" });

    private String[] status;

    public String getDescription(String lang) {
        return lang.equals("en") ? status[0] : status[1];
    }

    Status(String[] status) {
        this.status = status;
    }
}

Y luego puede recuperar la descripción de forma dinámica en el código de idioma pasado al método getDescription (String lang) , por ejemplo:

String statusDescription = Status.valueOf("ACT").getDescription("en");