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

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

Access	Constructor and Description
public	ToStringPlugin()

Method Summary

Modifier and Type	Method and Description
public DynamicType.Builder<?>	apply(DynamicType.Builder<?> The builder to use as a basis for the applied transformation. builder, TypeDescription The type being transformed. typeDescription, ClassFileLocator A class file locator that can locate other types in the scope of the project. classFileLocator) Implements net.bytebuddy.build.Plugin.apply. Applies this plugin.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public Plugin	make() Implements net.bytebuddy.build.Plugin.Factory.make. Returns a plugin that can be used for a transformation and which is subsequently closed.
public boolean	matches(TypeDescription The instance to be matched or `null`. target) Implements net.bytebuddy.matcher.ElementMatcher.matches. Matches a target against this element matcher.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ENHANCE_INCLUDE_SYNTHETIC_FIELDS	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_INCLUDE_SYNTHETIC_FIELDS A description of the `Enhance#includeSyntheticFields()` method.

ENHANCE_PREFIX	back to summary
private static final MethodDescription.InDefinedShape ENHANCE_PREFIX A description of the `Enhance#prefix()` method.

Constructor Detail

ToStringPlugin	back to summary
public ToStringPlugin()

Method Detail

apply	back to summary
public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder, TypeDescription typeDescription, ClassFileLocator classFileLocator) Implements net.bytebuddy.build.Plugin.apply. Doc from net.bytebuddy.build.Plugin.apply. Applies this plugin. Parameters builder:DynamicType.Builder<?> The builder to use as a basis for the applied transformation. typeDescription:TypeDescription The type being transformed. classFileLocator:ClassFileLocator A class file locator that can locate other types in the scope of the project. Returns:DynamicType.Builder<?> The supplied builder with additional transformations registered.

apply

back to summary

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

Implements net.bytebuddy.build.Plugin.apply.

Doc from net.bytebuddy.build.Plugin.apply.

Applies this plugin.

Parameters

builder:DynamicType.Builder<?>: The builder to use as a basis for the applied transformation.
typeDescription:TypeDescription: The type being transformed.
classFileLocator:ClassFileLocator: A class file locator that can locate other types in the scope of the project.

Returns:DynamicType.Builder<?>

