Package org.ivoa.dm.registry.vodataservice

Enum Class ParamUse

java.lang.Object
java.lang.Enum<ParamUse>
org.ivoa.dm.registry.vodataservice.ParamUse
All Implemented Interfaces:
Serializable, Comparable<ParamUse>, Constable
@VoDml(id="VODataService:ParamUse", role=enumeration) public enum ParamUse extends Enum<ParamUse>
. Enumeration ParamUse :

  • 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
    Value ignored : The parameter is not supported and thus is ignored by the application or service.
    OPTIONAL
    Value optional : The parameter is optional but supported by the application or service.
    REQUIRED
    Value required : The parameter is required for the application or service to work properly.

  • Method Summary

    Modifier and Type
    Method
    Description
    static final ParamUse
    fromValue(String v)
    Return the ParamUse enum constant corresponding to the given string representation (value)
    final String
    toString()
    Return the string representation of this enum constant (value)
    final String
    value()
    Return the string representation of this enum constant (value)
    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, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • REQUIRED

      public static final ParamUse REQUIRED
      Value required : The parameter is required for the application or service to work properly.

    • OPTIONAL

      public static final ParamUse OPTIONAL
      Value optional : The parameter is optional but supported by the application or service.

    • IGNORED

      public static final ParamUse IGNORED
      Value 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 final String value()
      Return the string representation of this enum constant (value)
      Returns:
      string representation of this enum constant (value)

    • toString

      public final String toString()
      Return the string representation of this enum constant (value)
      Overrides:
      toString in class Enum<ParamUse>
      Returns:
      string representation of this enum constant (value)
      See Also:

    • fromValue

      public static final ParamUse fromValue(String v)
      Return the ParamUse enum constant corresponding to the given string representation (value)
      Parameters:
      v - string representation (value)
      Returns:
      ParamUse enum constant
      Throws:
      IllegalArgumentException - if there is no matching enum constant