APIdia Launch Partner
Top Description Fields Methods
java.lang.classfile

public non-sealed Interface FieldTransform

extends ClassFileTransform<FieldTransform, FieldElement, FieldBuilder>
Known Direct Subinterfaces
jdk.internal.classfile.impl.TransformImpl.UnresolvedFieldTransform
Annotations
@FunctionalInterface
Imports
java.util.function.Consumer, .Predicate, .Supplier, jdk.internal.classfile.impl.TransformImpl

A transformation on streams of FieldElement.

Refer to ClassFileTransform for general guidance and caution around the use of transforms for structures in the class file format.

A field transform can be lifted to a class transform via ClassTransform#transformingFields(FieldTransform), transforming only the FieldModel among the class members and passing all other elements to the builders.

Since
24
See Also
FieldModel, ClassBuilder#transformField

Field Summary

Modifier and TypeField and Description
public static final FieldTransform
ACCEPT_ALL

A field transform that passes all elements to the builder.

Method Summary

Modifier and TypeMethod and Description
public default FieldTransform
andThen(FieldTransform 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 FieldTransform

Returns:

the field transform
dropping
(Predicate<FieldElement>
the predicate that determines which elements to drop
filter
)

Creates a field transform that passes each element through to the builder, except for those that the supplied Predicate is true for.

public static FieldTransform

Returns:

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

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

public static FieldTransform

Returns:

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

Creates a stateful field transform from a Supplier.

Inherited from java.lang.classfile.ClassFileTransform:
acceptatEndatStart

Field Detail

ACCEPT_ALLback to summary
public static final FieldTransform ACCEPT_ALL

A field transform that passes all elements to the builder.

Method Detail

andThenback to summary
public default FieldTransform andThen(FieldTransform 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.

This method is implemented by the Class-File API. Users usually don't have sufficient access to Class-File API functionalities to override this method correctly for generic downstream transforms.

Implementation Specification

The default implementation returns this field transform chained with another field 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.

Annotations
@Override
droppingback to summary
public static FieldTransform dropping(Predicate<FieldElement> filter)

Creates a field transform that passes each element through to the builder, except for those that the supplied Predicate is true for.

Parameters
filter:Predicate<FieldElement>

the predicate that determines which elements to drop

Returns:FieldTransform

the field transform

endHandlerback to summary
public static FieldTransform endHandler(Consumer<FieldBuilder> finisher)

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

Parameters
finisher:Consumer<FieldBuilder>

the function to call when transformation is complete

Returns:FieldTransform

the field transform

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

Creates a stateful field transform from a Supplier. The supplier will be invoked for each transformation.

Parameters
supplier:Supplier<FieldTransform>

a Supplier that produces a fresh transform object for each traversal

Returns:FieldTransform

the stateful field transform