Package adql.db

## Enum STCS.Frame

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

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

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

  List of all possible frames in an STC expression.

  When no value is specified, the default one is `UNKNOWNFRAME`. The default value is also accessible through the attribute `DEFAULT` and it is possible to test whether a frame 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.4 (04/2017)
  Author:
    Grégory Mantelet (ARI)

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `ECLIPTIC` |
    `FK4` |
    `FK5` |
    `GALACTIC` |
    `ICRS` |
    `J2000` |
    `UNKNOWNFRAME` |

  - ### Field Summary

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

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | `isDefault()` | Tell whether this frame is the default one.
    `static STCS.Frame` | `valueOf​(java.lang.String name)` | Returns the enum constant of this type with the specified name.
    `static STCS.Frame[]` | `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

    - #### ECLIPTIC

          public static final STCS.Frame ECLIPTIC

    - #### FK4

          public static final STCS.Frame FK4

    - #### FK5

          public static final STCS.Frame FK5

    - #### J2000

          public static final STCS.Frame J2000

    - #### GALACTIC

          public static final STCS.Frame GALACTIC

    - #### ICRS

          public static final STCS.Frame ICRS

    - #### UNKNOWNFRAME

          public static final STCS.Frame UNKNOWNFRAME

  - ### Field Detail

    - #### DEFAULT

          public static final STCS.Frame DEFAULT

      Default value for a frame: `UNKNOWNFRAME`.

    - #### regexp

          public static final java.lang.String regexp

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

  - ### Method Detail

    - #### values

          public static STCS.Frame[] 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.Frame c : STCS.Frame.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.Frame 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 frame is the default one.
      Returns:
        true if this is the default frame, false