Package io.quarkus.deployment.builditem

Class LaunchModeBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.SimpleBuildItem

io.quarkus.deployment.builditem.LaunchModeBuildItem

public final class LaunchModeBuildItem
extends SimpleBuildItem

Indicates the type of launch.

Constructor Summary

Constructors

Constructor	Description
LaunchModeBuildItem(LaunchMode launchMode, Optional<DevModeType> devModeType, boolean auxiliaryApplication, Optional<DevModeType> auxiliaryDevModeType, boolean test)

Method Summary

Modifier and Type	Method	Description
Optional<DevModeType>	getAuxiliaryDevModeType()	The dev mode type of the main application.
Optional<DevModeType>	getDevModeType()	The development mode type.
LaunchMode	getLaunchMode()
boolean	isAuxiliaryApplication()	An Auxiliary Application is a second application running in the same JVM as a primary application.
boolean	isNotLocalDevModeType()	Whether the development mode type is not local.
boolean	isTest()	If this is a test.

Methods inherited from class java.lang.Object

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

Constructor Details

LaunchModeBuildItem

public LaunchModeBuildItem(LaunchMode launchMode,
 Optional<DevModeType> devModeType,
 boolean auxiliaryApplication,
 Optional<DevModeType> auxiliaryDevModeType,
 boolean test)

Method Details

getLaunchMode

public LaunchMode getLaunchMode()

getDevModeType

public Optional<DevModeType> getDevModeType()

The development mode type.

Note that even for NORMAL launch modes this could be generating an application for the local side of remote dev mode, so this may be set even for launch mode normal.

isNotLocalDevModeType

public boolean isNotLocalDevModeType()

Whether the development mode type is not local.

Returns:

true if getDevModeType() is not DevModeType.LOCAL

isAuxiliaryApplication

public boolean isAuxiliaryApplication()

An Auxiliary Application is a second application running in the same JVM as a primary application.

Currently, this is done to allow running tests in dev mode, while the main dev mode process continues to run.

getAuxiliaryDevModeType

public Optional<DevModeType> getAuxiliaryDevModeType()

The dev mode type of the main application.

isTest

public boolean isTest()

If this is a test. Dev mode tests don't launch with a launch mode TEST, so this can be used to determine if we are in a dev mode test.