com.carlomicieli.jtrains.value.constants.Priority.java Source code

Introduction

Here is the source code for com.carlomicieli.jtrains.value.constants.Priority.java

Source

/*
 * Copyright 2014 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the 'License');
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an 'AS IS' BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.carlomicieli.jtrains.value.constants;

import com.carlomicieli.jtrains.util.EnumUtils;
import org.apache.commons.lang.StringUtils;

/**
 * It represents the list of {@code Priority} value.
 *
 * @author Carlo Micieli
 */
public enum Priority {
    /**
     * Priority HIGH.
     */
    HIGH(0),

    /**
     * Priority NORMAL.
     */
    NORMAL(1),

    /**
     * Priority LOW.
     */
    LOW(2);

    private int value;

    private Priority(int value) {
        this.value = value;
    }

    /**
     * Gets the {@code Priority} keyword
     *
     * @return the keyword
     */
    public String label() {
        return EnumUtils.keyFor(this);
    }

    /**
     * Parses the string argument as a {@code Priority}.
     *
     * @param s the string to be parsed
     * @return a {@code Priority} value
     */
    public static Priority parse(String s) {
        return EnumUtils.parseEnum(Priority.class, s);
    }

    /**
     * Parses the string argument as a {@code Priority}.
     *
     * @param str        the string to be parsed
     * @param defaultValue the default {@code Priority} value
     * @return a {@code Priority} value
     */
    public static Priority parse(String str, Priority defaultValue) {
        if (StringUtils.isBlank(str)) {
            return defaultValue;
        }
        return EnumUtils.parseEnum(Priority.class, str);
    }

    /**
     * Returns the {@code Priority} value used for ordering.
     * @return the value
     */
    public int getValue() {
        return value;
    }
}