Top Description Fields Methods
java.lang.classfile

public non-sealed Interface CodeTransform

extends ClassFileTransform<CodeTransform, CodeElement, CodeBuilder>
Known Direct Subinterfaces
java.lang.classfile.components.CodeLocalsShifter, java.lang.classfile.components.CodeRelabeler, java.lang.classfile.components.CodeStackTracker, jdk.internal.classfile.impl.TransformImpl.UnresolvedCodeTransform
Annotations
@PreviewFeature
feature:CLASSFILE_API
@FunctionalInterface
Imports
java.util.function.Consumer, .Supplier, jdk.internal.classfile.impl.TransformImpl, jdk.internal.javac.PreviewFeature

Preview

Second Preview of ClassFile API (JEP 466).

Programs can only use CodeTransform when preview features are enabled.
Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

A transformation on streams of CodeElement.
Since
22
See Also
ClassFileTransform

Field Summary

Modifier and TypeField and Description
public static final CodeTransform
ACCEPT_ALL

A code transform that sends all elements to the builder.

Method Summary

Modifier and TypeMethod and Description
public default CodeTransform
andThen(CodeTransform
the downstream transform
t
)

Implements java.lang.classfile.ClassFileTransform.andThen.

Chain this transform with another; elements presented to the builder of this transform will become the input to the next transform.

public static CodeTransform

Returns:

the code transform
endHandler
(Consumer<CodeBuilder>
the function to call when transformation is complete
finisher
)

Create a code transform that passes each element through to the builder, and calls the specified function when transformation is complete.

public static CodeTransform

Returns:

the stateful code transform
ofStateful
(Supplier<CodeTransform>
a Supplier that produces a fresh transform object for each traversal
supplier
)

Create a stateful code transform from a Supplier.

public default ClassFileTransform.ResolvedTransform<CodeElement>
resolve(CodeBuilder
the builder to bind to
builder
)

Implements java.lang.classfile.ClassFileTransform.resolve.

Bind a transform to a builder.

Inherited from java.lang.classfile.ClassFileTransform:
acceptatEndatStart

Field Detail

ACCEPT_ALLback to summary
public static final CodeTransform ACCEPT_ALL

A code transform that sends all elements to the builder.

Method Detail

andThenback to summary
public default CodeTransform andThen(CodeTransform t)

Implements java.lang.classfile.ClassFileTransform.andThen.

Doc from java.lang.classfile.ClassFileTransform.andThen.

Chain this transform with another; elements presented to the builder of this transform will become the input to the next transform.

Implementation Specification

The default implementation returns this code transform chained with another code transform from the argument. Chaining of two transforms requires to involve a chained builder serving as a target builder for this transform and also as a source of elements for the downstream transform.

Parameters
t:CodeTransform

the downstream transform

Returns:CodeTransform

the chained transform

Annotations
@Override
endHandlerback to summary
public static CodeTransform endHandler(Consumer<CodeBuilder> finisher)

Create a code transform that passes each element through to the builder, and calls the specified function when transformation is complete.

Parameters
finisher:Consumer<CodeBuilder>

the function to call when transformation is complete

Returns:CodeTransform

the code transform

ofStatefulback to summary
public static CodeTransform ofStateful(Supplier<CodeTransform> supplier)

Create a stateful code transform from a Supplier. The supplier will be invoked for each transformation.

Parameters
supplier:Supplier<CodeTransform>

a Supplier that produces a fresh transform object for each traversal

Returns:CodeTransform

the stateful code transform

resolveback to summary
public default ClassFileTransform.ResolvedTransform<CodeElement> resolve(CodeBuilder builder)

Implements java.lang.classfile.ClassFileTransform.resolve.

Doc from java.lang.classfile.ClassFileTransform.resolve.

Bind a transform to a builder. If the transform is chained, intermediate builders are created for each chain link. If the transform is stateful (see, e.g., ClassTransform#ofStateful(Supplier)), the supplier is invoked to get a fresh transform object.

This method is a low-level method that should rarely be used by user code; most of the time, user code should prefer ClassFileBuilder#transform(CompoundElement, ClassFileTransform), which resolves the transform and executes it on the current builder.

Implementation Specification

The default implementation returns a resolved transform bound to the given code builder.

Parameters
builder:CodeBuilder

the builder to bind to

Returns:ClassFileTransform.ResolvedTransform<CodeElement>

the bound result

Annotations
@Override