How to Create a Java Enum that Returns the Opposite Direction?

How can I create a Java Enum that includes a method to return the opposite direction?

public enum Direction {
    NORTH(1),
    SOUTH(-1),
    EAST(-2),
    WEST(2);

    Direction(int code){
        this.code = code;
    }
    protected int code;
    public int getCode() {
        return this.code;
    }
}

In Java, enums can encapsulate methods and can be designed to return related values, such as opposite directions. In this guide, we will walk through the correct implementation of a Direction enum that includes a method to return the opposite direction.

public enum Direction {
    NORTH(1),
    SOUTH(-1),
    EAST(2),
    WEST(-2);

    private final int code;

    Direction(int code) {
        this.code = code;
    }

    public int getCode() {
        return this.code;
    }

    public Direction getOppositeDirection() {
        switch (this) {
            case NORTH: return SOUTH;
            case SOUTH: return NORTH;
            case EAST: return WEST;
            case WEST: return EAST;
            default: throw new IllegalArgumentException("Unknown direction: " + this);
        }
    }
} 

// Usage example:
Direction current = Direction.NORTH;
Direction opposite = current.getOppositeDirection(); // returns Direction.SOUTH

Causes

• Improper use of enum constructors leading to errors.
• Confusion about how to achieve method functionality within enums.

Solutions

• Define the opposite direction logic clearly within the enum using a method.
• Use a switch statement or a mapping approach for cleaner implementation.

Mistake: Instantiating enum directly using new keyword.

Solution: Enums cannot be instantiated using the 'new' keyword. Use defined enum constants instead.

Mistake: Confusing enum values with their associated properties and defining them incorrectly.

Solution: Ensure correct implementation of properties and associated methods within the enum.