Package com.orchestranetworks.schema.types.dataspace

# Enum Class DataspaceSet.DataspaceType

java.lang.Object
java.lang.Enum<DataspaceSet.DataspaceType>
com.orchestranetworks.schema.types.dataspace.DataspaceSet.DataspaceType

All Implemented Interfaces:
  `Serializable`, `Comparable<DataspaceSet.DataspaceType>`, `Constable`

Enclosing interface:
  DataspaceSet

public static enum DataspaceSet.DataspaceType extends Enum<DataspaceSet.DataspaceType>
Defines all the types that a dataspace can be.

Since:
  5.8.0

- ## 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
  `ALL`
  Can be a `BRANCH` or a `SNAPSHOT`.
  `BRANCH`
  A non-reserved branch, including `Repository.REFERENCE`.
  `SNAPSHOT`
  A snapshot, excluding any snapshot under a built-in branch.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `format()`
  Returns the code associated with this type.
  `UserMessage`
  `getLabel()`
  Returns the type label.
  `static DataspaceSet.DataspaceType`
  `parseType(String aValue)`
  Parses a string value, and returns the associated `DataspaceSet.DataspaceType`.
  `static DataspaceSet.DataspaceType`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static DataspaceSet.DataspaceType[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

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

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

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

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

- ## Enum Constant Details

  - ### ALL

    public static final DataspaceSet.DataspaceType ALL
    Can be a `BRANCH` or a `SNAPSHOT`.

  - ### BRANCH

    public static final DataspaceSet.DataspaceType BRANCH
    A non-reserved branch, including `Repository.REFERENCE`.

  - ### SNAPSHOT

    public static final DataspaceSet.DataspaceType SNAPSHOT
    A snapshot, excluding any snapshot under a built-in branch.

- ## Method Details

  - ### values

    public static DataspaceSet.DataspaceType[] 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 DataspaceSet.DataspaceType 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

  - ### parseType

    public static DataspaceSet.DataspaceType parseType(String aValue)
    Parses a string value, and returns the associated `DataspaceSet.DataspaceType`.
    Parameters:
      `aValue` - The literal type

  - ### getLabel

    public UserMessage getLabel()
    Returns the type label.

  - ### format

    public String format()
    Returns the code associated with this type.