Class BillOfMaterials

java.lang.Object

io.spring.initializr.generator.buildsystem.BillOfMaterials

public class BillOfMaterials
extends Object

A Bill of Materials (BOM) definition to be declared in a project's build configuration.

Author:

Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BillOfMaterials.Builder	Builder for a Bill of Materials.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BillOfMaterials(BillOfMaterials.Builder builder)

Method Summary

Modifier and Type	Method	Description
String	getArtifactId()	Return the artifact ID of the bom.
String	getGroupId()	Return the group ID of the bom.
int	getOrder()	Return the order of this bom relative to other boms.
@Nullable VersionReference	getVersion()	Return the version reference of the bom.
static BillOfMaterials.Builder	withCoordinates(String groupId, String artifactId)	Initialize a new BOM BillOfMaterials.Builder with the specified coordinates.

Methods inherited from class Object

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

Constructor Details

BillOfMaterials

protected BillOfMaterials(BillOfMaterials.Builder builder)

Method Details

withCoordinates

public static BillOfMaterials.Builder withCoordinates(String groupId,
 String artifactId)

Initialize a new BOM BillOfMaterials.Builder with the specified coordinates.

Parameters:

groupId - the group ID of the bom

artifactId - the artifact ID of the bom

Returns:

a new builder

getGroupId

public String getGroupId()

Return the group ID of the bom.

Returns:

the group ID

getArtifactId

public String getArtifactId()

Return the artifact ID of the bom.

Returns:

the artifact ID

getVersion

public @Nullable VersionReference getVersion()

Return the version reference of the bom. Can be a fixed value or refer to a property.

Returns:

the version reference

getOrder

public int getOrder()

Return the order of this bom relative to other boms.

Returns:

the bom order