de.vdv.ojp20.IncludeFormationEnumeration 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;


/**
 * Possible values how to include formations in the basic filters
 * 
 * Java class for IncludeFormationEnumeration.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "IncludeFormationEnumeration")
@XmlEnum
public enum IncludeFormationEnumeration {

    @XmlEnumValue("none")
    NONE("none"),

    /**
     * The response should include VehicleFeatureRef (from SIRI).
     * 
     */
    @XmlEnumValue("vehiclefeature")
    VEHICLEFEATURE("vehiclefeature"),

    /**
     * Besides VehicleFeatureRefs also Formation, ArrivalFormation and DepartureFormation can be used. This is the full SIRI formation experience. Refer to the SIRI documentation for details. The specification document and the examples may show simpler ways of doing things. For full accessibility many features are needed. It is recommended to always also use VehicleFeatureRef (for people not processing SIRI formation and because buses and the like don't need Formation in most cases).
     * 
     */
    @XmlEnumValue("full")
    FULL("full");
    private final String value;

    IncludeFormationEnumeration(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 IncludeFormationEnumeration fromValue(String v) {
        for (IncludeFormationEnumeration c: IncludeFormationEnumeration.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}