Module org.refcodes.runtime

Package org.refcodes.runtime

Enum Class NativeImageCode

java.lang.Object

java.lang.Enum<NativeImageCode>

org.refcodes.runtime.NativeImageCode

All Implemented Interfaces:

Serializable, Comparable<NativeImageCode>, Constable, org.refcodes.mixin.ValueAccessor<String>

public enum NativeImageCode
extends Enum<NativeImageCode>
implements org.refcodes.mixin.ValueAccessor<String>

Defines the values of the SystemProperty.NATIVE_IMAGE_CODE system property.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUILDTIME	If the property SystemProperty.NATIVE_IMAGE_CODE returns BUILDTIME the code is executing at image runtime.
RUNTIME	If the property SystemProperty.NATIVE_IMAGE_CODE returns RUNTIME the code is executing in the context of image building (e.g. in a static initializer of a class that will be contained in the image).

Method Summary

Modifier and Type	Method	Description
String	getValue()
static boolean	isBuildtime()	Determines whether we are invoked upon buildtime (???)
static boolean	isRuntime()	Determines whether we are inside an executing native image, e.g. the SystemProperty.NATIVE_IMAGE_CODE's value evaluates to RUNTIME's value.
static NativeImageCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NativeImageCode[]	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

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Enum Constant Details

RUNTIME

public static final NativeImageCode RUNTIME

If the property SystemProperty.NATIVE_IMAGE_CODE returns RUNTIME the code is executing in the context of image building (e.g. in a static initializer of a class that will be contained in the image).

BUILDTIME

public static final NativeImageCode BUILDTIME

If the property SystemProperty.NATIVE_IMAGE_CODE returns BUILDTIME the code is executing at image runtime.

Method Details

values

public static NativeImageCode[] 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 NativeImageCode 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

getValue

public String getValue()

Specified by:

getValue in interface org.refcodes.mixin.ValueAccessor<String>

isRuntime

public static boolean isRuntime()

Determines whether we are inside an executing native image, e.g. the SystemProperty.NATIVE_IMAGE_CODE's value evaluates to RUNTIME's value.

Returns:

True in case we are inside an executing native image.

isBuildtime

public static boolean isBuildtime()

Determines whether we are invoked upon buildtime (???), e.g. the SystemProperty.NATIVE_IMAGE_CODE's value evaluates to BUILDTIME's value.

Returns:

True in case we are invoked upon buildtime (???).