Package io.quarkus.devtools.testing.codestarts

Class QuarkusCodestartTestBuilder

java.lang.Object

io.quarkus.devtools.testing.codestarts.QuarkusCodestartTestBuilder

public class QuarkusCodestartTestBuilder
extends Object

Builder for QuarkusCodestartTest

Field Summary

Fields

Modifier and Type	Field	Description
Collection<String>	artifacts
Map<String,Object>	data
static String	DEFAULT_PACKAGE_FOR_TESTING
String	packageName
String	quarkusBomGroupId
String	quarkusBomVersion

Constructor Summary

Constructors

Constructor	Description
QuarkusCodestartTestBuilder()

Method Summary

Modifier and Type	Method	Description
QuarkusCodestartTestBuilder	addArtifacts(Collection<String> artifacts)	Add artifacts which contains codestarts
QuarkusCodestartTest	build()
QuarkusCodestartTestBuilder	buildTool(BuildTool buildTool)	Set the build tool to use for testing (default is maven)
QuarkusCodestartTestBuilder	codestarts(String... codestarts)	Set the list of codestarts that should be added to the generated projects
QuarkusCodestartTestBuilder	extension(io.quarkus.maven.dependency.ArtifactCoords extension)	Set the extension (and its codestarts) that should be added to the generated projects
QuarkusCodestartTestBuilder	extension(io.quarkus.maven.dependency.ArtifactKey extension)	Set the extension (and its codestarts) that should be added to the generated projects
QuarkusCodestartTestBuilder	extensionCatalog(io.quarkus.registry.catalog.ExtensionCatalog extensionCatalog)	Specify a custom extensionCatalog, by default it will use the test registry to get it.
QuarkusCodestartTestBuilder	extensions(Collection<io.quarkus.maven.dependency.ArtifactCoords> extensions)	Set the list of extensions (and their codestarts) that should be added to the generated projects
QuarkusCodestartTestBuilder	languages(QuarkusCodestartCatalog.Language... languages)	Set the list of languages in which we should generated projects
QuarkusCodestartTestBuilder	packageName(String packageName)	Set the package name to use in the generated projects
QuarkusCodestartTestBuilder	putData(DataKey key, Object value)	Add some custom codestart data for testing
QuarkusCodestartTestBuilder	putData(String key, Object value)	Add some custom codestart data for testing
QuarkusCodestartTestBuilder	quarkusCodestartCatalog(QuarkusCodestartCatalog quarkusCodestartCatalog)	Specify a custom quarkus codestart catalog, by default it will use the extension catalog to get it.
QuarkusCodestartTestBuilder	setupStandaloneExtensionTest()	Automatically set up the extension catalog for a standalone extension.
QuarkusCodestartTestBuilder	setupStandaloneExtensionTest(String extensionGA)	Automatically set up the extension catalog for a standalone extension.
QuarkusCodestartTestBuilder	standaloneExtensionCatalog()	Deprecated.
QuarkusCodestartTestBuilder	standaloneExtensionCatalog(String quarkusBomGroupId, String quarkusBomVersion)	Deprecated, for removal: This API element is subject to removal in a future version.
QuarkusCodestartTestBuilder	withQuarkusBom(String quarkusBomGroupId, String quarkusBomVersion)
QuarkusCodestartTestBuilder	withQuarkusBomVersion(String quarkusBomVersion)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PACKAGE_FOR_TESTING

public static final String DEFAULT_PACKAGE_FOR_TESTING

See Also:

Constant Field Values

data

public Map<String,Object> data

artifacts

public Collection<String> artifacts

packageName

public String packageName

quarkusBomGroupId

public String quarkusBomGroupId

quarkusBomVersion

public String quarkusBomVersion

Constructor Detail

QuarkusCodestartTestBuilder

public QuarkusCodestartTestBuilder()

Method Detail

packageName

public QuarkusCodestartTestBuilder packageName(String packageName)

Set the package name to use in the generated projects

Parameters:

packageName -

Returns:

codestarts

public QuarkusCodestartTestBuilder codestarts(String... codestarts)

Set the list of codestarts that should be added to the generated projects

Parameters:

codestarts - the list of codestarts

Returns:

languages

public QuarkusCodestartTestBuilder languages(QuarkusCodestartCatalog.Language... languages)

Set the list of languages in which we should generated projects

Parameters:

languages - the list of languages

Returns:

buildTool

public QuarkusCodestartTestBuilder buildTool(BuildTool buildTool)

Set the build tool to use for testing (default is maven)

Parameters:

buildTool -

Returns:

putData

public QuarkusCodestartTestBuilder putData(String key,
                                           Object value)

Add some custom codestart data for testing

Parameters:

key -

value -

Returns:

putData

public QuarkusCodestartTestBuilder putData(DataKey key,
                                           Object value)

Add some custom codestart data for testing

Parameters:

key -

value -

Returns:

extensions

public QuarkusCodestartTestBuilder extensions(Collection<io.quarkus.maven.dependency.ArtifactCoords> extensions)

Set the list of extensions (and their codestarts) that should be added to the generated projects

Parameters:

extensions - the list of extensions

Returns:

extension

public QuarkusCodestartTestBuilder extension(io.quarkus.maven.dependency.ArtifactCoords extension)

Set the extension (and its codestarts) that should be added to the generated projects

Parameters:

extension - the extension

Returns:

extension

public QuarkusCodestartTestBuilder extension(io.quarkus.maven.dependency.ArtifactKey extension)

Set the extension (and its codestarts) that should be added to the generated projects

Parameters:

extension - the extension

Returns:

addArtifacts

public QuarkusCodestartTestBuilder addArtifacts(Collection<String> artifacts)

Add artifacts which contains codestarts

Parameters:

artifacts - the artifacts coords

Returns:

quarkusCodestartCatalog

public QuarkusCodestartTestBuilder quarkusCodestartCatalog(QuarkusCodestartCatalog quarkusCodestartCatalog)

Specify a custom quarkus codestart catalog, by default it will use the extension catalog to get it.

Parameters:

quarkusCodestartCatalog - the quarkusCodestartCatalog

Returns:

extensionCatalog

public QuarkusCodestartTestBuilder extensionCatalog(io.quarkus.registry.catalog.ExtensionCatalog extensionCatalog)

Specify a custom extensionCatalog, by default it will use the test registry to get it.

Parameters:

extensionCatalog -

Returns:

withQuarkusBomVersion

public QuarkusCodestartTestBuilder withQuarkusBomVersion(String quarkusBomVersion)

withQuarkusBom

public QuarkusCodestartTestBuilder withQuarkusBom(String quarkusBomGroupId,
                                                  String quarkusBomVersion)

setupStandaloneExtensionTest

public QuarkusCodestartTestBuilder setupStandaloneExtensionTest()

Automatically set up the extension catalog for a standalone extension.

setupStandaloneExtensionTest

public QuarkusCodestartTestBuilder setupStandaloneExtensionTest(String extensionGA)

Automatically set up the extension catalog for a standalone extension. Add the given extension using the version from the current project.

Parameters:

extensionGA - the extension groupId:ArtifactId

standaloneExtensionCatalog

@Deprecated(forRemoval=true)
public QuarkusCodestartTestBuilder standaloneExtensionCatalog(String quarkusBomGroupId,
                                                              String quarkusBomVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

Use withQuarkusBom instead

standaloneExtensionCatalog

@Deprecated
public QuarkusCodestartTestBuilder standaloneExtensionCatalog()

Deprecated.

Use setupStandaloneExtensionTest instead

build

public QuarkusCodestartTest build()