org.pantsbuild.tools.jar

Interface JarBuilder.Listener

Enclosing class:

JarBuilder

public static interface JarBuilder.Listener

An interface for those interested in the progress of writing the target jar.

Field Summary

Fields

Modifier and Type	Field and Description
static JarBuilder.Listener	NOOP A listener that ignores all events.

Method Summary

Modifier and Type	Method and Description
void	onConcat(String name, Iterable<? extends JarBuilder.Entry> entries) Called to notify the listener an original entry is being concatenated with one or more subsequently added entries.
void	onReplace(Iterable<? extends JarBuilder.Entry> originals, JarBuilder.Entry replacement) Called to notify the listener that original entries are being replaced by a subsequently added entry.
void	onSkip(Optional<? extends JarBuilder.Entry> original, Iterable<? extends JarBuilder.Entry> skipped) Called to notify the listener that entries are being skipped.
void	onWrite(JarBuilder.Entry entry) Called to notify the listener of a newly written non-duplicate entry.

Field Detail

NOOP

static final JarBuilder.Listener NOOP

A listener that ignores all events.

Method Detail

onSkip

void onSkip(Optional<? extends JarBuilder.Entry> original,
            Iterable<? extends JarBuilder.Entry> skipped)

Called to notify the listener that entries are being skipped. If original is present this indicates it it being retained in preference to the skipped entries.

Parameters:

original - The original entry being retained.

skipped - The new entries being skipped.

onReplace

void onReplace(Iterable<? extends JarBuilder.Entry> originals,
               JarBuilder.Entry replacement)

Called to notify the listener that original entries are being replaced by a subsequently added entry.

Parameters:

originals - The original entry candidates that will be replaced.

replacement - The entry that overwrites the originals.

onConcat

void onConcat(String name,
              Iterable<? extends JarBuilder.Entry> entries)

Called to notify the listener an original entry is being concatenated with one or more subsequently added entries.

Parameters:

name - The name of the entry in question.

entries - The entries that will be concatenated with the original entry.

onWrite

void onWrite(JarBuilder.Entry entry)

Called to notify the listener of a newly written non-duplicate entry.

Parameters:

entry - The entry to be added to the target jar.