Package io.quarkus.domino

Interface ProductInfo

All Known Subinterfaces:

ProductInfo.Mutable

All Known Implementing Classes:

ProductInfoImpl, ProductInfoImpl.Builder

public interface ProductInfo

This type would mostly map to a Cyclone DX component

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProductInfo.Mutable

Method Summary

Modifier and Type	Method	Description
static ProductInfo.Mutable	builder()
static ProductInfo	fromFile(Path path)	Read build info from the specified file
static ProductInfo	fromStream(InputStream inputStream)	Read config from an input stream
String	getCpe()
String	getDescription()
String	getGroup()
String	getId()
String	getName()
String	getPurl()
ProductReleaseNotes	getReleaseNotes()
String	getStream()
String	getType()
String	getVersion()
default ProductInfo.Mutable	mutable()
static ProductInfo.Mutable	mutableFromFile(Path path)	Read config from the specified file
default void	persist(Path p)	Persist this configuration to the specified file.

Method Detail

getId

String getId()

getStream

String getStream()

getGroup

String getGroup()

getName

String getName()

getType

String getType()

getVersion

String getVersion()

getPurl

String getPurl()

getCpe

String getCpe()

getDescription

String getDescription()

getReleaseNotes

ProductReleaseNotes getReleaseNotes()

mutable

default ProductInfo.Mutable mutable()

persist

default void persist(Path p)
              throws IOException

Persist this configuration to the specified file.

Parameters:

p - Target path

Throws:

IOException - if the specified file can not be written to.

builder

static ProductInfo.Mutable builder()

Returns:

a new mutable instance

fromFile

static ProductInfo fromFile(Path path)
                     throws IOException

Read build info from the specified file

Parameters:

path - File to read from (yaml or json)

Returns:

read-only ProductInfo object

Throws:

IOException - in case of a failure

mutableFromFile

static ProductInfo.Mutable mutableFromFile(Path path)
                                    throws IOException

Read config from the specified file

Parameters:

path - File to read from (yaml or json)

Returns:

mutable ProductInfo instance

Throws:

IOException - in case of a failure

fromStream

static ProductInfo fromStream(InputStream inputStream)
                       throws IOException

Read config from an input stream

Parameters:

inputStream - input stream to read from

Returns:

read-only ProductInfo object (empty/default for an empty file)

Throws:

IOException - in case of a failure