HOWTO · Java

Énumération en chaîne de caractères en Java

Ce tutoriel explique deux méthodes de la classe enum pour convertir l'enum en chaîne de caractères en Java.

Sur cette page

Une énumération définit un ensemble fixe de constantes nommées. Chaque constante est une instance de son type d’énumération, et Java fournit des méthodes pour obtenir une représentation sous forme de chaîne. La méthode à choisir dépend de votre besoin : obtenir l’identifiant exact déclaré dans le code source ou un texte destiné à l’affichage.

Convertir une constante d’énumération avec name()

Appelez name() sur une constante lorsque vous avez besoin de son identifiant déclaré exact. Par exemple, Directions.WEST.name() renvoie la chaîne WEST. La valeur renvoyée conserve l’orthographe et la casse utilisées dans la déclaration de l’énumération. name() est final : une énumération ne peut donc pas modifier ce résultat en redéfinissant cette méthode.

Cette méthode est utile lorsque le code a besoin de l’identifiant lui-même, par exemple pour comparer une valeur au nom d’une constante connue. Gardez à l’esprit que renommer la constante change la chaîne renvoyée par name(). Si le texte est destiné à être lu par des personnes, un identifiant comme NORTH_EAST ne correspondra peut-être pas à la formulation que vous souhaitez afficher.

Convertir une constante d’énumération avec toString()

L’appel de toString() renvoie également une chaîne. Pour une énumération qui ne redéfinit pas cette méthode, le résultat par défaut est le nom de la constante : Directions.WEST.toString() renvoie donc WEST. Contrairement à name(), toString() peut être redéfinie par l’énumération pour renvoyer un autre texte.

Choisissez selon le sens que doit avoir la valeur. Utilisez name() lorsque l’identifiant déclaré importe ; utilisez toString() lorsque la représentation sous forme de chaîne choisie par l’énumération convient à l’appelant. Aucune de ces options n’est automatiquement préférable dans tous les cas. Si un autre programme ou un format stocké dépend d’un identifiant stable, définissez et gérez explicitement ce format au lieu de supposer que le texte d’affichage ne changera jamais.

Redéfinir toString() pour obtenir un texte personnalisé

Une énumération peut associer une chaîne à chaque constante au moyen d’un constructeur, puis renvoyer cette valeur dans une méthode toString() redéfinie. Le code peut ainsi conserver des identifiants concis comme USD tout en affichant un texte plus explicite, comme US dollars. Chaque constante reçoit sa propre valeur lors de la déclaration de l’énumération.

Dans l’exemple ci-dessous, name() continue de renvoyer l’identifiant déclaré, tandis que toString() renvoie le libellé personnalisé. Cette distinction est utile dans les journaux ou dans les textes destinés aux utilisateurs, lorsque la formulation choisie convient. Comme les appels à toString() renvoient la valeur personnalisée, le code qui a spécifiquement besoin de USD doit plutôt appeler name().

Afficher chaque constante d’énumération sous forme de chaîne

Java fournit une méthode values() générée pour chaque type d’énumération. Elle renvoie un tableau contenant les constantes de ce type dans leur ordre de déclaration ; ce n’est pas une méthode héritée de Enum. Parcourez ce tableau pour traiter chaque valeur. La concaténation d’une constante d’énumération avec du texte appelle sa méthode toString() : la boucle ci-dessous affiche donc les libellés personnalisés.

Exécutez cet exemple complet pour comparer les noms exacts, les chaînes par défaut, les textes d’affichage personnalisés et toutes les constantes monétaires. Les libellés et les résultats de l’exemple restent en anglais, car les blocs de code et de sortie sont conservés à l’identique :

public class EnumToString {
    enum Directions {
        NORTH, SOUTH, EAST, WEST
    }

    enum PlainCurrencies {
        USD, YEN, EUR, INR
    }

    enum Currencies {
        USD("US dollars"),
        YEN("Japanese yen"),
        EUR("euros"),
        INR("Indian rupees");

        private final String displayText;

        Currencies(String displayText) {
            this.displayText = displayText;
        }

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

    public static void main(String[] args) {
        System.out.println(Directions.WEST.name());
        System.out.println(PlainCurrencies.USD.toString());
        System.out.println(Currencies.INR.name());
        System.out.println(Currencies.INR.toString());

        for (Currencies currency : Currencies.values()) {
            System.out.println(currency);
        }
    }
}
WEST
USD
INR
Indian rupees
US dollars
Japanese yen
euros
Indian rupees