Package tools.PathplannerSearch

Enum Class Main.ARGUMENTS

java.lang.Object

java.lang.Enum<Main.ARGUMENTS>

tools.PathplannerSearch.Main.ARGUMENTS

All Implemented Interfaces:

Serializable, Comparable<Main.ARGUMENTS>, Constable, ArgumentEnum

Enclosing class:

Main

public static enum Main.ARGUMENTS
extends Enum<Main.ARGUMENTS>
implements ArgumentEnum

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
SEARCH_TERM
SEARCH_TYPE

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<?>	argumentType
private final Object	defaultValue
private final String	description

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ARGUMENTS(Class<?> argumentType, Object defaultValue, String description)

Method Summary

Modifier and Type	Method	Description
Class<?>	getArgumentType()	Gets the argument type.
Object	getDefaultValue()	Gets the default value for the argument.
String	getDescription()	Gets the description of the argument.
static Main.ARGUMENTS	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Main.ARGUMENTS[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEARCH_TERM

public static final Main.ARGUMENTS SEARCH_TERM

SEARCH_TYPE

public static final Main.ARGUMENTS SEARCH_TYPE

Field Details

argumentType

private final Class<?> argumentType

defaultValue

private final Object defaultValue

description

private final String description

Constructor Details

ARGUMENTS

private ARGUMENTS(Class<?> argumentType,
 Object defaultValue,
 String description)

Method Details

values

public static Main.ARGUMENTS[] 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 Main.ARGUMENTS 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

getArgumentType

public Class<?> getArgumentType()

Description copied from interface: ArgumentEnum

Gets the argument type.

Specified by:

getArgumentType in interface ArgumentEnum

Returns:

the argument type

getDefaultValue

public Object getDefaultValue()

Description copied from interface: ArgumentEnum

Gets the default value for the argument. This is used if the argument is missing or fails to parse. Can be null.

Specified by:

getDefaultValue in interface ArgumentEnum

Returns:

the default value

getDescription

public String getDescription()

Description copied from interface: ArgumentEnum

Gets the description of the argument. This is used for documentation purposes.

Specified by:

getDescription in interface ArgumentEnum

Returns:

the description