AgentBuilder.Default.Matched (Byte Buddy (without dependencies) 1.2.3 API)

java.lang.Object
- net.bytebuddy.agent.builder.AgentBuilder.Default.Matched

All Implemented Interfaces:

AgentBuilder, AgentBuilder.Identified, AgentBuilder.Identified.Extendable

Enclosing class:

AgentBuilder.Default
```
protected class AgentBuilder.Default.Matched
extends Object
implements AgentBuilder.Identified.Extendable
```
A helper class that describes a AgentBuilder.Default after supplying a AgentBuilder.RawMatcher such that one or several AgentBuilder.Transformers can be supplied.

Nested Class Summary
- Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder
  AgentBuilder.BinaryLocator, AgentBuilder.Default, AgentBuilder.Identified, AgentBuilder.InitializationStrategy, AgentBuilder.LambdaInstrumentationStrategy, AgentBuilder.Listener, AgentBuilder.RawMatcher, AgentBuilder.RedefinitionStrategy, AgentBuilder.Transformer, AgentBuilder.TypeStrategy
- Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder.Identified
  AgentBuilder.Identified.Extendable

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Matched(AgentBuilder.RawMatcher rawMatcher, AgentBuilder.Transformer transformer)` Creates a new matched default agent builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AgentBuilder`	`disableBootstrapInjection()` Disables injection of auxiliary classes into the bootstrap class path.
`AgentBuilder`	`disableNativeMethodPrefix()` Disables the use of a native method prefix for instrumented methods.
`AgentBuilder`	`enableBootstrapInjection(File folder, Instrumentation instrumentation)` Enables class injection of auxiliary classes into the bootstrap class loader.
`AgentBuilder`	`enableNativeMethodPrefix(String prefix)` Enables the use of the given native method prefix for instrumented methods.
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`AgentBuilder`	`ignore(ElementMatcher<? super TypeDescription> ignoredTypes)` Excludes any type that is matched by the provided matcher from instrumentation.
`ClassFileTransformer`	`installOn(Instrumentation instrumentation)` Creates and installs a `ClassFileTransformer` that implements the configuration of this agent builder with a given `Instrumentation`.
`ClassFileTransformer`	`installOnByteBuddyAgent()` Creates and installs a `ClassFileTransformer` that implements the configuration of this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.
`ClassFileTransformer`	`makeRaw()` Creates a `ClassFileTransformer` that implements the configuration of this agent builder.
`protected AgentBuilder`	`materialize()` Materializes the currently described `AgentBuilder.Default.Transformation`.
`String`	`toString()`
`AgentBuilder.Identified.Extendable`	`transform(AgentBuilder.Transformer transformer)` Applies the given transformer for the already supplied matcher.
`AgentBuilder.Identified`	`type(AgentBuilder.RawMatcher matcher)` Matches a type being loaded in order to apply the supplied `AgentBuilder.Transformer`s before loading this type.
`AgentBuilder.Identified`	`type(ElementMatcher<? super TypeDescription> typeMatcher)` Matches a type being loaded in order to apply the supplied `AgentBuilder.Transformer`s before loading this type.
`AgentBuilder.Identified`	`type(ElementMatcher<? super TypeDescription> typeMatcher, ElementMatcher<? super ClassLoader> classLoaderMatcher)` Matches a type being loaded in order to apply the supplied `AgentBuilder.Transformer`s before loading this type.
`AgentBuilder`	`with(AccessControlContext accessControlContext)` Defines classes to be loaded using the given access control context.
`AgentBuilder`	`with(AgentBuilder.BinaryLocator binaryLocator)` Defines the use of the given binary locator for locating binary data to given class names.
`AgentBuilder`	`with(AgentBuilder.InitializationStrategy initializationStrategy)` Defines a given initialization strategy to be applied to generated types.
`AgentBuilder`	`with(AgentBuilder.LambdaInstrumentationStrategy lambdaInstrumentationStrategy)` Enables or disables management of the JVM's `LambdaMetafactory` which is responsible for creating classes that implement lambda expressions.
`AgentBuilder`	`with(AgentBuilder.Listener listener)` Defines the given `AgentBuilder.Listener` to be notified by the created agent.
`AgentBuilder`	`with(AgentBuilder.RedefinitionStrategy redefinitionStrategy)` Specifies a strategy for modifying existing types.
`AgentBuilder`	`with(AgentBuilder.TypeStrategy typeStrategy)` Defines the use of the given definition handler that determines if a type should be rebased or redefined.
`AgentBuilder`	`with(ByteBuddy byteBuddy)` Defines the given `ByteBuddy` instance to be used by the created agent.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Matched
```
protected Matched(AgentBuilder.RawMatcher rawMatcher,
                  AgentBuilder.Transformer transformer)
```
    Creates a new matched default agent builder.
    
    Parameters:
    
    rawMatcher - The supplied raw matcher.
    
    transformer - The supplied transformer.
