Package net.bytebuddy.build

Class ToStringPlugin

java.lang.Object

net.bytebuddy.build.ToStringPlugin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Plugin, Plugin.Factory, ElementMatcher<TypeDescription>

@Enhance
public class ToStringPlugin
extends java.lang.Object
implements Plugin, Plugin.Factory

A build tool plugin that adds a Object.toString() and method to a class if the ToStringPlugin.Enhance annotation is present and no explicit method declaration was added. This plugin does not need to be closed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToStringPlugin.Enhance	Instructs the ToStringPlugin to generate a Object.toString() method for the annotated class unless this method is already declared explicitly.
static interface	ToStringPlugin.Exclude	Determines that the annotated field is excluded from a string representation of the ToStringPlugin.

Nested classes/interfaces inherited from interface net.bytebuddy.matcher.ElementMatcher

ElementMatcher.Junction<S>

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin

Plugin.Engine, Plugin.Factory, Plugin.ForElementMatcher, Plugin.NoOp, Plugin.WithInitialization, Plugin.WithPreprocessor

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin.Factory

Plugin.Factory.Simple, Plugin.Factory.UsingReflection

Field Summary

Fields

Modifier and Type	Field	Description
private static MethodDescription.InDefinedShape	ENHANCE_INCLUDE_SYNTHETIC_FIELDS	A description of the ToStringPlugin.Enhance.includeSyntheticFields() method.
private static MethodDescription.InDefinedShape	ENHANCE_PREFIX	A description of the ToStringPlugin.Enhance.prefix() method.

Constructor Summary

Constructors

Constructor	Description
ToStringPlugin()

Method Summary

Modifier and Type	Method	Description
DynamicType.Builder<?>	apply(DynamicType.Builder<?> builder, TypeDescription typeDescription, ClassFileLocator classFileLocator)	Applies this plugin.
void	close()
Plugin	make()	Returns a plugin that can be used for a transformation and which is subsequently closed.
boolean	matches(TypeDescription target)	Matches a target against this element matcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENHANCE_PREFIX

private static final MethodDescription.InDefinedShape ENHANCE_PREFIX

A description of the ToStringPlugin.Enhance.prefix() method.

ENHANCE_INCLUDE_SYNTHETIC_FIELDS

private static final MethodDescription.InDefinedShape ENHANCE_INCLUDE_SYNTHETIC_FIELDS

A description of the ToStringPlugin.Enhance.includeSyntheticFields() method.

Constructor Detail

ToStringPlugin

public ToStringPlugin()

Method Detail

make

public Plugin make()

Returns a plugin that can be used for a transformation and which is subsequently closed.

Specified by:

make in interface Plugin.Factory

Returns:

The plugin to use for type transformations.

matches

public boolean matches(@MaybeNull
                       TypeDescription target)

Matches a target against this element matcher.

Specified by:

matches in interface ElementMatcher<TypeDescription>

Parameters:

target - The instance to be matched or null.

Returns:

true if the given element is matched by this matcher or false otherwise.

apply

public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder,
                                    TypeDescription typeDescription,
                                    ClassFileLocator classFileLocator)

Applies this plugin.

Specified by:

apply in interface Plugin

Parameters:

builder - The builder to use as a basis for the applied transformation.

typeDescription - The type being transformed.

classFileLocator - A class file locator that can locate other types in the scope of the project.

Returns:

The supplied builder with additional transformations registered.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable