Package com.cloudbees.jenkins.support.api

Enum Component.ComponentCategory

java.lang.Object

java.lang.Enum<Component.ComponentCategory>

com.cloudbees.jenkins.support.api.Component.ComponentCategory

All Implemented Interfaces:

Serializable, Comparable<Component.ComponentCategory>

Enclosing class:

Component

public static enum Component.ComponentCategory
extends Enum<Component.ComponentCategory>

Categories supported by this version of support-core

Since:

TODO

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGENT	For components related to the agents, their configuration and other bits.
CONTROLLER	For components related to the controller, its configuration and other bits.
LOGS	For components related to the logging system or the logs themself.
MISC	Anything that doesn't fit any other categories.
PLATFORM	For components related to how the controller is running and where it is running.
UNCATEGORIZED	The default category.

Method Summary

Modifier and Type	Method	Description
String	getLabel()
static Component.ComponentCategory	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Component.ComponentCategory[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AGENT

public static final Component.ComponentCategory AGENT

For components related to the agents, their configuration and other bits.

CONTROLLER

public static final Component.ComponentCategory CONTROLLER

For components related to the controller, its configuration and other bits.

LOGS

public static final Component.ComponentCategory LOGS

For components related to the logging system or the logs themself.

MISC

public static final Component.ComponentCategory MISC

Anything that doesn't fit any other categories.

PLATFORM

public static final Component.ComponentCategory PLATFORM

For components related to how the controller is running and where it is running.

UNCATEGORIZED

public static final Component.ComponentCategory UNCATEGORIZED

The default category. This shouldn't be explicitly used.

Method Detail

values

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

Returns:

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

valueOf

public static Component.ComponentCategory 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

getLabel

@NonNull
public String getLabel()