The supplied builder with additional transformations registered.

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`.

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

make	back to summary
public Plugin make() Implements net.bytebuddy.build.Plugin.Factory.make. Doc from net.bytebuddy.build.Plugin.Factory.make. Returns a plugin that can be used for a transformation and which is subsequently closed. Returns:Plugin The plugin to use for type transformations.

make

back to summary

public Plugin make()

Implements net.bytebuddy.build.Plugin.Factory.make.

Doc from net.bytebuddy.build.Plugin.Factory.make.

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

Returns:Plugin: The plugin to use for type transformations.

matches back to summary

matches	back to summary
public boolean matches(TypeDescription target) Implements net.bytebuddy.matcher.ElementMatcher.matches. Doc from net.bytebuddy.matcher.ElementMatcher.matches. Matches a target against this element matcher. Parameters target:TypeDescription The instance to be matched or `null`. Returns:boolean `true` if the given element is matched by this matcher or `false` otherwise.

public boolean matches(TypeDescription target)

Implements net.bytebuddy.matcher.ElementMatcher.matches.

Doc from net.bytebuddy.matcher.ElementMatcher.matches.

Matches a target against this element matcher.

Parameters

target:TypeDescription: The instance to be matched or null.

Returns:boolean

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

net.bytebuddy.build back to summary

public @Interface ToStringPlugin.Enhance

Annotations

extends Annotation

@Documented
@Target:TYPE
@Retention:RUNTIME

Instructs the ToStringPlugin to generate a Object#toString() method for the annotated class unless this method is already declared explicitly.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ToStringPlugin.Enhance.Prefix A strategy for defining a prefix.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if synthetic fields should be included. includeSyntheticFields() Determines if synthetic fields should be included in the string representation.
public ToStringPlugin.Enhance.Prefix	Returns: The prefix to use. prefix() Determines the prefix to be used for the string representation prior to adding field values.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

includeSyntheticFields back to summary

includeSyntheticFields	back to summary
public boolean includeSyntheticFields() Determines if synthetic fields should be included in the string representation. Returns:boolean `true` if synthetic fields should be included.

public boolean includeSyntheticFields()

Determines if synthetic fields should be included in the string representation.

Returns:boolean: true if synthetic fields should be included.

prefix	back to summary
public ToStringPlugin.Enhance.Prefix prefix() Determines the prefix to be used for the string representation prior to adding field values. Returns:ToStringPlugin.Enhance.Prefix The prefix to use.

prefix

back to summary

public ToStringPlugin.Enhance.Prefix prefix()

Determines the prefix to be used for the string representation prior to adding field values.

Returns:ToStringPlugin.Enhance.Prefix: The prefix to use.

net.bytebuddy.build back to summary

public final Enum ToStringPlugin.Enhance.Prefix

Class Inheritance

extends Enum<ToStringPlugin.Enhance.Prefix>

java.lang.Object
java.lang.Enum
net.bytebuddy.build.ToStringPlugin.Enhance.Prefix

A strategy for defining a prefix.

Field Summary

Modifier and Type	Field and Description
public static final ToStringPlugin.Enhance.Prefix	CANONICAL Determines the use of the canonical class name as a prefix.
public static final ToStringPlugin.Enhance.Prefix	FULLY_QUALIFIED Determines the use of a fully qualified class name as a prefix.
private final ToStringMethod.PrefixResolver.Default	prefixResolver The prefix resolver to use.
public static final ToStringPlugin.Enhance.Prefix	SIMPLE Determines the use of the simple class name as a prefix.

Constructor Summary

Access	Constructor and Description
private	Prefix(ToStringMethod.PrefixResolver.Default The prefix resolver to use. prefixResolver) Creates a new prefix.

Method Summary

Modifier and Type	Method and Description
protected ToStringMethod.PrefixResolver.Default	Returns: The prefix resolver to use. getPrefixResolver() Returns the prefix resolver to use.
public static ToStringPlugin.Enhance.Prefix	valueOf(String name)
public static ToStringPlugin.Enhance.Prefix[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CANONICAL	back to summary
public static final ToStringPlugin.Enhance.Prefix CANONICAL Determines the use of the canonical class name as a prefix.

FULLY_QUALIFIED	back to summary
public static final ToStringPlugin.Enhance.Prefix FULLY_QUALIFIED Determines the use of a fully qualified class name as a prefix.

prefixResolver	back to summary
private final ToStringMethod.PrefixResolver.Default prefixResolver The prefix resolver to use.

SIMPLE	back to summary
public static final ToStringPlugin.Enhance.Prefix SIMPLE Determines the use of the simple class name as a prefix.

Constructor Detail

Prefix	back to summary
private Prefix(ToStringMethod.PrefixResolver.Default prefixResolver) Creates a new prefix. Parameters prefixResolver:ToStringMethod.PrefixResolver.Default The prefix resolver to use.

Prefix

back to summary

private Prefix(ToStringMethod.PrefixResolver.Default prefixResolver)

Creates a new prefix.

Parameters

prefixResolver:ToStringMethod.PrefixResolver.Default: The prefix resolver to use.

Method Detail

getPrefixResolver	back to summary
protected ToStringMethod.PrefixResolver.Default getPrefixResolver() Returns the prefix resolver to use. Returns:ToStringMethod.PrefixResolver.Default The prefix resolver to use.

getPrefixResolver

back to summary

protected ToStringMethod.PrefixResolver.Default getPrefixResolver()

Returns the prefix resolver to use.

Returns:ToStringMethod.PrefixResolver.Default: The prefix resolver to use.

valueOf	back to summary
public static ToStringPlugin.Enhance.Prefix valueOf(String name)

values	back to summary
public static ToStringPlugin.Enhance.Prefix[] values()

public Class ToStringPlugin

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public @Interface ToStringPlugin.Enhance

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum ToStringPlugin.Enhance.Prefix

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public @Interface ToStringPlugin.Exclude

Method Summary