Class Plugin.Engine.Listener.StreamWriting

java.lang.Object

net.bytebuddy.build.Plugin.Engine.Listener.Adapter

net.bytebuddy.build.Plugin.Engine.Listener.StreamWriting

All Implemented Interfaces:

Plugin.Engine.ErrorHandler, Plugin.Engine.Listener

Enclosing interface:

Plugin.Engine.Listener

@Enhance
public static class Plugin.Engine.Listener.StreamWriting
extends Plugin.Engine.Listener.Adapter

A listener that forwards significant events of a plugin engine application to a PrintStream.

Nested Class Summary

Nested classes/interfaces inherited from interface Plugin.Engine.ErrorHandler

Plugin.Engine.ErrorHandler.Enforcing, Plugin.Engine.ErrorHandler.Failing

Nested classes/interfaces inherited from interface Plugin.Engine.Listener

Plugin.Engine.Listener.Adapter, Plugin.Engine.Listener.Compound, Plugin.Engine.Listener.ForErrorHandler, Plugin.Engine.Listener.NoOp, Plugin.Engine.Listener.StreamWriting, Plugin.Engine.Listener.WithErrorsOnly, Plugin.Engine.Listener.WithTransformationsOnly

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	PREFIX	The prefix that is appended to all written messages.
private final PrintStream	printStream	The print stream to delegate to.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	onComplete(TypeDescription typeDescription)	Invoked upon completing handling a type that was either transformed or ignored.
void	onDiscovery(String typeName)	Invoked upon discovering a type but prior to its resolution.
void	onError(Plugin plugin, Throwable throwable)	Invoked at the end of the build if a plugin could not be closed.
void	onError(TypeDescription typeDescription, Plugin plugin, Throwable throwable)	Invoked if an error occured during a plugin's application on a given type.
void	onIgnored(TypeDescription typeDescription, Plugin plugin)	Invoked if a type description is ignored by a given plugin.
void	onLiveInitializer(TypeDescription typeDescription, TypeDescription definingType)	Invoked if a type transformation implied a live initializer.
void	onManifest(Manifest manifest)	Invoked when a manifest was found or found missing.
void	onResource(String name)	Invoked if a resource that is not a class file is discovered.
void	onTransformation(TypeDescription typeDescription, Plugin plugin)	Invoked after a type was transformed using a specific plugin.
void	onUnresolved(String typeName)	Invoked if a type could not be resolved.
static Plugin.Engine.Listener.StreamWriting	toSystemError()	Creates a stream writing listener that prints all events on System.err.
static Plugin.Engine.Listener.StreamWriting	toSystemOut()	Creates a stream writing listener that prints all events on System.out.
Plugin.Engine.Listener	withErrorsOnly()	Returns a new listener that only prints error events.
Plugin.Engine.Listener	withTransformationsOnly()	Returns a new listener that only prints transformation and error events.

Methods inherited from class Plugin.Engine.Listener.Adapter

onError, onError, onIgnored, onTransformation

Methods inherited from class Object

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

Field Details

PREFIX

protected static final String PREFIX

The prefix that is appended to all written messages.

See Also:

• Constant Field Values

printStream

private final PrintStream printStream

The print stream to delegate to.

Constructor Details

StreamWriting

public StreamWriting(PrintStream printStream)

Creates a new stream writing listener.

Parameters:

printStream - The print stream to delegate to.

Method Details

toSystemOut

public static Plugin.Engine.Listener.StreamWriting toSystemOut()

Creates a stream writing listener that prints all events on System.out.

Returns:

A listener that writes events to the system output stream.

toSystemError

public static Plugin.Engine.Listener.StreamWriting toSystemError()

Creates a stream writing listener that prints all events on System.err.

Returns:

A listener that writes events to the system error stream.

withTransformationsOnly

public Plugin.Engine.Listener withTransformationsOnly()

Returns a new listener that only prints transformation and error events.

