Enum Class ClassFile.DeadCodeOption

java.lang.Object

java.lang.Enum<ClassFile.DeadCodeOption>

java.lang.classfile.ClassFile.DeadCodeOption

All Implemented Interfaces:: Serializable, ClassFile.Option, Comparable<ClassFile.DeadCodeOption>, Constable

Enclosing interface:: ClassFile

public static enum ClassFile.DeadCodeOption extends Enum<ClassFile.DeadCodeOption> implements ClassFile.Option

The option describing whether to patch out unreachable code for stack map generation. The default is PATCH_DEAD_CODE to automatically patch unreachable code and generate a valid stack map entry for the patched code.

The stack map generation process may fail when it encounters unreachable code and KEEP_DEAD_CODE is set. In such cases, users should set ClassFile.StackMapsOption.DROP_STACK_MAPS and provide their own stack maps that passes verification (JVMS Â§4.10.1).

See Java Virtual Machine Specification:

4.10.1 Verification by Type Checking

Since:

See Also:

Nested Class Summary

Nested classes/interfaces declared in class Enum

Enum.EnumDesc<E>

Modifier and Type	Class	Description
`static final class`	`Enum.EnumDesc<E extends Enum<E>>`	A nominal descriptor for an `enum` constant.

Enum Constant Summary

Enum Constant	Description
`KEEP_DEAD_CODE`	Keep the unreachable code for the accuracy of the generated `class` file.
`PATCH_DEAD_CODE`	Patch unreachable code with dummy code, and generate valid dummy stack map entries.

Method Summary

Modifier and Type	Method	Description
`static ClassFile.DeadCodeOption`	`valueOf(String name)`	Returns the enum constant of this class with the specified name.
`static ClassFile.DeadCodeOption[]`	`values()`	Returns an array containing the constants of this enum class, in the order they are declared.

Methods declared in class Enum

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

Modifier and Type	Method	Description
`protected final Object`	`clone()`	Throws CloneNotSupportedException.
`final int`	`compareTo(ClassFile.DeadCodeOption o)`	Compares this enum with the specified object for order.
`final Optional<Enum.EnumDesc<ClassFile.DeadCodeOption>>`	`describeConstable()`	Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
`final boolean`	`equals(Object other)`	Returns true if the specified object is equal to this enum constant.
`protected final void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal.
`final Class<ClassFile.DeadCodeOption>`	`getDeclaringClass()`	Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()`	Returns a hash code for this enum constant.
`final String`	`name()`	Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()`	Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()`	Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)`	Returns the enum constant of the specified enum class with the specified name.

Methods declared in class Object

getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Enum Constant Details

PATCH_DEAD_CODE

public static final ClassFile.DeadCodeOption PATCH_DEAD_CODE

Patch unreachable code with dummy code, and generate valid dummy stack map entries. This ensures the generated code can pass verification (JVMS Â§4.10.1).

KEEP_DEAD_CODE

public static final ClassFile.DeadCodeOption KEEP_DEAD_CODE

Keep the unreachable code for the accuracy of the generated


class

file. Users should set ClassFile.StackMapsOption.DROP_STACK_MAPS to prevent stack map generation from running and provide their own StackMapTableAttribute to a CodeBuilder.

Method Details

values

public static ClassFile.DeadCodeOption[] 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 ClassFile.DeadCodeOption 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

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.