Keys.KeyType (Concourse Java API)

Object
- Enum<Keys.KeyType>
- - Keys.KeyType

All Implemented Interfaces:

Serializable, Comparable<Keys.KeyType>

Enclosing class:

Keys
```
public static enum Keys.KeyType
extends Enum<Keys.KeyType>
```
The various kinds of keys that can be parsed.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`FUNCTION_KEY` A key that instructs that a function should be evaluated.
`IDENTIFIER_KEY` A key that refers to a record identifier.
`INVALID_KEY` A key that cannot be parsed.
`NAVIGATION_KEY` A key that has multiple "stops" separated by a period (e.g., friends.partner.name).
`TEMPORAL_KEY` A single-leaf key whose read is pinned to a specific moment by a `[<timestamp>]` bracket parameter (e.g.
`WRITABLE_KEY` A key that can be written and therefore read directly.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Keys.KeyType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Keys.KeyType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - WRITABLE_KEY
```
public static final Keys.KeyType WRITABLE_KEY
```
    A key that can be written and therefore read directly.
  - TEMPORAL_KEY
```
public static final Keys.KeyType TEMPORAL_KEY
```
    A single-leaf key whose read is pinned to a specific moment by a [<timestamp>] bracket parameter (e.g. "name[12345]").
  - NAVIGATION_KEY
```
public static final Keys.KeyType NAVIGATION_KEY
```
    A key that has multiple "stops" separated by a period (e.g., friends.partner.name). Any subset of stops may carry per-stop bracket-timestamp parameters.
  - FUNCTION_KEY
```
public static final Keys.KeyType FUNCTION_KEY
```
    A key that instructs that a function should be evaluated.
  - IDENTIFIER_KEY
```
public static final Keys.KeyType IDENTIFIER_KEY
```
    A key that refers to a record identifier.
  - INVALID_KEY
```
public static final Keys.KeyType INVALID_KEY
```
    A key that cannot be parsed.
- Method Detail
  - values
```
public static Keys.KeyType[] 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 (Keys.KeyType c : Keys.KeyType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Keys.KeyType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum Keys.KeyType

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

WRITABLE_KEY

TEMPORAL_KEY

NAVIGATION_KEY

FUNCTION_KEY

IDENTIFIER_KEY

INVALID_KEY

Method Detail

values

valueOf