Package edu.claflin.finder.algo

# Enum ArgumentsBundle.COMMON_ARGS

java.lang.Object
java.lang.Enum<ArgumentsBundle.COMMON_ARGS>
edu.claflin.finder.algo.ArgumentsBundle.COMMON_ARGS

All Implemented Interfaces:
  `Serializable`, `Comparable<ArgumentsBundle.COMMON_ARGS>`, `java.lang.constant.Constable`

Enclosing class:
  ArgumentsBundle

public static enum ArgumentsBundle.COMMON_ARGS extends Enum<ArgumentsBundle.COMMON_ARGS>
An enumeration containing common arguments used by the program.

- ## 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
  `EDGE_PRESERVATION`
  `EDGE_WEIGHT_COMPARATOR`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `private String`
  `desc`
  A String description of the enum.

- ## Constructor Summary

  Constructors
  Modifier
  Constructor
  Description
  `private`
  `COMMON_ARGS(String desc)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `toString()`
  `static ArgumentsBundle.COMMON_ARGS`
  `valueOf(String name)`
  Returns the enum constant of this type with the specified name.
  `static ArgumentsBundle.COMMON_ARGS[]`
  `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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

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

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

- ## Enum Constant Details

  - ### EDGE_PRESERVATION

    public static final ArgumentsBundle.COMMON_ARGS EDGE_PRESERVATION

  - ### EDGE_WEIGHT_COMPARATOR

    public static final ArgumentsBundle.COMMON_ARGS EDGE_WEIGHT_COMPARATOR

- ## Field Details

  - ### desc

    private String desc
    A String description of the enum.

- ## Constructor Details

  - ### COMMON_ARGS

    private COMMON_ARGS(String desc)

- ## Method Details

  - ### values

    public static ArgumentsBundle.COMMON_ARGS[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

    public static ArgumentsBundle.COMMON_ARGS 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

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Enum<ArgumentsBundle.COMMON_ARGS>`