org.javastro.ivoa.entities.resource.dataservice.ParamUse Maven / Gradle / Ivy

Go to download

package org.javastro.ivoa.entities.resource.dataservice;

import jakarta.annotation.Generated;
import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlType;
import org.jvnet.jaxb.lang.EnumValue;


/**
 * 
 * 
 * Java class for ParamUse.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "ParamUse")
@XmlEnum
@Generated(value = "com.sun.tools.xjc.Driver", comments = "JAXB RI v4.0.4", date = "2024-10-20T18:15:02+01:00")
public enum ParamUse implements EnumValue
{


    /**
     * The parameter is required for the application or
     *                   service to work properly.
     * 
     */
    @XmlEnumValue("required")
    REQUIRED("required"),

    /**
     * The parameter is optional but supported by the application or
     *                   service.
     * 
     */
    @XmlEnumValue("optional")
    OPTIONAL("optional"),

    /**
     * The parameter is not supported and thus is ignored by the 
     *                   application or service.
     * 
     */
    @XmlEnumValue("ignored")
    IGNORED("ignored");
    private final String value;

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

    @Override
    public String enumValue() {
        return this.value();
    }

}