Java - Enum datatype

> Procedural Languages > Java

1 - About

The enum data type implementation in java

Because they are constants, the names of an enum type's fields are in uppercase letters.

The enum declaration defines a class (called an enum type). The enum class body can include:

  • methods
  • and other fields.
Advertising

3 - Example

  • compass directions (values of NORTH, SOUTH, EAST, and WEST) and the days of the week.
  • days of the week

4 - Definition

An enum type is defined by using the enum keyword.

public enum Day {
    SUNDAY, MONDAY, TUESDAY, WEDNESDAY, 
    THURSDAY, FRIDAY, SATURDAY 
}

5 - Instantiation

An enum type has no instances other than those defined by its enum constants. It is a compile-time error to attempt to explicitly instantiate an enum type

Enum types may not be instantiated. The following code will throw an error:

MyEnum myEnum = new MyEnum();

6 - Method associated

The compiler automatically adds some special methods when it creates an enum.

  • a static values method that returns an array containing all of the values of the enum in the order they are declared.
  • a static ordinal method that returns the numerical position of each enum constant in its type
Advertising

7 - Conversion

  • enum to ordinal
myEnum.ordinal()
  • ordinal to enum
EnumClass.values()[someInt]
  • String to enum
EnumClass.valueOf("An Enum String")
  • enum to String
myEnum.name()

8 - Example

8.1 - Enum

public enum SimpleEnum {
 
    NICO("nico", 41.0),
    MADELIEF("madelief", 8.0);
 
    private final String name;
    private final Double age;
 
    SimpleEnum(String name, Double age) {
        this.name = name;
        this.age = age;
    }
 
 
    public static void main(String[] args) {
        // Get a Madelief object, print Nico
        SimpleEnum simpleEnum = SimpleEnum.MADELIEF;
        System.out.println("Print Nico as an instance method of Madelief: "+simpleEnum.getDynamicallyNico());
 
        // Print a static
        System.out.println("Print Nico as class method (Statically): "+SimpleEnum.getStaticallyNico());
 
        // Print Madelief and Nico
        System.out.println("Print all enum values ");
        for (SimpleEnum enumValue : SimpleEnum.values()) {
            System.out.printf("The age of %s is %f%n",
                    enumValue, enumValue.age);
        }
 
 
    }
 
    public static SimpleEnum getStaticallyNico() {
        return NICO;
    }
 
    public static SimpleEnum getDynamicallyNico() {
        return NICO;
    }
 
}
Print as instance method NICO
Print as class method (Statically) NICO
Print all enum values 
The age of NICO is 41.000000
The age of MADELIEF is 8.000000

8.2 - Singleton

Singleton implementation.

INSTANCE is public static final field that represents the enum instance. You can get the instance of the class with the following statement EnumSingleton.INSTANCE but it's best to encapsulate it in a getter in case of you may want to change the implementation.

public enum EnumSingleton {
 
    INSTANCE;
 
    private String name; // Mandatory
    private Double age = null; // Not Mandatory
 
    private void build(SingletonBuilder builder) {
        this.name = builder.name;
        this.age = builder.age;
    }
 
    // Static getter
    public static EnumSingleton getSingleton() {
        return INSTANCE;
    }
 
    public void print() {
        System.out.println("Name "+name + ", age: "+age);
    }
 
 
    public static class SingletonBuilder {
 
        private final String name;
        private Double age = null;
 
        private SingletonBuilder(){
              name = null;
        }
 
        SingletonBuilder(String name) {
            this.name = name;
        }
 
        public SingletonBuilder age(double age) {
            this.age = age;
            return this;
        }
 
        public void build(){
            EnumSingleton.INSTANCE.build(this);
        }
 
    }
 
 
    public static void main(String[] args) {
        new SingletonBuilder("nico").age(41).build();
        EnumSingleton.getSingleton().print();
    }
 
}
Name nico, age: 41.0
Advertising

9 - Documentation / Reference

lang/java/enum.txt · Last modified: 2017/09/20 22:34 by gerardnico