public class

PackageScannerConfigurationBuilder

extends Object
java.lang.Object
   ↳ com.atlassian.plugin.main.PackageScannerConfigurationBuilder

Class Overview

The builder for PackageScannerConfiguration instances that additionally performs validation and default creation. For a usage example, see the package javadocs.

Not thread-safe. Instances of this class should be thread and preferably method local.

Summary

Public Constructors
PackageScannerConfigurationBuilder()
Default constructor.
PackageScannerConfigurationBuilder(PackageScannerConfiguration packageScannerConfiguration)
Copy constructor.
Public Methods
PackageScannerConfiguration build()
Builds a PackageScannerConfiguration instance by processing the configuration that was previously set and setting any defaults where not explicitly specified.
PackageScannerConfigurationBuilder hostVersion(String... pkgs)
Sets the current host version.
PackageScannerConfigurationBuilder jarsToExclude(String... jars)
Sets a list of jar expressions to hide from plugins.
PackageScannerConfigurationBuilder jarsToInclude(String... jars)
Sets a list of jar expressions to expose to plugins.
static PackageScannerConfigurationBuilder packageScannerConfiguration()
Static factory for creating a new builder.
PackageScannerConfigurationBuilder packagesToExclude(String... pkgs)
Sets a list of package expressions to hide from plugins.
PackageScannerConfigurationBuilder packagesToInclude(String... pkgs)
Sets a list of package expressions to expose to plugins.
PackageScannerConfigurationBuilder packagesVersions(Map<String, String> packageToVersion)
Sets which packages should be exposed as which versions.
PackageScannerConfigurationBuilder servletContext(ServletContext servletContext)
Sets the ServletContext used to lookup jars as some application servers need it to lookup jar files.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PackageScannerConfigurationBuilder ()

Default constructor. Uses a DefaultPackageScannerConfiguration as the template.

public PackageScannerConfigurationBuilder (PackageScannerConfiguration packageScannerConfiguration)

Copy constructor. Use the supplied PackageScannerConfiguration as a template.

Public Methods

public PackageScannerConfiguration build ()

Builds a PackageScannerConfiguration instance by processing the configuration that was previously set and setting any defaults where not explicitly specified.

Returns

public PackageScannerConfigurationBuilder hostVersion (String... pkgs)

Sets the current host version.

Parameters
pkgs A list of package expressions, where the '*' character matches any character including subpackages
Returns
  • this
See Also

public PackageScannerConfigurationBuilder jarsToExclude (String... jars)

Sets a list of jar expressions to hide from plugins.

Returns
  • this
See Also

public PackageScannerConfigurationBuilder jarsToInclude (String... jars)

Sets a list of jar expressions to expose to plugins.

Returns
  • this
See Also

public static PackageScannerConfigurationBuilder packageScannerConfiguration ()

Static factory for creating a new builder.

Returns
  • a new builder.

public PackageScannerConfigurationBuilder packagesToExclude (String... pkgs)

Sets a list of package expressions to hide from plugins.

Parameters
pkgs A list of package expressions, where the '*' character matches any character including subpackages
Returns
  • this
See Also

public PackageScannerConfigurationBuilder packagesToInclude (String... pkgs)

Sets a list of package expressions to expose to plugins.

Parameters
pkgs A list of package expressions, where the '*' character matches any character including subpackages
Returns
  • this
See Also

public PackageScannerConfigurationBuilder packagesVersions (Map<String, String> packageToVersion)

Sets which packages should be exposed as which versions.

Parameters
packageToVersion A map of package names to version names. No wildcards allowed, and the version names must match the expected OSGi versioning scheme.
Returns
  • this
See Also

public PackageScannerConfigurationBuilder servletContext (ServletContext servletContext)

Sets the ServletContext used to lookup jars as some application servers need it to lookup jar files.

Returns
  • this
See Also
  • PackageScannerConfiguration#getS()