Package org.javastro.ivoa.entities.resource.dataservice

Enum Class ParamUse

java.lang.Object

java.lang.Enum<ParamUse>

org.javastro.ivoa.entities.resource.dataservice.ParamUse

All Implemented Interfaces:

Serializable, Comparable<ParamUse>, Constable, org.jvnet.jaxb.lang.EnumValue<String>

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public enum ParamUse
extends Enum<ParamUse>
implements org.jvnet.jaxb.lang.EnumValue<String>

Java class for ParamUse

.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="ParamUse">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="required"/>
     <enumeration value="optional"/>
     <enumeration value="ignored"/>
   </restriction>
 </simpleType>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORED	The parameter is not supported and thus is ignored by the application or service.
OPTIONAL	The parameter is optional but supported by the application or service.
REQUIRED	The parameter is required for the application or service to work properly.

Method Summary

Modifier and Type	Method	Description
String	enumValue()
static ParamUse	fromValue(String v)	Gets the enum associated to the value passed as parameter.
String	value()	Gets the value associated to the enum constant.
static ParamUse	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParamUse[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final ParamUse REQUIRED

The parameter is required for the application or service to work properly.

OPTIONAL

public static final ParamUse OPTIONAL

The parameter is optional but supported by the application or service.

IGNORED

public static final ParamUse IGNORED

The parameter is not supported and thus is ignored by the application or service.

Method Details

values

public static ParamUse[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ParamUse valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Gets the value associated to the enum constant.

Returns:

The value linked to the enum.

fromValue

public static ParamUse fromValue(String v)

Gets the enum associated to the value passed as parameter.

Parameters:

v - The value to get the enum from.

Returns:

The enum which corresponds to the value, if it exists.

Throws:

IllegalArgumentException - If no value matches in the enum declaration.

enumValue

public String enumValue()

Specified by:

enumValue in interface org.jvnet.jaxb.lang.EnumValue<String>