Package za.co.wethinkcode.robots.cli.help

Enum Class HelpTopic

java.lang.Object

java.lang.Enum<HelpTopic>

za.co.wethinkcode.robots.cli.help.HelpTopic

All Implemented Interfaces:

Serializable, Comparable<HelpTopic>, Constable

public enum HelpTopic
extends Enum<HelpTopic>

The topics that the launch-help CLI command can be scoped to.

help with no argument shows every topic. help server or help client scopes the output to just that topic.

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
CLIENT
SERVER

Method Summary

Modifier and Type	Method	Description
static HelpTopic	fromArgument(String raw)	Resolves a raw CLI argument (e.g.
static HelpTopic	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HelpTopic[]	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

SERVER

public static final HelpTopic SERVER

CLIENT

public static final HelpTopic CLIENT

Method Details

values

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

fromArgument

public static HelpTopic fromArgument(String raw)

Resolves a raw CLI argument (e.g. "server", "CLIENT") to a HelpTopic.

Parameters:

raw - the raw argument text, case-insensitive

Returns:

the matching topic

Throws:

IllegalArgumentException - if the argument does not match a known topic