Can I add a function to enums in Java?

Question

I have an enum, which looks like

public enum Animal {
  ELEPHANT,
  GIRAFFE,
  TURTLE,
  SNAKE,
  FROG
}

and I want to do something like

Animal frog = Animal.FROG;
Animal snake = Animal.SNAKE;

boolean isFrogAmphibian = frog.isAmphibian(); //true
boolean isSnakeAmphibian = snake.isAmphibian(); //false

boolean isFrogReptile = frog.isReptile(); //false
boolean isSnakeReptile = snake.isReptile(); //true

boolean isFrogMammal = frog.isMammal(); //false
boolean isSnakeMammal = snake.isMammal(); //false

I simplified the example for didactic purposes, but this would be really useful to me for my real life example. Can I do it in Java?

score 110 · Accepted Answer · edited Jun 20 '20 at 09:12

110

Yes Enum is a class in Java:

public enum Animal 
{
  ELEPHANT(true),
  GIRAFFE(true),
  TURTLE(false),
  SNAKE(false),
  FROG(false);

  private final boolean mammal; 
  private Animal(final boolean mammal) { this.mammal = mammal; }
  public boolean isMammal() { return this.mammal; }
}

but in your case for a real system I would make that an Enum as well since there is a fixed set of types of animals.

public enum Type
{
  AMPHIBIAN,
  MAMMAL,
  REPTILE,
  BIRD
}

public enum Animal 
{
  ELEPHANT(Type.MAMMAL),
  GIRAFFE(Type.MAMMAL),
  TURTLE(Type.REPTILE),
  SNAKE(Type.REPTILE),
  FROG(Type.AMPHIBIAN);

  private final Type type; 
  private Animal(final Type type) { this.type = type; }
  public boolean isMammal() { return this.type == Type.MAMMAL; }
  public boolean isAmphibian() { return this.type == Type.AMPHIBIAN; }
  public boolean isReptile() { return this.type == Type.REPTILE; }
  // etc...
}

Also note that it is important to make any instance variable final as well.

You can find more details about it in the Java Language Specification.

edited Jun 20 '20 at 09:12

Community

1
1

answered Mar 16 '10 at 18:36

what if I want different categories, like mammal, amphibian, reptile? – Samuel Carrijo Mar 16 '10 at 18:37
you would need multiple boolean flags for each one, or you could make that category and Enum as well as I suggest in my solution. – Mar 16 '10 at 18:41
@fuzzy: Java requires that the enum body declarations - if there are any - be started by a ';', See JLS 8.9. Compiling with Java 1.6 (5 seconds): `Animal.java:9: ',', '}', or ';' expected \n private final boolean mammal;` (\n inserted to mark new line and position of error) The `Type` enum above don't need it since there are no body declarations... – user85421 Mar 17 '10 at 12:15
1

not methods, CONSTRUCTORS you should not be able to create an instance of an Enum outside itself. Making the CONSTRUCTOR private means only the static instances on itself can create instances. – Mar 17 '10 at 14:46
2

explicit is always better than implicit – Mar 17 '10 at 15:49
1

Why is it important to declare its instance variables as final? – Roberto Linares Feb 25 '13 at 14:38

score 26 · Answer 2 · answered Feb 05 '20 at 15:29

I have an other option:

public enum Animal {
    ELEPHANT {
        @Override
        boolean isMammal() {
            return true;
        };
        @Override
        boolean isReptile() {
            return false;
        }
    },
    SNAKE {
        @Override
        boolean isMammal() {
            return false;
        };
        @Override
        boolean isReptile() {
            return true;
        }
    };

    abstract boolean isMammal();
    abstract boolean isReptile();
}

No need of external Interface and I am quite sure (did not test) it works also on Java7.

This is the most complete answer! +1 – Oliver Sep 29 '21 at 12:23 — Oliver, Sep 29 '21 at 12:23

score 16 · Answer 3 · answered Mar 16 '10 at 18:35

16

Yes, you can. It would look like this:

public enum Animal {
  ELEPHANT(false),
  GIRAFFE(false),
  TURTLE(false),
  SNAKE(false),
  FROG(true);

  private final boolean isAmphibian;

  Animal(boolean isAmphibian) {
    this.isAmphibian = isAmphibian;
  }

  public boolean isAmphibian() {
    return this.isAmphibian;
  }
}

Then you would call it like:

Animal.ELEPHANT.isAmphibian()

answered Mar 16 '10 at 18:35

danben

80,905
18
123
145

1

constructors to Enums should be private – Mar 16 '10 at 18:37
7

Not "should be private", but must be private. – Steve Kuo Mar 16 '10 at 23:18
2

That's strange - the Planet example at http://java.sun.com/j2se/1.5.0/docs/guide/language/enums.html doesn't use the private modifier on the constructor. Are you sure? – danben Mar 17 '10 at 04:04
3

Not needed. They're implicitly already private. Enumns are uninstantiable at any way. – BalusC Mar 17 '10 at 14:58
1

No, not private. package private. Or so I believe...? – Thufir Sep 09 '13 at 06:02
https://stackoverflow.com/questions/7747948/why-can-a-enum-have-a-package-private-constructor – Arundev Aug 05 '20 at 22:44

rghome · Answer 4 · 2020-02-05T17:08:25.683

As well as using the techniques above which add a field to the enumerated type you can also use a pure method based approach and polymorphism. This is more "OOP style" but I would not say it is necessarily better.

Unfortunately, you may (see the comment below) need to define an interface:

public interface AnimalTraits {
    default boolean isAmphibian()   { return false; };
    default boolean isReptile()     { return false; };
    default boolean isMammal()      { return false; };
}

But then you can them implement the interface in each of your enumeration elements:

public enum Animal implements AnimalTraits {

     ELEPHANT   { @Override public boolean isMammal()    { return true; } },
     GIRAFFE    { @Override public boolean isMammal()    { return true; } },
     TURTLE     { @Override public boolean isReptile()   { return true; } },
     SNAKE      { @Override public boolean isReptile()   { return true; } },
     FROG       { @Override public boolean isAmphibian() { return true; } }
}

Note that I use default implementations in the interface to cut down on the amount of typing you need in the enum.

Regarding the necessity of the interface: I tried adding the methods in the interface as abstract methods at the top of the enum and Eclipse seemed to allow it and insisted on implementations in the enum elements, but then failed to compile those properly. So it looks like it ought to be possible without an interface, but perhaps it is not yet implemented in the compiler.

Actually you don't need to create an Interface and neither need Java8. See my answer. — Emaborsa, Feb 05 '20 at 15:29

Can I add a function to enums in Java?

4 Answers4

Yes Enum is a class in Java:

Linked