Überschreiben Sie valueof() und toString() in Java-Enum

Die Werte in meiner enum sind Wörter, die Leerzeichen enthalten müssen, aber Aufzählungen können keine Leerzeichen in ihren Werten enthalten, also ist alles gebündelt. Ich möchte überschreiben toString() um diese Leerzeichen hinzuzufügen, wo ich es sage.

Ich möchte auch, dass die Aufzählung die richtige Aufzählung liefert, wenn ich sie verwende valueOf() auf der gleichen Zeichenfolge, der ich die Leerzeichen hinzugefügt habe.

Zum Beispiel:

public enum RandomEnum
{
     StartHere,
     StopHere
}

Anruf toString() an RandomEnum dessen Wert ist StartHere gibt Zeichenfolge zurück "Start Here". Anruf valueof() auf derselben Saite ("Start Here") gibt den Aufzählungswert zurück StartHere.

Wie kann ich das machen?

Sie können diesen Code ausprobieren. Da kann man nicht überschreiben valueOf Methode müssen Sie eine benutzerdefinierte Methode definieren (getEnum im Beispielcode unten), der den benötigten Wert zurückgibt, und ändern Sie Ihren Client so, dass er stattdessen diese Methode verwendet.

public enum RandomEnum {

    StartHere("Start Here"),
    StopHere("Stop Here");

    private String value;

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

    public String getValue() {
        return value;
    }

    @Override
    public String toString() {
        return this.getValue();
    }

    public static RandomEnum getEnum(String value) {
        for(RandomEnum v : values())
            if(v.getValue().equalsIgnoreCase(value)) return v;
        throw new IllegalArgumentException();
    }
}

Probieren Sie es aus, aber ich bin mir nicht sicher, ob das überall funktioniert 🙂

public enum MyEnum {
    A("Start There"),
    B("Start Here");

    MyEnum(String name) {
        try {
            Field fieldName = getClass().getSuperclass().getDeclaredField("name");
            fieldName.setAccessible(true);
            fieldName.set(this, name);
            fieldName.setAccessible(false);
        } catch (Exception e) {}
    }
}

Sie können eine statische Map in Ihrer Aufzählung verwenden, die Strings auf Aufzählungskonstanten abbildet. Verwenden Sie es in einer statischen ‘getEnum’-Methode. Dadurch entfällt die Notwendigkeit, die Aufzählungen jedes Mal zu durchlaufen, wenn Sie eine aus ihrem String-Wert abrufen möchten.

public enum RandomEnum {

    StartHere("Start Here"),
    StopHere("Stop Here");

    private final String strVal;
    private RandomEnum(String strVal) {
        this.strVal = strVal;
    }

    public static RandomEnum getEnum(String strVal) {
        if(!strValMap.containsKey(strVal)) {
            throw new IllegalArgumentException("Unknown String Value: " + strVal);
        }
        return strValMap.get(strVal);
    }

    private static final Map<String, RandomEnum> strValMap;
    static {
        final Map<String, RandomEnum> tmpMap = Maps.newHashMap();
        for(final RandomEnum en : RandomEnum.values()) {
            tmpMap.put(en.strVal, en);
        }
        strValMap = ImmutableMap.copyOf(tmpMap);
    }

    @Override
    public String toString() {
        return strVal;
    }
}

Stellen Sie einfach sicher, dass die statische Initialisierung der Karte unterhalb der Deklaration der Enum-Konstanten erfolgt.

Übrigens – dieser Typ “ImmutableMap” stammt von der Google-Guava-API, und ich empfehle ihn auf jeden Fall in solchen Fällen.

BEARBEITEN – Gemäß den Kommentaren:

1. Diese Lösung geht davon aus, dass jeder zugewiesene Zeichenfolgenwert eindeutig und nicht null ist. Angesichts der Tatsache, dass der Ersteller der Aufzählung dies steuern kann und die Zeichenfolge dem eindeutigen und Nicht-Null-Aufzählungswert entspricht, scheint dies eine sichere Einschränkung zu sein.
2. Ich habe die Methode ‚toSTring()‘ hinzugefügt, wie in der Frage verlangt

Wie wäre es mit einer Java 8 Implementierung? (Null kann durch Ihre Standard-Enum ersetzt werden)

public static RandomEnum getEnum(String value) {
    return Arrays.stream(RandomEnum.values()).filter(m -> m.value.equals(value)).findAny().orElse(null);
}

Oder Sie könnten verwenden:

...findAny().orElseThrow(NotFoundException::new);

Ich glaube nicht, dass Sie valueOf (“Start Here”) zum Laufen bringen werden. Aber was Leerzeichen angeht … versuchen Sie Folgendes …

static private enum RandomEnum {
    R("Start There"), 
    G("Start Here"); 
    String value;
    RandomEnum(String s) {
        value = s;
    }
}

System.out.println(RandomEnum.G.value);
System.out.println(RandomEnum.valueOf("G").value);

Start Here
Start Here

Das Folgende ist eine nette generische Alternative zu valueOf()

public static RandomEnum getEnum(String value) {
  for (RandomEnum re : RandomEnum.values()) {
    if (re.description.compareTo(value) == 0) {
      return re;
    }
  }
  throw new IllegalArgumentException("Invalid RandomEnum value: " + value);
}

Sie haben immer noch die Möglichkeit, dies in Ihrer Aufzählung zu implementieren:

public static <T extends Enum<T>> T valueOf(Class<T> enumType, String name){...}