- Method Detail
  - transform
```
public AgentBuilder.Identified.Extendable transform(AgentBuilder.Transformer transformer)
```
    Description copied from interface: AgentBuilder.Identified
    
    Applies the given transformer for the already supplied matcher.
    
    Specified by:
    
    transform in interface AgentBuilder.Identified
    
    Parameters:
    
    transformer - The transformer to apply.
    
    Returns:
    
    This agent builder with the transformer being applied when the previously supplied matcher identified a type for instrumentation which also allows for the registration of subsequent transformers.
  - type
```
public AgentBuilder.Identified type(AgentBuilder.RawMatcher matcher)
```
    Description copied from interface: AgentBuilder
    
    Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
    
    Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation. If possible, it is also recommended, to exclude class loaders such as for example the bootstrap class loader.
    
    Specified by:
    
    type in interface AgentBuilder
    
    Parameters:
    
    matcher - A matcher that decides if the entailed AgentBuilder.Transformers should be applied for a type that is being loaded.
    
    Returns:
    
    A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when the given matcher indicates a match.
  - type
```
public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher)
```
    Description copied from interface: AgentBuilder
    
    Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
    
    Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation. If possible, it is also recommended, to exclude class loaders such as for example the bootstrap class loader by using AgentBuilder.type(ElementMatcher, ElementMatcher) instead.
    
    Specified by:
    
    type in interface AgentBuilder
    
    Parameters:
    
    typeMatcher - An ElementMatcher that is applied on the type being loaded that decides if the entailed AgentBuilder.Transformers should be applied for that type.
    
    Returns:
    
    A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when the given typeMatcher indicates a match.
  - type
```
public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher,
                                    ElementMatcher<? super ClassLoader> classLoaderMatcher)
```
    Description copied from interface: AgentBuilder
    
    Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
    
    Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation.
    
    Specified by:
    
    type in interface AgentBuilder
    
    Parameters:
    
    typeMatcher - An ElementMatcher that is applied on the type being loaded that decides if the entailed AgentBuilder.Transformers should be applied for that type.
    
    classLoaderMatcher - An ElementMatcher that is applied to the ClassLoader that is loading the type being loaded. This matcher is always applied first where the type matcher is not applied in case that this matcher does not indicate a match.
    
    Returns:
    
    A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when both the given typeMatcher and classLoaderMatcher indicate a match.
  - with
```
public AgentBuilder with(ByteBuddy byteBuddy)
```
    Description copied from interface: AgentBuilder
    
    Defines the given ByteBuddy instance to be used by the created agent.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    byteBuddy - The Byte Buddy instance to be used.
    
    Returns:
    
    A new instance of this agent builder which makes use of the given byteBuddy instance.
  - with
```
public AgentBuilder with(AgentBuilder.Listener listener)
```
    Description copied from interface: AgentBuilder
    
    Defines the given AgentBuilder.Listener to be notified by the created agent. The given listener is notified after any other listener that is already registered. If a listener is registered twice, it is also notified twice.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    listener - The listener to be notified.
    
    Returns:
    
    A new instance of this agent builder which creates an agent that informs the given listener about events.
  - with
