org.cyclonedx.model

Enum Component.Scope

java.lang.Object

java.lang.Enum<Component.Scope>

org.cyclonedx.model.Component.Scope

All Implemented Interfaces:

Serializable, Comparable<Component.Scope>

Enclosing class:

Component

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDED
OPTIONAL
REQUIRED

Method Summary

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

REQUIRED

public static final Component.Scope REQUIRED

OPTIONAL

public static final Component.Scope OPTIONAL

EXCLUDED

public static final Component.Scope EXCLUDED

Method Detail

values

public static Component.Scope[] 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.Scope c : Component.Scope.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.Scope 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

getScopeName

public String getScopeName()