Returns:

A new listener that only prints transformation and error events.

withErrorsOnly

public Plugin.Engine.Listener withErrorsOnly()

Returns a new listener that only prints error events.

Returns:

A new listener that only prints error events.

onDiscovery

public void onDiscovery(String typeName)

Invoked upon discovering a type but prior to its resolution.

Specified by:

onDiscovery in interface Plugin.Engine.Listener

Overrides:

onDiscovery in class Plugin.Engine.Listener.Adapter

Parameters:

typeName - The name of the discovered type.

onTransformation

public void onTransformation(TypeDescription typeDescription,
 Plugin plugin)

Invoked after a type was transformed using a specific plugin.

Specified by:

onTransformation in interface Plugin.Engine.Listener

Overrides:

onTransformation in class Plugin.Engine.Listener.Adapter

Parameters:

typeDescription - The type being transformed.

plugin - The plugin that was applied.

onIgnored

public void onIgnored(TypeDescription typeDescription,
 Plugin plugin)

Invoked if a type description is ignored by a given plugin. This callback is not invoked, if the ignore type matcher excluded a type from transformation.

Specified by:

onIgnored in interface Plugin.Engine.Listener

Overrides:

onIgnored in class Plugin.Engine.Listener.Adapter

Parameters:

typeDescription - The type being transformed.

plugin - The plugin that ignored the given type.

onError

public void onError(TypeDescription typeDescription,
 Plugin plugin,
 Throwable throwable)

Invoked if an error occured during a plugin's application on a given type.

Specified by:

onError in interface Plugin.Engine.ErrorHandler

Overrides:

onError in class Plugin.Engine.Listener.Adapter

Parameters:

typeDescription - The type being matched or transformed.

plugin - The plugin being applied.

throwable - The throwable that caused the error.

onError

public void onError(Plugin plugin,
 Throwable throwable)

Invoked at the end of the build if a plugin could not be closed.

Specified by:

onError in interface Plugin.Engine.ErrorHandler

Overrides:

onError in class Plugin.Engine.Listener.Adapter

Parameters:

plugin - The plugin that could not be closed.

throwable - The error that was caused when the plugin was attempted to be closed.

onUnresolved

public void onUnresolved(String typeName)

Invoked if a type could not be resolved.

Specified by:

onUnresolved in interface Plugin.Engine.ErrorHandler

Overrides:

onUnresolved in class Plugin.Engine.Listener.Adapter

Parameters:

typeName - The name of the unresolved type.

onLiveInitializer

public void onLiveInitializer(TypeDescription typeDescription,
 TypeDescription definingType)

Invoked if a type transformation implied a live initializer.

Specified by:

onLiveInitializer in interface Plugin.Engine.ErrorHandler

Overrides:

onLiveInitializer in class Plugin.Engine.Listener.Adapter

Parameters:

typeDescription - The type that was transformed.

definingType - The type that implies the initializer which might be the type itself or an auxiliary type.

onComplete

public void onComplete(TypeDescription typeDescription)

Invoked upon completing handling a type that was either transformed or ignored.

Specified by:

onComplete in interface Plugin.Engine.Listener

Overrides:

onComplete in class Plugin.Engine.Listener.Adapter

Parameters:

typeDescription - The type that was transformed.

onManifest

public void onManifest(@MaybeNull
 Manifest manifest)

Invoked when a manifest was found or found missing.

Specified by:

onManifest in interface Plugin.Engine.ErrorHandler

Overrides:

onManifest in class Plugin.Engine.Listener.Adapter

Parameters:

manifest - The located manifest or null if no manifest was found.

onResource

public void onResource(String name)

Invoked if a resource that is not a class file is discovered.

Specified by:

onResource in interface Plugin.Engine.ErrorHandler

Overrides:

onResource in class Plugin.Engine.Listener.Adapter

Parameters:

name - The name of the discovered resource.