Enum Class UnresolvedMetadata

java.lang.Object

java.lang.Enum<UnresolvedMetadata>

org.cyclonedx.gradle.model.UnresolvedMetadata

All Implemented Interfaces:

Serializable, Comparable<UnresolvedMetadata>, Constable

public enum UnresolvedMetadata
extends Enum<UnresolvedMetadata>

Why a component's Maven metadata could not be read, recorded on the component so that a consumer can tell a component that declares nothing apart from one whose metadata was unavailable.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODEL_INCOMPLETE	The effective model could not be completed, and which of its inputs failed is not established.
PARENT_UNRESOLVED	The POM was read, and the parent POM it declares was not obtained.
POM_UNPARSEABLE	A POM was returned but could not be read as one.
POM_UNRESOLVED	The repository returned no usable POM artifact for the component.

Method Summary

Modifier and Type	Method	Description
String	getValue()	The value written to the component property; part of the SBOM output contract.
static UnresolvedMetadata	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnresolvedMetadata[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

POM_UNRESOLVED

public static final UnresolvedMetadata POM_UNRESOLVED

The repository returned no usable POM artifact for the component.

POM_UNPARSEABLE

public static final UnresolvedMetadata POM_UNPARSEABLE

A POM was returned but could not be read as one.

PARENT_UNRESOLVED

public static final UnresolvedMetadata PARENT_UNRESOLVED

The POM was read, and the parent POM it declares was not obtained. Reported only where the failure identifies that parent; what the component declares itself is still reported, what it would have inherited is missing.

MODEL_INCOMPLETE

public static final UnresolvedMetadata MODEL_INCOMPLETE

The effective model could not be completed, and which of its inputs failed is not established. An import that could not be read arrives here, as does a parent the failure does not identify. What the component declares itself is still reported.

Method Details

values

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

getValue

public String getValue()

The value written to the component property; part of the SBOM output contract.