Package net.bytebuddy.implementation
Class ToStringMethod
- java.lang.Object
-
- net.bytebuddy.implementation.ToStringMethod
-
- All Implemented Interfaces:
InstrumentedType.Prepareable
,Implementation
public class ToStringMethod extends java.lang.Object implements Implementation
An implementation ofObject.toString()
that concatenates theString
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 implementToStringMethod
.static interface
ToStringMethod.PrefixResolver
A prefix resolver is responsible for providing a value that is preprended to aObject.toString()
implementation.protected static class
ToStringMethod.ValueConsumer
A value consumer that is responsible for adding a field value to the string creatingStringBuilder
.-
Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation
Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ToStringMethod(ToStringMethod.PrefixResolver prefixResolver)
Creates a newtoString
implementation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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(java.lang.String prefix)
Creates aObject.toString()
implementation that is prefixed by the supplied string.static ToStringMethod
prefixedBy(ToStringMethod.PrefixResolver prefixResolver)
Creates aObject.toString()
implementation that is prefixed by the string that is supplied by the given prefix resolver.static ToStringMethod
prefixedByCanonicalClassName()
Creates aObject.toString()
implementation that is prefixed by the canonical class name of the instrumented type.static ToStringMethod
prefixedByFullyQualifiedClassName()
Creates aObject.toString()
implementation that is prefixed by the fully qualified class name of the instrumented type.static ToStringMethod
prefixedBySimpleClassName()
Creates aObject.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(java.lang.String start, java.lang.String end, java.lang.String separator, java.lang.String definer)
Changes the tokens used for theObject.toString()
implementation.
-
-
-
Constructor Detail
-
ToStringMethod
protected ToStringMethod(ToStringMethod.PrefixResolver prefixResolver)
Creates a newtoString
implementation.- Parameters:
prefixResolver
- A resolver for the prefix of aString
representation.
-
-
Method Detail
-
prefixedByFullyQualifiedClassName
public static ToStringMethod prefixedByFullyQualifiedClassName()
Creates aObject.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 aObject.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 aObject.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(java.lang.String prefix)
Creates aObject.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 aObject.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(java.lang.String start, java.lang.String end, java.lang.String separator, java.lang.String definer)
Changes the tokens used for theObject.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)
Description copied from interface:InstrumentedType.Prepareable
Prepares a given instrumented type.- Specified by:
prepare
in interfaceInstrumentedType.Prepareable
- Parameters:
instrumentedType
- The instrumented type in its current form.- Returns:
- The prepared instrumented type.
-
appender
public ToStringMethod.Appender appender(Implementation.Target implementationTarget)
Description copied from interface:Implementation
Creates a byte code appender that determines the implementation of the instrumented type's methods.- Specified by:
appender
in interfaceImplementation
- 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)
.
-
-