```
public AgentBuilder with(AgentBuilder.TypeStrategy typeStrategy)
```
    Description copied from interface: AgentBuilder
    
    Defines the use of the given definition handler that determines if a type should be rebased or redefined.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    typeStrategy - The definition handler to use.
    
    Returns:
    
    A new instance of this agent builder which uses the given definition handler.
  - with
```
public AgentBuilder with(AgentBuilder.BinaryLocator binaryLocator)
```
    Description copied from interface: AgentBuilder
    
    Defines the use of the given binary locator for locating binary data to given class names.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    binaryLocator - The binary locator to use.
    
    Returns:
    
    A new instance of this agent builder which uses the given binary locator for looking up class files.
  - with
```
public AgentBuilder with(AccessControlContext accessControlContext)
```
    Description copied from interface: AgentBuilder
    
    Defines classes to be loaded using the given access control context.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    accessControlContext - The access control context to be used for loading classes.
    
    Returns:
    
    A new instance of this agent builder which uses the given access control context for class loading.
  - with
```
public AgentBuilder with(AgentBuilder.InitializationStrategy initializationStrategy)
```
    Description copied from interface: AgentBuilder
    
    Defines a given initialization strategy to be applied to generated types. An initialization strategy is responsible for setting up a type after it was loaded. This initialization must be performed after the transformation because a Java agent is only invoked before loading a type. By default, the initialization logic is added to a class's type initializer which queries a global object for any objects that are to be injected into the generated type.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    initializationStrategy - The initialization strategy to use.
    
    Returns:
    
    A new instance of this agent builder that applies the given initialization strategy.
  - with
```
public AgentBuilder with(AgentBuilder.RedefinitionStrategy redefinitionStrategy)
```
    Description copied from interface: AgentBuilder
    
    Specifies a strategy for modifying existing types.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    redefinitionStrategy - The redefinition strategy to apply.
    
    Returns:
    
    A new instance of this agent builder that applies the given redefinition strategy.
  - with
```
public AgentBuilder with(AgentBuilder.LambdaInstrumentationStrategy lambdaInstrumentationStrategy)
```
    Description copied from interface: AgentBuilder
    
    Enables or disables management of the JVM's LambdaMetafactory which is responsible for creating classes that implement lambda expressions. Without this feature enabled, classes that are represented by lambda expressions are not instrumented by the JVM such that Java agents have no effect on them when a lambda expression's class is loaded for the first time.
    
    When activating this feature, Byte Buddy instruments the LambdaMetafactory and takes over the responsibility of creating classes that represent lambda expressions. In doing so, Byte Buddy has the opportunity to apply the built class file transformer. If the current VM does not support lambda expressions, activating this feature has no effect.
    
    Important: If this feature is active, it is important to release the built class file transformer when deactivating it. Normally, it is sufficient to call Instrumentation.removeTransformer(ClassFileTransformer). When this feature is enabled, it is however also required to invoke AgentBuilder.LambdaInstrumentationStrategy.release(ClassFileTransformer, Instrumentation). Otherwise, the executing VMs class loader retains a reference to the class file transformer what can cause a memory leak.
    
    Specified by:
    
    with in interface AgentBuilder
    
    Parameters:
    
    lambdaInstrumentationStrategy - true if this feature should be enabled.
    
    Returns:
    
    A new instance of this agent builder where this feature is explicitly enabled or disabled.
  - enableBootstrapInjection
```
public AgentBuilder enableBootstrapInjection(File folder,
                                             Instrumentation instrumentation)
```
    Description copied from interface: AgentBuilder
    
    Enables class injection of auxiliary classes into the bootstrap class loader.
    
    Specified by:
    
    enableBootstrapInjection in interface AgentBuilder
    
    Parameters:
    
    folder - The folder in which jar files of the injected classes are to be stored.
    
    instrumentation - The instrumentation instance that is used for appending jar files to the bootstrap class path.
    
    Returns:
    
    An agent builder with bootstrap class loader class injection enabled.
  - disableBootstrapInjection
