tuwien.auto.calimero.Priority Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of calimero-core Show documentation
Calimero, a free KNX network library
The newest version!
/*
    Calimero 2 - A library for KNX network access
    Copyright (c) 2006, 2022 B. Malinowsky

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    Linking this library statically or dynamically with other modules is
    making a combined work based on this library. Thus, the terms and
    conditions of the GNU General Public License cover the whole
    combination.

    As a special exception, the copyright holders of this library give you
    permission to link this library with independent modules to produce an
    executable, regardless of the license terms of these independent
    modules, and to copy and distribute the resulting executable under terms
    of your choice, provided that you also meet, for each linked independent
    module, the terms and conditions of the license of that module. An
    independent module is a module which is not derived from or based on
    this library. If you modify this library, you may extend this exception
    to your version of the library, but you are not obligated to do so. If
    you do not wish to do so, delete this exception statement from your
    version.
*/

package tuwien.auto.calimero;


/**
 * KNX message priorities for sending on a KNX medium.
 *
 * @author B. Malinowsky
 */
public enum Priority {
	/**
	 * System priority, reserved for high priority management and system configuration.
	 */
	SYSTEM,

	/**
	 * Normal priority, the default for short frames.
	 */
	NORMAL,

	/**
	 * Urgent priority, for urgent frames.
	 */
	URGENT,

	/**
	 * Low priority, used for long frames.
	 */
	LOW;

	/**
	 * Constant with the 2 Bit representation of this priority used in the message
	 * priority field.
	 */
	public final int value = ordinal();

	/**
	 * Returns the priority of the supplied priority value code.
	 *
	 * @param value priority value code, 0 <= value <= 3
	 * @return the corresponding priority
	 */
	public static Priority get(final int value)
	{
		if (value == 1)
			return NORMAL;
		if (value == 0)
			return SYSTEM;
		if (value == 3)
			return LOW;
		if (value == 2)
			return URGENT;
		throw new KNXIllegalArgumentException("invalid priority value");
	}

	/**
	 * Returns the priority of the supplied priority value representation.
	 * 
	 * The following textual representations for {@code value} are allowed:
	 * 

	 * "system"
	 * "normal"
	 * "urgent"
	 * "low"
	 * 
	 * These are in accordance with the ones returned by {@link #toString()}.
	 *
	 * @param value priority value in textual representation, value is treated case
	 *        insensitive
	 * @return the corresponding priority object
	 */
	public static Priority get(final String value)
	{
		if ("system".equalsIgnoreCase(value))
			return SYSTEM;
		if ("normal".equalsIgnoreCase(value))
			return NORMAL;
		if ("urgent".equalsIgnoreCase(value))
			return URGENT;
		if ("low".equalsIgnoreCase(value))
			return LOW;
		throw new KNXIllegalArgumentException("invalid priority value");
	}

	/**
	 * Returns the priority in textual representation.
	 *
	 * 
	 * {@link #SYSTEM} returns "system"
	 * {@link #NORMAL} returns "normal"
	 * {@link #LOW} returns "low"
	 * {@link #URGENT} returns "urgent"
	 * 
	 *
	 * @return priority as string
	 */
	@Override
	public String toString()
	{
		return value == 0 ? "system" : value == 1 ? "normal" : value == 2 ? "urgent" : "low";
	}
}