org.jboss.shrinkwrap.api

Class Filters

java.lang.Object

org.jboss.shrinkwrap.api.Filters

public final class Filters
extends java.lang.Object

Factory class for the creation of new Filter instances. Filter instances using this shorthand class will be created using the ClassLoader associated with the default Domain's Configuration.

Version:

$Revision: $

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	IMPL_CLASS_NAME_EXCLUDE_PATHS
private static java.lang.String	IMPL_CLASS_NAME_EXCLUDE_REGEXP_PATHS
private static java.lang.String	IMPL_CLASS_NAME_INCLUDE_ALL_PATHS
private static java.lang.String	IMPL_CLASS_NAME_INCLUDE_PATHS
private static java.lang.String	IMPL_CLASS_NAME_INCLUDE_REGEXP_PATHS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Filters() No instantiation

Method Summary

Modifier and Type	Method and Description
private static Filter<ArchivePath>	createRegExpFilter(java.lang.String regExpFilterImplName, java.lang.Class<?>... classes)
private static Filter<ArchivePath>	createRegExpFilter(java.lang.String filterClassName, java.lang.Package... packages)
static Filter<ArchivePath>	exclude(java.lang.Class<?>... classes) Filter that excludes listed Class.
static Filter<ArchivePath>	exclude(java.lang.Package... packages) Filter that includes listed Package.
static Filter<ArchivePath>	exclude(java.lang.String regexp) Filter that exclude all ArchivePaths that match a given Regular Expression Pattern.
static Filter<ArchivePath>	excludePaths(java.util.Collection<java.lang.String> paths) Filter that exclude all ArchivePaths that match the given List of paths.
static Filter<ArchivePath>	excludePaths(java.lang.String... paths) Filter that exclude all ArchivePaths that match the given List of paths.
private static Filter<ArchivePath>	getFilterInstance(java.lang.String filterClassName, java.lang.Class<?>[] ctorTypes, java.lang.Object[] ctorArguments) Creates a new Filter instance using the given impl class name, constructor arguments and type
static Filter<ArchivePath>	include(java.lang.Class<?>... classes) Filter that includes listed Class.
static Filter<ArchivePath>	include(java.lang.Package... packages) Filter that excludes listed Package.
static Filter<ArchivePath>	include(java.lang.String regexp) Filer that include all ArchivePaths that match the given Regular Expression Pattern.
static Filter<ArchivePath>	includeAll() Filter that includes all ArchivePaths.
static Filter<ArchivePath>	includePaths(java.util.Collection<java.lang.String> paths) Filer that include all ArchivePaths that match the given List of paths..
static Filter<ArchivePath>	includePaths(java.lang.String... paths) Filer that include all ArchivePaths that match the given List of paths..

Methods inherited from class java.lang.Object

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

Field Detail

IMPL_CLASS_NAME_INCLUDE_ALL_PATHS

private static final java.lang.String IMPL_CLASS_NAME_INCLUDE_ALL_PATHS

See Also:

Constant Field Values

IMPL_CLASS_NAME_INCLUDE_REGEXP_PATHS

private static final java.lang.String IMPL_CLASS_NAME_INCLUDE_REGEXP_PATHS

See Also:

Constant Field Values

IMPL_CLASS_NAME_EXCLUDE_REGEXP_PATHS

private static final java.lang.String IMPL_CLASS_NAME_EXCLUDE_REGEXP_PATHS

See Also:

Constant Field Values

IMPL_CLASS_NAME_INCLUDE_PATHS

private static final java.lang.String IMPL_CLASS_NAME_INCLUDE_PATHS

See Also:

Constant Field Values

IMPL_CLASS_NAME_EXCLUDE_PATHS

private static final java.lang.String IMPL_CLASS_NAME_EXCLUDE_PATHS

See Also:

Constant Field Values

Constructor Detail

Filters

private Filters()

No instantiation

Method Detail

includeAll

public static Filter<ArchivePath> includeAll()

Filter that includes all ArchivePaths. Only meant to be used internally.

Returns:

A Filter that always return true

include

public static Filter<ArchivePath> include(java.lang.String regexp)

Filer that include all ArchivePaths that match the given Regular Expression Pattern.

Parameters:

regexp - The expression to include

Returns:

A Regular Expression based include Filter

exclude

public static Filter<ArchivePath> exclude(java.lang.String regexp)

Filter that exclude all ArchivePaths that match a given Regular Expression Pattern.

Parameters:

regexp - The expression to exclude

Returns:

A Regular Expression based exclude Filter

includePaths

public static Filter<ArchivePath> includePaths(java.lang.String... paths)

Filer that include all ArchivePaths that match the given List of paths..

Parameters:

paths - The paths to included

Returns:

A Path list based include Filter

includePaths

public static Filter<ArchivePath> includePaths(java.util.Collection<java.lang.String> paths)

Filer that include all ArchivePaths that match the given List of paths..

Parameters:

paths - The paths to included

Returns:

A Path list based include Filter

excludePaths

public static Filter<ArchivePath> excludePaths(java.lang.String... paths)

Filter that exclude all ArchivePaths that match the given List of paths.

Parameters:

paths - The paths to exclude

Returns:

A Path list based exclude Filter

excludePaths

public static Filter<ArchivePath> excludePaths(java.util.Collection<java.lang.String> paths)

Filter that exclude all ArchivePaths that match the given List of paths.

Parameters:

paths - The paths to exclude

Returns:

A Path list based exclude Filter

exclude

public static Filter<ArchivePath> exclude(java.lang.Package... packages)

Filter that includes listed Package.

Parameters:

packages - To be included

Returns:

include

public static Filter<ArchivePath> include(java.lang.Package... packages)

Filter that excludes listed Package.

Parameters:

packages - To be excluded

Returns:

createRegExpFilter

private static Filter<ArchivePath> createRegExpFilter(java.lang.String filterClassName,
                                                      java.lang.Package... packages)

include

public static Filter<ArchivePath> include(java.lang.Class<?>... classes)

Filter that includes listed Class.

Parameters:

classes - To be included

Returns:

exclude

public static Filter<ArchivePath> exclude(java.lang.Class<?>... classes)

Filter that excludes listed Class.

Parameters:

classes - To be excluded

Returns:

createRegExpFilter

private static Filter<ArchivePath> createRegExpFilter(java.lang.String regExpFilterImplName,
                                                      java.lang.Class<?>... classes)

getFilterInstance

private static Filter<ArchivePath> getFilterInstance(java.lang.String filterClassName,
                                                     java.lang.Class<?>[] ctorTypes,
                                                     java.lang.Object[] ctorArguments)

Creates a new Filter instance using the given impl class name, constructor arguments and type

Parameters:

filterClassName -

ctorTypes -

ctorArguments -

Returns: