net.bytebuddy.build

Class Plugin.Engine.Listener.Compound

java.lang.Object

net.bytebuddy.build.Plugin.Engine.Listener.Compound

All Implemented Interfaces:

Plugin.Engine.ErrorHandler, Plugin.Engine.Listener

Enclosing interface:

Plugin.Engine.Listener

@HashCodeAndEqualsPlugin.Enhance
public static class Plugin.Engine.Listener.Compound
extends Object
implements Plugin.Engine.Listener

A compound listener.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.build.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

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin.Engine.ErrorHandler

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

Constructor Summary

Constructors

Constructor and Description
Compound(List<? extends Plugin.Engine.Listener> listeners) Creates a new compound listener.
Compound(Plugin.Engine.Listener... listener) Creates a new compound listener.

Method Summary

Modifier and Type	Method and 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(Map<TypeDescription,List<Throwable>> throwables) Invoked at the end of the build if at least one type transformation failed.
void	onError(Plugin plugin, Throwable throwable) Invoked at the end of the build if a plugin could not be closed.
void	onError(TypeDescription typeDescription, List<Throwable> throwables) Invoked after the application of all plugins was attempted if at least one error occured during handling a given type.
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, List<Plugin> plugins) Invoked if one or more plugins did not transform a 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, List<Plugin> plugins) Invoked after a type was transformed using at least one plugin.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compound

public Compound(Plugin.Engine.Listener... listener)

Creates a new compound listener.

Parameters:

listener - A list of listeners that are represented by this compound instance.

Compound

public Compound(List<? extends Plugin.Engine.Listener> listeners)

Creates a new compound listener.

Parameters:

listeners - A list of listeners that are represented by this compound instance.

Method Detail

onDiscovery

public void onDiscovery(String typeName)

Invoked upon discovering a type but prior to its resolution.

Specified by:

onDiscovery in interface Plugin.Engine.Listener

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

Parameters:

typeDescription - The type being transformed.

plugin - The plugin that was applied.

onTransformation

public void onTransformation(TypeDescription typeDescription,
                             List<Plugin> plugins)

Invoked after a type was transformed using at least one plugin.

Specified by:

onTransformation in interface Plugin.Engine.Listener

Parameters:

typeDescription - The type being transformed.

plugins - A list of plugins that were 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

Parameters:

typeDescription - The type being transformed.

plugin - The plugin that ignored the given type.

onIgnored

public void onIgnored(TypeDescription typeDescription,
                      List<Plugin> plugins)

Invoked if one or more plugins did not transform a type. This callback is also invoked if an ignore matcher excluded a type from transformation.

Specified by:

onIgnored in interface Plugin.Engine.Listener

Parameters:

typeDescription - The type being transformed.

plugins - the plugins that ignored the 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

Parameters:

typeDescription - The type being matched or transformed.

plugin - The plugin being applied.

throwable - The throwable that caused the error.

onError

public void onError(TypeDescription typeDescription,
                    List<Throwable> throwables)

Invoked after the application of all plugins was attempted if at least one error occured during handling a given type.

Specified by:

onError in interface Plugin.Engine.ErrorHandler

Parameters:

typeDescription - The type being transformed.

throwables - The throwables that caused errors during the application.

onError

public void onError(Map<TypeDescription,List<Throwable>> throwables)

Invoked at the end of the build if at least one type transformation failed.

Specified by:

onError in interface Plugin.Engine.ErrorHandler

Parameters:

throwables - A mapping of types that failed during transformation to the errors that were caught.

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

Parameters:

plugin - The plugin that could not be closed.

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

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

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

Parameters:

typeDescription - The type that was transformed.

onUnresolved

public void onUnresolved(String typeName)

Invoked if a type could not be resolved.

Specified by:

onUnresolved in interface Plugin.Engine.ErrorHandler

Parameters:

typeName - The name of the unresolved type.

onManifest

public void onManifest(Manifest manifest)

Invoked when a manifest was found or found missing.

Specified by:

onManifest in interface Plugin.Engine.ErrorHandler

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

Parameters:

name - The name of the discovered resource.