info.freelibrary.iiif.presentation.v3.properties.ViewingDirection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jiiify-presentation-v3 Show documentation

A Java Library for version 3 of the IIIF Presentation API

There is a newer version: 0.12.4

Show newest version


package info.freelibrary.iiif.presentation.v3.properties;

import com.fasterxml.jackson.annotation.JsonValue;

import info.freelibrary.util.Logger;
import info.freelibrary.util.LoggerFactory;

import info.freelibrary.iiif.presentation.v3.utils.MessageCodes;

/**
 * The direction that a sequence of canvases should be displayed to the user. Possible values are specified in the table
 * below.
 */
public enum ViewingDirection {

    /**
     * A left-to-right viewing direction.
     */
    LEFT_TO_RIGHT("left-to-right"), //

    /**
     * A right-to-left viewing direction.
     */
    RIGHT_TO_LEFT("right-to-left"), //

    /**
     * A top-to-bottom viewing direction.
     */
    TOP_TO_BOTTOM("top-to-bottom"), //

    /**
     * A bottom-to-top viewing direction.
     */
    BOTTOM_TO_TOP("bottom-to-top");

    /**
     * The ViewingDirection logger.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(ViewingDirection.class, MessageCodes.BUNDLE);

    /**
     * The ViewingDirection value.
     */
    private final String myValue;

    /**
     * Creates a new ViewingDirection from the supplied string.
     *
     * @param aDirection A viewing direction in string form
     */
    ViewingDirection(final String aDirection) {
        myValue = aDirection;
    }

    /**
     * Gets the string representation of the viewing direction.
     */
    @Override
    @JsonValue
    public String toString() {
        return myValue;
    }

    /**
     * Create a ViewingDirection from a supplied string; it may be empty if the supplied string doesn't correspond to a
     * valid ViewingDirection value.
     *
     * @param aViewingDirection A ViewingDirection value
     * @return The ViewingDirection for the supplied value
     * @throws IllegalArgumentException If the supplied value isn't a viewing direction
     */
    public static ViewingDirection fromString(final String aViewingDirection) {
        for (final ViewingDirection direction : values()) {
            if (direction.toString().equalsIgnoreCase(aViewingDirection)) {
                return direction;
            }
        }

        throw new IllegalArgumentException(LOGGER.getMessage(MessageCodes.JPA_016, aViewingDirection));
    }
}