net.sourceforge.plantumldependency.cli.main.option.display.argument

Enum Display

java.lang.Object

java.lang.Enum<Display>

net.sourceforge.plantumldependency.cli.main.option.display.argument.Display

All Implemented Interfaces:

Serializable, Comparable<Display>

public enum Display
extends Enum<Display>

The enumeration which specifies display options.

Since:

1.0.0

Version:

1.3.0

Author:

Benjamin Croizet (

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSTRACT_CLASSES The display abstract classes argument.
ANNOTATIONS The display annotations argument.
CLASSES The display classes argument.
ENUMS The display enumerations argument.
EXTENSIONS The display extensions argument.
IMPLEMENTATIONS The display implementations argument.
IMPORTS The display imports argument.
INTERFACES The display interfaces argument.
NATIVE_METHODS The display native methods argument.
STATIC_IMPORTS The display static imports argument.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Display>	DISPLAY_OPTIONS The Set containing all displays options which are available.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getAllDisplayOptionsFullUsageDescriptions() Prints the all display options as a comma separated String of their full descriptions.
String	getFullUsageDescription() Gets the string containing the full display usage description.
static String	getFullUsageDescriptions(Set<Display> displayOptions) Build the string which contains the usage descriptions of all displays options which are available.
String	getUsageDescription() Gets the string containing the display usage description.
String	toString()
static Display	valueOf(String name) Returns the enum constant of this type with the specified name.
static Display[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABSTRACT_CLASSES

public static final Display ABSTRACT_CLASSES

The display abstract classes argument.

ANNOTATIONS

public static final Display ANNOTATIONS

The display annotations argument.

CLASSES

public static final Display CLASSES

The display classes argument.

ENUMS

public static final Display ENUMS

The display enumerations argument.

EXTENSIONS

public static final Display EXTENSIONS

The display extensions argument.

IMPLEMENTATIONS

public static final Display IMPLEMENTATIONS

The display implementations argument.

IMPORTS

public static final Display IMPORTS

The display imports argument.

INTERFACES

public static final Display INTERFACES

The display interfaces argument.

NATIVE_METHODS

public static final Display NATIVE_METHODS

The display native methods argument.

STATIC_IMPORTS

public static final Display STATIC_IMPORTS

The display static imports argument.

Field Detail

DISPLAY_OPTIONS

public static final Set<Display> DISPLAY_OPTIONS

The Set containing all displays options which are available.

Method Detail

values

public static Display[] 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 (Display c : Display.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Display 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

getAllDisplayOptionsFullUsageDescriptions

public static String getAllDisplayOptionsFullUsageDescriptions()

Prints the all display options as a comma separated String of their full descriptions.

Returns:

the comma separated String of all display options descriptions.

Since:

1.1.1

getFullUsageDescriptions

public static String getFullUsageDescriptions(Set<Display> displayOptions)

Build the string which contains the usage descriptions of all displays options which are available.

Parameters:

displayOptions - the Set of all displays options to get the full usage description from.

Returns:

the full usage description of all displays options.

Since:

1.1.1

getFullUsageDescription

public String getFullUsageDescription()

Gets the string containing the full display usage description.

Returns:

the full display usage description.

Since:

1.1.1

getUsageDescription

public String getUsageDescription()

Gets the string containing the display usage description.

Returns:

the display usage description.

Since:

1.1.1

toString

public String toString()

Overrides:

toString in class Enum<Display>

Since:

1.0.0