Package org.apache.ant.cyclonedx

Class CompositionAggregate

java.lang.Object

org.apache.tools.ant.types.EnumeratedAttribute

org.apache.ant.cyclonedx.CompositionAggregate

public class CompositionAggregate
extends org.apache.tools.ant.types.EnumeratedAttribute

CycloneDX composition's aggregate type.

Specifies an aggregate type that describes how complete a relationship of a composition is.

Accepts the enum constants like COMPLETE as well as the lowercase version complete. The values are directly provided by CycloneDX Core's enum.

Since:

CycloneDX Antlib 0.2

Field Summary

Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute

value

Constructor Summary

Constructors

Constructor	Description
CompositionAggregate()

Method Summary

Modifier and Type	Method	Description
static CompositionAggregate	from(org.cyclonedx.model.Composition.Aggregate aggregate)	Maps a CycloneDX Aggregate.
org.cyclonedx.model.Composition.Aggregate	getAggregate()	Translates this instance to a Composition.Aggregate.
java.lang.String[]	getValues()

Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute

containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompositionAggregate

public CompositionAggregate()

Method Detail

getValues

public java.lang.String[] getValues()

Specified by:

getValues in class org.apache.tools.ant.types.EnumeratedAttribute

getAggregate

public org.cyclonedx.model.Composition.Aggregate getAggregate()

Translates this instance to a Composition.Aggregate.

Returns:

translated aggregate

Throws:

org.apache.tools.ant.BuildException - if the value can not be translated.

from

public static CompositionAggregate from(org.cyclonedx.model.Composition.Aggregate aggregate)

Maps a CycloneDX Aggregate.

Parameters:

aggregate - CycloneDX aggregate.

Returns:

translated aggregate