```
public AgentBuilder disableBootstrapInjection()
```
    Description copied from interface: AgentBuilder
    
    Disables injection of auxiliary classes into the bootstrap class path.
    
    Specified by:
    
    disableBootstrapInjection in interface AgentBuilder
    
    Returns:
    
    A new instance of this agent builder which does not apply bootstrap class loader injection.
  - enableNativeMethodPrefix
```
public AgentBuilder enableNativeMethodPrefix(String prefix)
```
    Description copied from interface: AgentBuilder
    
    Enables the use of the given native method prefix for instrumented methods. Note that this prefix is also applied when preserving non-native methods. The use of this prefix is also registered when installing the final agent with an Instrumentation.
    
    Specified by:
    
    enableNativeMethodPrefix in interface AgentBuilder
    
    Parameters:
    
    prefix - The prefix to be used.
    
    Returns:
    
    A new instance of this agent builder which uses the given native method prefix.
  - disableNativeMethodPrefix
```
public AgentBuilder disableNativeMethodPrefix()
```
    Description copied from interface: AgentBuilder
    
    Disables the use of a native method prefix for instrumented methods.
    
    Specified by:
    
    disableNativeMethodPrefix in interface AgentBuilder
    
    Returns:
    
    A new instance of this agent builder which does not use a native method prefix.
  - ignore
```
public AgentBuilder ignore(ElementMatcher<? super TypeDescription> ignoredTypes)
```
    Description copied from interface: AgentBuilder
    
    Excludes any type that is matched by the provided matcher from instrumentation. By default, Byte Buddy does not instrument synthetic types.
    
    Note: For performance reasons, it is recommended to always include a matcher that excludes as many namespaces as possible. Byte Buddy can determine a type's name without parsing its class file and can therefore discard such types prematurely. When a different property of a type - such as for example its modifiers or its annotations is accessed - Byte Buddy parses the class file lazily in order to allow for such a matching. Therefore, any exclusion of a name should always be done as a first step and even if it does not influence the selection of what types are matched. Without changing this property, the class file of every type is being parsed!
    
    Specified by:
    
    ignore in interface AgentBuilder
    
    Parameters:
    
    ignoredTypes - A matcher that identifies types that should not be instrumented.
    
    Returns:
    
    A new instance of this agent builder that ignores all types that are matched by the provided matcher. All previous matchers for ignored types are discarded.
  - makeRaw
```
public ClassFileTransformer makeRaw()
```
    Description copied from interface: AgentBuilder
    
    Creates a ClassFileTransformer that implements the configuration of this agent builder.
    
    Specified by:
    
    makeRaw in interface AgentBuilder
    
    Returns:
    
    A class file transformer that implements the configuration of this agent builder.
  - installOn
```
public ClassFileTransformer installOn(Instrumentation instrumentation)
```
    Description copied from interface: AgentBuilder
    
    Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with a given Instrumentation. If retransformation is enabled, the installation also causes all loaded types to be retransformed.
    
    Specified by:
    
    installOn in interface AgentBuilder
    
    Parameters:
    
    instrumentation - The instrumentation on which this agent builder's configuration is to be installed.
    
    Returns:
    
    The installed class file transformer.
  - installOnByteBuddyAgent
```
public ClassFileTransformer installOnByteBuddyAgent()
```
    Description copied from interface: AgentBuilder
    
    Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.
    
    Specified by:
    
    installOnByteBuddyAgent in interface AgentBuilder
    
    Returns:
    
    The installed class file transformer.
  - materialize
```
protected AgentBuilder materialize()
```
    Materializes the currently described AgentBuilder.Default.Transformation.
    
    Returns:
    
    An agent builder that represents the currently described entry of this instance.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AgentBuilder.Default.Matched

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder

Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder.Identified

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Matched

Method Detail

transform

type

type

type

with

with

with

with

with

with

with

with

enableBootstrapInjection

disableBootstrapInjection

enableNativeMethodPrefix

disableNativeMethodPrefix

ignore

makeRaw

installOn

installOnByteBuddyAgent

materialize

equals

hashCode

toString