de.vdv.ojp20.HierarchyEnumeration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package de.vdv.ojp20;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlType;


/**
 * Indicates for which parts of the hierarchy of the StopPlace(s) stop events should be provided 
 * 			(if known by the server). "local" (default) is the local server setting. "no" will include no hierarchy and only 
 * 			provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/StopPlaces in the hierarchy, if
 * 			such a hierarchy exists. "all" does include all StopPoints/StopPlaces for the meta station if it is known. How 
 * 			to use this: if you indicate the reference to a train station and the parameter is set to "down", the departures/
 * 			arrivals at the associated bus stations will show as well. If you have the ScheduledStopPoint of platform B of 
 * 			the local bus and it is associated with 3 other stations, you will get all these arrivals/departures as well, 
 * 			if the parameter is set to "all".
 * 
 * Java class for HierarchyEnumeration.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "HierarchyEnumeration")
@XmlEnum
public enum HierarchyEnumeration {

    @XmlEnumValue("local")
    LOCAL("local"),
    @XmlEnumValue("no")
    NO("no"),
    @XmlEnumValue("down")
    DOWN("down"),
    @XmlEnumValue("all")
    ALL("all");
    private final String value;

    HierarchyEnumeration(String v) {
        value = v;
    }

    /**
     * Gets the value associated to the enum constant.
     * 
     * @return
     *     The value linked to the enum.
     */
    public String value() {
        return value;
    }

    /**
     * Gets the enum associated to the value passed as parameter.
     * 
     * @param v
     *     The value to get the enum from.
     * @return
     *     The enum which corresponds to the value, if it exists.
     * @throws IllegalArgumentException
     *     If no value matches in the enum declaration.
     */
    public static HierarchyEnumeration fromValue(String v) {
        for (HierarchyEnumeration c: HierarchyEnumeration.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}