JobPriority.java

/*
 * ProActive Parallel Suite(TM):
 * The Open Source library for parallel and distributed
 * Workflows & Scheduling, Orchestration, Cloud Automation
 * and Big Data Analysis on Enterprise Grids & Clouds.
 *
 * Copyright (c) 2007 - 2017 ActiveEon
 * Contact: contact@activeeon.com
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation: version 3 of
 * the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * If needed, contact us to obtain a release under GPL Version 2 or 3
 * or a different license than the AGPL.
 */
package org.ow2.proactive.scheduler.common.job;

import org.objectweb.proactive.annotation.PublicAPI;


/**
 * This is the different job priorities.
 *
 * @author The ProActive Team
 * @since ProActive Scheduling 0.9
 */
@PublicAPI
public enum JobPriority implements java.io.Serializable {
    /** Lowest priority*/
    IDLE("Idle", 0),
    /** Lowest priority */
    LOWEST("Lowest", 1),
    /** Low priority */
    LOW("Low", 2),
    /** Normal Priority */
    NORMAL("Normal", 3),
    /** High priority*/
    HIGH("High", 4),
    /** Highest priority*/
    HIGHEST("Highest", 5);
    /** Name of the priority */
    private String name;

    /** Priority representing by an integer */
    private int priority;

    /**
     * Implicit constructor of job priority.
     *
     * @param name the name of the priority.
     * @param priority the integer representing the priority.
     */
    JobPriority(String name, int priority) {
        this.name = name;
        this.priority = priority;
    }

    /**
     * @see java.lang.Enum#toString()
     */
    @Override
    public String toString() {
        return name;
    }

    /**
     * Return the integer representing the priority.
     *
     * @return the integer representing the priority.
     */
    public int getPriority() {
        return priority;
    }

    /**
     * Get the priority associated with the given name.
     *
     * @param name the name of the priority to find as a string.
     * @return the job priority corresponding to the string or the NORMAL priority if not found.
     */
    public static JobPriority findPriority(String name) {
        if (name.equalsIgnoreCase(IDLE.toString())) {
            return IDLE;
        }

        if (name.equalsIgnoreCase(LOWEST.toString())) {
            return LOWEST;
        }

        if (name.equalsIgnoreCase(LOW.toString())) {
            return LOW;
        }

        if (name.equalsIgnoreCase(HIGH.toString())) {
            return HIGH;
        }

        if (name.equalsIgnoreCase(HIGHEST.toString())) {
            return HIGHEST;
        }

        return NORMAL;
    }

    /**
     * Get the priority associated with the given priorityValue.
     *
     * @param priorityValue the priority value to find.
     * @return the job priority corresponding to the value or the NORMAL priority if not found.
     */
    public static JobPriority findPriority(int priorityValue) {
        if (priorityValue == IDLE.getPriority()) {
            return IDLE;
        }

        if (priorityValue == LOWEST.getPriority()) {
            return LOWEST;
        }

        if (priorityValue == LOW.getPriority()) {
            return LOW;
        }

        if (priorityValue == HIGH.getPriority()) {
            return HIGH;
        }

        if (priorityValue == HIGHEST.getPriority()) {
            return HIGHEST;
        }

        return NORMAL;
    }

}