Package adql.db

## Enum STCS.Flavor

- java.lang.Object
- - java.lang.Enum<STCS.Flavor>
  - - adql.db.STCS.Flavor

- All Implemented Interfaces:
    `java.io.Serializable`, `java.lang.Comparable<STCS.Flavor>`
  Enclosing class:
    STCS

      public static enum STCS.Flavor
      extends java.lang.Enum<STCS.Flavor>

  List of all possible flavors in an STC expression.

  When no value is specified, the default one is `SPHERICAL2`. The default value is also accessible through the attribute `DEFAULT` and it is possible to test whether a flavor is the default with the function `isDefault()`.

  Note: The possible values listed in this enumeration are limited to the subset of STC-S described by the section "6 Use of STC-S in TAP (informative)" of the TAP Recommendation 1.0 (27th March 2010).

  Since:
    1.3
  Version:
    1.3 (10/2014)
  Author:
    Grégory Mantelet (ARI)

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `CARTESIAN2` |
    `CARTESIAN3` |
    `SPHERICAL2` |

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static STCS.Flavor` | `DEFAULT` | Default value for a flavor: `SPHERICAL2`.
    `static java.lang.String` | `regexp` | Regular expression to test whether a string is a valid flavor or not.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | `isDefault()` | Tell whether this flavor is the default one.
    `static STCS.Flavor` | `valueOf​(java.lang.String name)` | Returns the enum constant of this type with the specified name.
    `static STCS.Flavor[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

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

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### CARTESIAN2

          public static final STCS.Flavor CARTESIAN2

    - #### CARTESIAN3

          public static final STCS.Flavor CARTESIAN3

    - #### SPHERICAL2

          public static final STCS.Flavor SPHERICAL2

  - ### Field Detail

    - #### DEFAULT

          public static final STCS.Flavor DEFAULT

      Default value for a flavor: `SPHERICAL2`.

    - #### regexp

          public static final java.lang.String regexp

      Regular expression to test whether a string is a valid flavor or not. This regular expression does not take into account the case of an empty string (which means "default flavor").

  - ### Method Detail

    - #### values

          public static STCS.Flavor[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (STCS.Flavor c : STCS.Flavor.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static STCS.Flavor valueOf​(java.lang.String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name
        `java.lang.NullPointerException` - if the argument is null

    - #### isDefault

          public final boolean isDefault()

      Tell whether this flavor is the default one.
      Returns:
        true if this is the default flavor, false