Class ToStringMethod

java.lang.Object

net.bytebuddy.implementation.ToStringMethod

All Implemented Interfaces:

InstrumentedType.Prepareable, Implementation

@Enhance
public class ToStringMethod
extends Object
implements Implementation

An implementation of Object.toString() that concatenates the String representation of all fields that are declared by a class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ToStringMethod.Appender	An appender to implement ToStringMethod.
static interface	ToStringMethod.PrefixResolver	A prefix resolver is responsible for providing a value that is prepended to a Object.toString() implementation.
protected static enum	ToStringMethod.ValueConsumer	A value consumer that is responsible for adding a field value to the string creating StringBuilder.

Nested classes/interfaces inherited from interface Implementation

Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target

Nested classes/interfaces inherited from interface InstrumentedType.Prepareable

InstrumentedType.Prepareable.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
private final String	definer	A token that is added between a field's name and its value.
private final String	end	A token that is added after the last field value.
private final ElementMatcher.Junction<? super FieldDescription.InDefinedShape>	ignored	A filter that determines what fields to ignore.
private final ToStringMethod.PrefixResolver	prefixResolver	A resolver for the prefix of a String representation.
private final String	separator	A token that is added between two field values.
private final String	start	A token that is added between the prefix and the first field value.
private static final MethodDescription.InDefinedShape	STRING_BUILDER_CONSTRUCTOR	The StringBuilder(String) constructor.
private static final MethodDescription.InDefinedShape	TO_STRING	The StringBuilder.toString() method.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToStringMethod(ToStringMethod.PrefixResolver prefixResolver)	Creates a new toString implementation.
private	ToStringMethod(ToStringMethod.PrefixResolver prefixResolver, String start, String end, String separator, String definer, ElementMatcher.Junction<? super FieldDescription.InDefinedShape> ignored)	Creates a new toString implementation.

Method Summary

Modifier and Type	Method	Description
ToStringMethod.Appender	appender(Implementation.Target implementationTarget)	Creates a byte code appender that determines the implementation of the instrumented type's methods.
static ToStringMethod	prefixedBy(String prefix)	Creates a Object.toString() implementation that is prefixed by the supplied string.
static ToStringMethod	prefixedBy(ToStringMethod.PrefixResolver prefixResolver)	Creates a Object.toString() implementation that is prefixed by the string that is supplied by the given prefix resolver.
static ToStringMethod	prefixedByCanonicalClassName()	Creates a Object.toString() implementation that is prefixed by the canonical class name of the instrumented type.
static ToStringMethod	prefixedByFullyQualifiedClassName()	Creates a Object.toString() implementation that is prefixed by the fully qualified class name of the instrumented type.
static ToStringMethod	prefixedBySimpleClassName()	Creates a Object.toString() implementation that is prefixed by the simple class name of the instrumented type.
InstrumentedType	prepare(InstrumentedType instrumentedType)	Prepares a given instrumented type.
ToStringMethod	withIgnoredFields(ElementMatcher<? super FieldDescription.InDefinedShape> ignored)	Returns a new version of this toString method implementation that ignores the specified fields additionally to any previously specified fields.
Implementation	withTokens(String start, String end, String separator, String definer)	Changes the tokens used for the Object.toString() implementation.

Methods inherited from class Object

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

Field Details

STRING_BUILDER_CONSTRUCTOR

private static final MethodDescription.InDefinedShape STRING_BUILDER_CONSTRUCTOR

The StringBuilder(String) constructor.

TO_STRING

private static final MethodDescription.InDefinedShape TO_STRING

The StringBuilder.toString() method.

prefixResolver

private final ToStringMethod.PrefixResolver prefixResolver

A resolver for the prefix of a String representation.

start

private final String start

A token that is added between the prefix and the first field value.

end

private final String end

A token that is added after the last field value.

separator

private final String separator

A token that is added between two field values.

definer

private final String definer

A token that is added between a field's name and its value.

