Module org.apache.sis.referencing
Package org.apache.sis.io.wkt

# Enum Class KeywordCase

Object
Enum<KeywordCase>
KeywordCase

All Implemented Interfaces:
  `Serializable`, `Comparable<KeywordCase>`, `Constable`

public enum KeywordCase extends Enum<KeywordCase>
Whether WKT keywords shall be written with lower, upper or camel case styles. The most common usage for WKT keywords is upper case. However, with version 2 of Well Known Text, camel case keywords may be easier to read because WKT 2 has more keywords made by combination of words. Examples:

WKT element case comparisons
Upper case | Camel case
--- | ---
`TIMEEXTENT` | `TimeExtent`
`ANGLEUNIT` | `AngleUnit`
`BASEGEODCRS` | `BaseGeodCRS`
`DERIVINGCONVERSION` | `DerivingConversion`
`ENGINEERINGDATUM` | `EngineeringDatum`

Well-Known Text keywords are case insensitive at parsing time. `KEYWORD` is equivalent to `keyword` is equivalent to `KeyWord` and to `kEYwORd`.

Since:
  0.4

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class Enum

  `Enum​.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `CAMEL_CASE`
  WKT formatting uses CamelCase keywords.
  `DEFAULT`
  Keywords case is determined by the WKT convention.
  `LOWER_CASE`
  WKT formatting uses lower case keywords.
  `UPPER_CASE`
  WKT formatting uses upper case keywords.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static KeywordCase`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static KeywordCase[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class Enum

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

  ### Methods inherited from class Object

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

- ## Enum Constant Details

  - ### LOWER_CASE

    public static final KeywordCase LOWER_CASE
    WKT formatting uses lower case keywords.

  - ### UPPER_CASE

    public static final KeywordCase UPPER_CASE
    WKT formatting uses upper case keywords. This is the most usual case in WKT 1 strings.

  - ### CAMEL_CASE

    public static final KeywordCase CAMEL_CASE
    WKT formatting uses CamelCase keywords. This is more useful in WKT 2 strings, which use longer keywords than WKT 1 did. Examples: `"TimeExtent"`, `"AngleUnit"`.

  - ### DEFAULT

    public static final KeywordCase DEFAULT
    Keywords case is determined by the WKT convention. The current mapping is:
    - Well Known Text version 2 uses camel case.
    - Well Known Text version 1 uses upper case.

- ## Method Details

  - ### values

    public static KeywordCase[] 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 KeywordCase 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