ObjectDirection.java

Go to the documentation of this file.

package com.runehive.game.world.object;
 
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
 
import java.util.Map;
import java.util.Optional;
 
/**
 * The enumerated type whose elements represent the directions for objects.
 *
 * @author lare96 <http://github.com/lare96>
 * @author Artem Batutin <artembatutin@gmail.com>
 */
public enum ObjectDirection {
 
    /**
     * The north orientation.
     */
    NORTH(1),
 
    /**
     * The south orientation.
     */
    SOUTH(3),
 
    /**
     * The east orientation.
     */
    EAST(2),
 
    /**
     * The west orientation.
     */
    WEST(0);
 
    /**
     * The identification of this direction.
     */
    private final int id;
 
    /**
     * Creates a new {@link ObjectDirection}.
     */
    ObjectDirection(int id) {
        this.id = id;
    }
 
    /**
     * Gets the identification of this direction.
     *
     * @return the identification of this direction.
     */
    public final int getId() {
        return id;
    }
 
    private static final ObjectDirection[] values = values();
 
    /**
     * A mutable {@link Map} of {@code int} keys to {@link
     * ObjectDirection} values.
     */
    private static final Int2ObjectMap<ObjectDirection> idToDirection = new Int2ObjectOpenHashMap<>(values.length);
 
    /* Populates the {@link #values} cache. */
    static {
        for (ObjectDirection orientation : values) {
            idToDirection.put(orientation.getId(), orientation);
        }
    }
 
    /**
     * Returns a {@link ObjectDirection} wrapped in an {@link Optional} for the
     * specified {@code id}.
     *
     * @param id The game object orientation id.
     * @return The optional game object orientation.
     */
    public static Optional<ObjectDirection> valueOf(final int id) {
        return Optional.ofNullable(idToDirection.get(id));
    }
 
}