Package io.quarkus.runtime

Enum Class ImageMode

java.lang.Object

java.lang.Enum<ImageMode>

io.quarkus.runtime.ImageMode

All Implemented Interfaces:

Serializable, Comparable<ImageMode>, Constable

public enum ImageMode
extends Enum<ImageMode>

The image execution mode of the application.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JVM	The image mode which indicates that the application is running in a standard JVM.
NATIVE_BUILD	The image mode which indicates that the application is currently executing the build phase of a native static image.
NATIVE_RUN	The image mode which indicates that the application is a native static image which is currently running on a target system.

Method Summary

Modifier and Type	Method	Description
static ImageMode	current()	Get the current image mode.
boolean	isNativeImage()	Determine whether the application image is a native static image.
static ImageMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

JVM

public static final ImageMode JVM

The image mode which indicates that the application is running in a standard JVM.

NATIVE_BUILD

public static final ImageMode NATIVE_BUILD

The image mode which indicates that the application is currently executing the build phase of a native static image.

NATIVE_RUN

public static final ImageMode NATIVE_RUN

The image mode which indicates that the application is a native static image which is currently running on a target system.

Method Details

values

public static ImageMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ImageMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isNativeImage

public boolean isNativeImage()

Determine whether the application image is a native static image.

Returns:

true if the application image is a native static image, or false otherwise

current

public static ImageMode current()

Get the current image mode. Note that it is possible for the image mode to change during the lifetime of an application.

Returns:

the image mode (not null)