ignored

private final ElementMatcher.Junction<? super FieldDescription.InDefinedShape> ignored

A filter that determines what fields to ignore.

Constructor Details

ToStringMethod

protected ToStringMethod(ToStringMethod.PrefixResolver prefixResolver)

Creates a new toString implementation.

Parameters:

prefixResolver - A resolver for the prefix of a String representation.

ToStringMethod

private ToStringMethod(ToStringMethod.PrefixResolver prefixResolver,
 String start,
 String end,
 String separator,
 String definer,
 ElementMatcher.Junction<? super FieldDescription.InDefinedShape> ignored)

Creates a new toString implementation.

Parameters:

prefixResolver - A resolver for the prefix of a String representation.

start - A token that is added between the prefix and the first field value.

end - A token that is added after the last field value.

separator - A token that is added between two field values.

definer - A token that is added between a field's name and its value.

ignored - A filter that determines what fields to ignore.

Method Details

prefixedByFullyQualifiedClassName

public static ToStringMethod prefixedByFullyQualifiedClassName()

Creates a Object.toString() implementation that is prefixed by the fully qualified class name of the instrumented type.

Returns:

A Object.toString() implementation that is prefixed by the fully qualified class name of the instrumented type.

prefixedByCanonicalClassName

public static ToStringMethod prefixedByCanonicalClassName()

Creates a Object.toString() implementation that is prefixed by the canonical class name of the instrumented type.

Returns:

A Object.toString() implementation that is prefixed by the canonical class name of the instrumented type.

prefixedBySimpleClassName

public static ToStringMethod prefixedBySimpleClassName()

Creates a Object.toString() implementation that is prefixed by the simple class name of the instrumented type.

Returns:

A Object.toString() implementation that is prefixed by the simple class name of the instrumented type.

prefixedBy

public static ToStringMethod prefixedBy(String prefix)

Creates a Object.toString() implementation that is prefixed by the supplied string.

Parameters:

prefix - The prefix to use.

Returns:

A Object.toString() implementation that is prefixed by the supplied string.

prefixedBy

public static ToStringMethod prefixedBy(ToStringMethod.PrefixResolver prefixResolver)

Creates a Object.toString() implementation that is prefixed by the string that is supplied by the given prefix resolver.

Parameters:

prefixResolver - The prefix resolver to use.

Returns:

A Object.toString() implementation that is prefixed by the string that is supplied by the given prefix resolver.

withIgnoredFields

public ToStringMethod withIgnoredFields(ElementMatcher<? super FieldDescription.InDefinedShape> ignored)

Returns a new version of this toString method implementation that ignores the specified fields additionally to any previously specified fields.

Parameters:

ignored - A matcher to specify any fields that should be ignored.

Returns:

A new version of this toString method implementation that also ignores any fields matched by the provided matcher.

withTokens

public Implementation withTokens(String start,
 String end,
 String separator,
 String definer)

Changes the tokens used for the Object.toString() implementation.

Parameters:

start - A token that is added between the prefix and the first field value.

end - A token that is added after the last field value.

separator - A token that is added between two field values.

definer - A token that is added between two field values.

Returns:

A new instance of this implementation that uses the supplied tokens.

prepare

public InstrumentedType prepare(InstrumentedType instrumentedType)

Prepares a given instrumented type.

Specified by:

prepare in interface InstrumentedType.Prepareable

Parameters:

instrumentedType - The instrumented type in its current form.

Returns:

The prepared instrumented type.

appender

public ToStringMethod.Appender appender(Implementation.Target implementationTarget)

Creates a byte code appender that determines the implementation of the instrumented type's methods.

Specified by:

appender in interface Implementation

Parameters:

implementationTarget - The target of the current implementation.

Returns:

A byte code appender for implementing methods delegated to this implementation. This byte code appender is also responsible for handling methods that were added by this implementation on the call to InstrumentedType.Prepareable.prepare(InstrumentedType).