de.skuzzle.tinyplugz.internal

Class PluginSourceBuilderImpl

java.lang.Object

de.skuzzle.tinyplugz.internal.PluginSourceBuilderImpl

All Implemented Interfaces:

PluginSourceBuilder

public final class PluginSourceBuilderImpl
extends Object
implements PluginSourceBuilder

Default implementation for PluginSourceBuilder.

Author:

Simon Taddiken

Constructor Summary

Constructors

Constructor and Description
PluginSourceBuilderImpl()

Method Summary

Modifier and Type	Method and Description
PluginSourceBuilder	addAllPluginJars(@Nullable Path folder, @Nullable Predicate<Path> filter) Adds all jar files from the given folder for which the given predicate holds true as plugin.
PluginSourceBuilder	addPlugin(@Nullable URL url) Adds a plugin which is located by the given URL.
PluginSourceBuilder	addPluginJar(@Nullable Path jarFile) Adds the given jar file as plugin.
PluginSourceBuilder	addUnpackedPlugin(@Nullable Path folder) Adds a plugin which is not packed into a jar but which contents are contained in the given folder.
PluginSource	createSource() Creates a PluginSource from the configured URLs.
PluginSourceBuilder	include(@Nullable PluginSource source) Includes all plugins from the given source in the source which is to be built by this builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.skuzzle.tinyplugz.PluginSourceBuilder

addAllPluginJars, noPlugins

Constructor Detail

PluginSourceBuilderImpl

public PluginSourceBuilderImpl()

Method Detail

include

public PluginSourceBuilder include(@Nullable PluginSource source)

Description copied from interface: PluginSourceBuilder

Includes all plugins from the given source in the source which is to be built by this builder. The URLS from the source's stream will be eagerly processed by this method.

Specified by:

include in interface PluginSourceBuilder

Parameters:

source - The source to include.

Returns:

This instance.

addUnpackedPlugin

public final PluginSourceBuilder addUnpackedPlugin(@Nullable Path folder)

Description copied from interface: PluginSourceBuilder

Adds a plugin which is not packed into a jar but which contents are contained in the given folder.

Specified by:

addUnpackedPlugin in interface PluginSourceBuilder

Parameters:

folder - The folder.

Returns:

This instance.

addPluginJar

public final PluginSourceBuilder addPluginJar(@Nullable Path jarFile)

Description copied from interface: PluginSourceBuilder

Adds the given jar file as plugin.

Specified by:

addPluginJar in interface PluginSourceBuilder

Parameters:

jarFile - Path to the jar file.

Returns:

This instance.

addAllPluginJars

public final PluginSourceBuilder addAllPluginJars(@Nullable Path folder,
                                                  @Nullable Predicate<Path> filter)

Description copied from interface: PluginSourceBuilder

Adds all jar files from the given folder for which the given predicate holds true as plugin. The search is not done recursively in sub folders.

Specified by:

addAllPluginJars in interface PluginSourceBuilder

Parameters:

folder - The folder containing the files.

filter - The filter.

Returns:

This instance.

addPlugin

public PluginSourceBuilder addPlugin(@Nullable URL url)

Description copied from interface: PluginSourceBuilder

Adds a plugin which is located by the given URL.

Specified by:

addPlugin in interface PluginSourceBuilder

Parameters:

url - The URL of the plugin.

Returns:

This instance.

createSource

public PluginSource createSource()

Description copied from interface: PluginSourceBuilder

Creates a PluginSource from the configured URLs.

Specified by:

createSource in interface PluginSourceBuilder

Returns:

The new PluginSource.