Package net.bytebuddy.agent.builder

Class AgentBuilder.InstallationListener.StreamWriting

java.lang.Object

net.bytebuddy.agent.builder.AgentBuilder.InstallationListener.StreamWriting

All Implemented Interfaces:

AgentBuilder.InstallationListener

Enclosing interface:

AgentBuilder.InstallationListener

@Enhance
public static class AgentBuilder.InstallationListener.StreamWriting
extends java.lang.Object
implements AgentBuilder.InstallationListener

This installation listener prints the status of any installation to a PrintStream.

Nested Class Summary

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

AgentBuilder.InstallationListener.Adapter, AgentBuilder.InstallationListener.Compound, AgentBuilder.InstallationListener.ErrorSuppressing, AgentBuilder.InstallationListener.NoOp, AgentBuilder.InstallationListener.StreamWriting

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	PREFIX	The prefix prepended to any message written.
private java.io.PrintStream	printStream	The print stream to write to.

Fields inherited from interface net.bytebuddy.agent.builder.AgentBuilder.InstallationListener

SUPPRESS_ERROR

Constructor Summary

Constructors

Constructor	Description
StreamWriting(java.io.PrintStream printStream)	Creates a new stream writing installation listener.

Method Summary

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.
static AgentBuilder.InstallationListener	toSystemError()	Creates a stream writing installation listener that prints to System.err.
static AgentBuilder.InstallationListener	toSystemOut()	Creates a stream writing installation listener that prints to System.out.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

protected static final java.lang.String PREFIX

The prefix prepended to any message written.

See Also:

Constant Field Values

printStream

private final java.io.PrintStream printStream

The print stream to write to.

Constructor Detail

StreamWriting

public StreamWriting(java.io.PrintStream printStream)

Creates a new stream writing installation listener.

Parameters:

printStream - The print stream to write to.

Method Detail

toSystemOut

public static AgentBuilder.InstallationListener toSystemOut()

Creates a stream writing installation listener that prints to System.out.

Returns:

An installation listener that prints to System.out.

toSystemError

public static AgentBuilder.InstallationListener toSystemError()

Creates a stream writing installation listener that prints to System.err.

Returns:

An installation listener that prints to System.err.

onBeforeInstall

public void onBeforeInstall(java.lang.instrument.Instrumentation instrumentation,
                            ResettableClassFileTransformer classFileTransformer)

Invoked prior to the installation of a class file transformer.

Specified by:

onBeforeInstall in interface AgentBuilder.InstallationListener

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

onInstall

public 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 by AgentBuilder.InstallationListener.onError(Instrumentation, ResettableClassFileTransformer, Throwable).

Specified by:

onInstall in interface AgentBuilder.InstallationListener

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

onError

public 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 to AgentBuilder.InstallationListener.onInstall(Instrumentation, ResettableClassFileTransformer).

Specified by:

onError in interface AgentBuilder.InstallationListener

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

public void onReset(java.lang.instrument.Instrumentation instrumentation,
                    ResettableClassFileTransformer classFileTransformer)

Invoked if an installation is reset.

Specified by:

onReset in interface AgentBuilder.InstallationListener

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.