Package net.bytebuddy.agent.builder
Interface AgentBuilder.InstallationListener
-
- All Known Implementing Classes:
AgentBuilder.InstallationListener.Adapter
,AgentBuilder.InstallationListener.Compound
,AgentBuilder.InstallationListener.ErrorSuppressing
,AgentBuilder.InstallationListener.NoOp
,AgentBuilder.InstallationListener.StreamWriting
,AgentBuilder.RedefinitionStrategy.ResubmissionStrategy.Enabled.ResubmissionInstallationListener
- Enclosing interface:
- AgentBuilder
public static interface AgentBuilder.InstallationListener
A listener that is notified during the installation and the resetting of a class file transformer.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
AgentBuilder.InstallationListener.Adapter
An adapter implementation for an installation listener that serves as a convenience.static class
AgentBuilder.InstallationListener.Compound
A compound installation listener.static class
AgentBuilder.InstallationListener.ErrorSuppressing
A listener that suppresses any installation error.static class
AgentBuilder.InstallationListener.NoOp
A non-operational listener that does not do anything.static class
AgentBuilder.InstallationListener.StreamWriting
This installation listener prints the status of any installation to aPrintStream
.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Throwable
SUPPRESS_ERROR
Indicates that an exception is handled.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
onBeforeInstall(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked prior to the installation of a class file transformer.java.lang.Throwable
onError(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer, java.lang.Throwable throwable)
Invoked if an installation causes an error.void
onInstall(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked upon the successful installation of a class file transformer.void
onReset(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked if an installation is reset.
-
-
-
Method Detail
-
onBeforeInstall
void onBeforeInstall(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked prior to the installation of a class file transformer.- Parameters:
instrumentation
- The instrumentation on which the class file transformer is installed.classFileTransformer
- The class file transformer that is being installed.
-
onInstall
void onInstall(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked upon the successful installation of a class file transformer. This method is only invoked if no error occurred during the installation or if such an error was handled byonError(Instrumentation, ResettableClassFileTransformer, Throwable)
.- Parameters:
instrumentation
- The instrumentation on which the class file transformer is installed.classFileTransformer
- The class file transformer that is being installed.
-
onError
java.lang.Throwable onError(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer, java.lang.Throwable throwable)
Invoked if an installation causes an error. The listener has an opportunity to handle the error. This method is invoked prior toonInstall(Instrumentation, ResettableClassFileTransformer)
.- Parameters:
instrumentation
- The instrumentation on which the class file transformer is installed.classFileTransformer
- The class file transformer that is being installed.throwable
- The throwable that causes the error.- Returns:
- The error to propagate or
null
if the error is handled. Any subsequent listeners are not called if the exception is handled.
-
onReset
void onReset(java.lang.instrument.Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer)
Invoked if an installation is reset.- Parameters:
instrumentation
- The instrumentation on which the class file transformer is installed.classFileTransformer
- The class file transformer that is being installed.
-
-