de.morknet.mrw.base

Enum OccupationCode

java.lang.Object

java.lang.Enum<OccupationCode>

de.morknet.mrw.base.OccupationCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OccupationCode>

public enum OccupationCode
extends java.lang.Enum<OccupationCode>

Dieses Interface repräsentiert die Antwort-Codes der Gleisbesetztmeldung auf das GETRBS-Kommando.

Author:

smork

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREE Abschnitt frei.
OCCUPIED Abschnitt belegt.

Method Summary

Methods

Modifier and Type	Method and Description
int	getOccupationCode() Diese Methode gibt den Gleisbelegungscode als Integer zurück, so wie er von den Microcontrollern gemeldet wird.
static OccupationCode	getOccupationCode(int code) Diese Methode wandelt die Integer-Variante eines Gleisbelegungscodes in eine Enum-Instanz um.
static boolean	isFree(int code) Diese Methode wandelt einen gegebenen Code in einen Boolean um und ermittelt, ob er einem Gleis frei entspricht.
static boolean	isOccupied(int code) Diese Methode wandelt einen gegebenen Code in einen Boolean um und ermittelt, ob er einem Gleis belegt entspricht.
static OccupationCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OccupationCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FREE

public static final OccupationCode FREE

Abschnitt frei.

OCCUPIED

public static final OccupationCode OCCUPIED

Abschnitt belegt.

Method Detail

values

public static OccupationCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OccupationCode c : OccupationCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OccupationCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getOccupationCode

public int getOccupationCode()

Diese Methode gibt den Gleisbelegungscode als Integer zurück, so wie er von den Microcontrollern gemeldet wird.

Returns:

Der Gleisbelegungscode.

getOccupationCode

public static OccupationCode getOccupationCode(int code)

Diese Methode wandelt die Integer-Variante eines Gleisbelegungscodes in eine Enum-Instanz um.

Parameters:

code - Der Integer-Wert

Returns:

Der resultierende Gleisbelegungs-Code als enum.

Throws:

CodeNotFoundException - Wenn zum Gleisbelegungscode keine Enum-Instanz gefunden wurde.

isOccupied

public static boolean isOccupied(int code)

Diese Methode wandelt einen gegebenen Code in einen Boolean um und ermittelt, ob er einem Gleis belegt entspricht.

Parameters:

code - Der auszuwertende Code.

Returns:

Ist Code gleichbedeutend mit Gleis belegt?

isFree

public static boolean isFree(int code)

Diese Methode wandelt einen gegebenen Code in einen Boolean um und ermittelt, ob er einem Gleis frei entspricht.

Parameters:

code - Der auszuwertende Code.

Returns:

Ist Code gleichbedeutend mit Gleis frei?