JBoss Modules 2.1.3.Final · org.jboss.modules.filter.PathFilters

Modifier and Type	Field and Description
private static final PathFilter	defaultImportFilter
private static final PathFilter	defaultImportFilterWithServices
private static final PathFilter	metaInfFilter
private static final PathFilter	metaInfServicesFilter
private static final PathFilter	metaInfSubdirectoriesFilter
private static final PathFilter	metaInfSubdirectoriesWithoutMetaInfFilter

Access	Constructor and Description
private	PathFilters()

Method Summary

Modifier and Type	Method and Description
public static PathFilter	Returns: the accept-all filter acceptAll() Get a filter which always returns `true`.
public static PathFilter	Returns: the "all" filter all(PathFilter... the filters filters) Get a path filter which returns `true` if all of the given filters return `true`.
public static PathFilter	Returns: the "all" filter all(Collection<PathFilter> the filters filters) Get a path filter which returns `true` if all of the given filters return `true`.
public static PathFilter	Returns: the "any" filter any(PathFilter... the filters filters) Get a path filter which returns `true` if any of the given filters return `true`.
public static PathFilter	Returns: the "any" filter any(Collection<PathFilter> the filters filters) Get a path filter which returns `true` if any of the given filters return `true`.
private static BooleanPathFilter	booleanFilter(boolean val)
public static Iterator<Resource>	Returns: the filtered iterator filtered(final PathFilter the filter to check filter, final Iterator<Resource> the original iterator original) Get a filtered view of a resource iteration.
public static PathFilter	Returns: the default import path filter getDefaultImportFilter() Get the default import path filter, which excludes all of `META-INF` and its subdirectories.
public static PathFilter	Returns: the default import-with-services path filter getDefaultImportFilterWithServices() Get the default import-with-services path filter which excludes all of `META-INF` and its subdirectories, with the exception of `META-INF/services`.
public static PathFilter	Returns: the filter getMetaInfFilter() Get a filter which matches the path `"META-INF"`.
public static PathFilter	Returns: the filter getMetaInfServicesFilter() Get a filter which matches the path `"META-INF/services"`.
public static PathFilter	Returns: the filter getMetaInfSubdirectoriesFilter() Get a filter which matches any subdirectory of the path `"META-INF"`.
public static PathFilter	Returns: the filter getMetaInfSubdirectoriesWithoutMetaInfFilter() Get a filter which matches all of `META-INF`'s subdirectories, but not `META-INF` itself.
public static PathFilter	Returns: the filter in(Set<String> the path set paths) Get a filter which returns `true` if the tested path is contained within the given set.
public static PathFilter	Returns: the filter in(Collection<String> the path collection paths) Get a filter which returns `true` if the tested path is contained within the given collection.
public static PathFilter	Returns: a filter which returns `true` if the path name is an exact match is(String the path name path) Get a path filter which matches an exact path name.
public static PathFilter	Returns: a filter which returns `true` if the path name is a child of the given path isChildOf(String the path name path) Get a path filter which matches any path which is a child of the given path name (not including the path name itself).
public static PathFilter	Returns: a filter which returns `true` if the path name is equal to, or a child of, the given path isOrIsChildOf(String the path name path) Get a path filter which matches any path which is equal to, or a child of, the given path name.
public static PathFilter	Returns: a filter which returns `true` if the glob matches match(String the glob glob) Get a path filter which matches a glob.
public static MultiplePathFilterBuilder	Returns: the builder multiplePathFilterBuilder(boolean the value to return if none of the nested filters match defaultValue) Get a builder for a multiple-path filter.
public static PathFilter	Returns: the "none" filter none(PathFilter... the filters filters) Get a path filter which returns `true` if none of the given filters return `true`.
public static PathFilter	Returns: the "none" filter none(Collection<PathFilter> the filters filters) Get a path filter which returns `true` if none of the given filters return `true`.
public static PathFilter	Returns: the inverting filter not(PathFilter the filter filter) Get a path filter which is `true` when the given filter is `false`, and vice-versa.
public static PathFilter	Returns: the reject-all filter rejectAll() Get a filter which always returns `false`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

defaultImportFilter	back to summary
private static final PathFilter defaultImportFilter

defaultImportFilterWithServices	back to summary
private static final PathFilter defaultImportFilterWithServices

metaInfFilter	back to summary
private static final PathFilter metaInfFilter

metaInfServicesFilter	back to summary
private static final PathFilter metaInfServicesFilter

metaInfSubdirectoriesFilter	back to summary
private static final PathFilter metaInfSubdirectoriesFilter

metaInfSubdirectoriesWithoutMetaInfFilter	back to summary
private static final PathFilter metaInfSubdirectoriesWithoutMetaInfFilter

PathFilters	back to summary
private PathFilters()

Method Detail

acceptAll back to summary

acceptAll	back to summary
public static PathFilter acceptAll() Get a filter which always returns `true`. Returns:PathFilter the accept-all filter

public static PathFilter acceptAll()

Get a filter which always returns true.

Returns:PathFilter: the accept-all filter

all back to summary

all	back to summary
public static PathFilter all(PathFilter... filters) Get a path filter which returns `true` if all of the given filters return `true`. Parameters filters:PathFilter[] the filters Returns:PathFilter the "all" filter

public static PathFilter all(PathFilter... filters)

Get a path filter which returns true if all of the given filters return true.

Parameters

filters:PathFilter[]: the filters

Returns:PathFilter

the "all" filter

all back to summary

all	back to summary
public static PathFilter all(Collection<PathFilter> filters) Get a path filter which returns `true` if all of the given filters return `true`. Parameters filters:Collection<PathFilter> the filters Returns:PathFilter the "all" filter

public static PathFilter all(Collection<PathFilter> filters)

Get a path filter which returns true if all of the given filters return true.

Parameters

filters:Collection<PathFilter>: the filters

Returns:PathFilter

the "all" filter

any back to summary

any	back to summary
public static PathFilter any(PathFilter... filters) Get a path filter which returns `true` if any of the given filters return `true`. Parameters filters:PathFilter[] the filters Returns:PathFilter the "any" filter

public static PathFilter any(PathFilter... filters)

Get a path filter which returns true if any of the given filters return true.

Parameters

filters:PathFilter[]: the filters

Returns:PathFilter

the "any" filter

any back to summary

any	back to summary
public static PathFilter any(Collection<PathFilter> filters) Get a path filter which returns `true` if any of the given filters return `true`. Parameters filters:Collection<PathFilter> the filters Returns:PathFilter the "any" filter

public static PathFilter any(Collection<PathFilter> filters)

Get a path filter which returns true if any of the given filters return true.

Parameters

filters:Collection<PathFilter>: the filters

Returns:PathFilter

the "any" filter

booleanFilter	back to summary
private static BooleanPathFilter booleanFilter(boolean val)

filtered	back to summary
public static Iterator<Resource> filtered(final PathFilter filter, final Iterator<Resource> original) Get a filtered view of a resource iteration. Only resources which pass the given filter are accepted. Parameters filter:PathFilter the filter to check original:Iterator<Resource> the original iterator Returns:Iterator<Resource> the filtered iterator

filtered

back to summary

public static Iterator<Resource> filtered(final PathFilter filter, final Iterator<Resource> original)

Get a filtered view of a resource iteration. Only resources which pass the given filter are accepted.

Parameters

filter:PathFilter: the filter to check
original:Iterator<Resource>: the original iterator

Returns:Iterator<Resource>

the filtered iterator

getDefaultImportFilter back to summary

getDefaultImportFilter	back to summary
public static PathFilter getDefaultImportFilter() Get the default import path filter, which excludes all of `META-INF` and its subdirectories. Returns:PathFilter the default import path filter

public static PathFilter getDefaultImportFilter()

Get the default import path filter, which excludes all of META-INF and its subdirectories.

Returns:PathFilter: the default import path filter

getDefaultImportFilterWithServices back to summary

getDefaultImportFilterWithServices	back to summary
public static PathFilter getDefaultImportFilterWithServices() Get the default import-with-services path filter which excludes all of `META-INF` and its subdirectories, with the exception of `META-INF/services`. Returns:PathFilter the default import-with-services path filter

public static PathFilter getDefaultImportFilterWithServices()

Get the default import-with-services path filter which excludes all of META-INF and its subdirectories, with the exception of META-INF/services.

Returns:PathFilter: the default import-with-services path filter

getMetaInfFilter back to summary

getMetaInfFilter	back to summary
public static PathFilter getMetaInfFilter() Get a filter which matches the path `"META-INF"`. Returns:PathFilter the filter

public static PathFilter getMetaInfFilter()

Get a filter which matches the path "META-INF".

Returns:PathFilter: the filter

getMetaInfServicesFilter back to summary

getMetaInfServicesFilter	back to summary
public static PathFilter getMetaInfServicesFilter() Get a filter which matches the path `"META-INF/services"`. Returns:PathFilter the filter

public static PathFilter getMetaInfServicesFilter()

Get a filter which matches the path "META-INF/services".

Returns:PathFilter: the filter

getMetaInfSubdirectoriesFilter back to summary

getMetaInfSubdirectoriesFilter	back to summary
public static PathFilter getMetaInfSubdirectoriesFilter() Get a filter which matches any subdirectory of the path `"META-INF"`. Returns:PathFilter the filter

public static PathFilter getMetaInfSubdirectoriesFilter()

Get a filter which matches any subdirectory of the path "META-INF".

Returns:PathFilter: the filter

getMetaInfSubdirectoriesWithoutMetaInfFilter back to summary

getMetaInfSubdirectoriesWithoutMetaInfFilter	back to summary
public static PathFilter getMetaInfSubdirectoriesWithoutMetaInfFilter() Get a filter which matches all of `META-INF`'s subdirectories, but not `META-INF` itself. Returns:PathFilter the filter

public static PathFilter getMetaInfSubdirectoriesWithoutMetaInfFilter()

Get a filter which matches all of META-INF's subdirectories, but not META-INF itself.

Returns:PathFilter: the filter

in back to summary

in	back to summary
public static PathFilter in(Set<String> paths) Get a filter which returns `true` if the tested path is contained within the given set. Each member of the set is a path separated by "`/`" characters; `null`s are disallowed. Parameters paths:Set<String> the path set Returns:PathFilter the filter

public static PathFilter in(Set<String> paths)

Get a filter which returns true if the tested path is contained within the given set. Each member of the set is a path separated by "/" characters; nulls are disallowed.

Parameters

paths:Set<String>: the path set

Returns:PathFilter

the filter

in back to summary

in	back to summary
public static PathFilter in(Collection<String> paths) Get a filter which returns `true` if the tested path is contained within the given collection. Each member of the collection is a path separated by "`/`" characters; `null`s are disallowed. Parameters paths:Collection<String> the path collection Returns:PathFilter the filter

public static PathFilter in(Collection<String> paths)

Get a filter which returns true if the tested path is contained within the given collection. Each member of the collection is a path separated by "/" characters; nulls are disallowed.

Parameters

paths:Collection<String>: the path collection

Returns:PathFilter

the filter

is back to summary

is	back to summary
public static PathFilter is(String path) Get a path filter which matches an exact path name. Parameters path:String the path name Returns:PathFilter a filter which returns `true` if the path name is an exact match

public static PathFilter is(String path)

Get a path filter which matches an exact path name.

Parameters

path:String: the path name

Returns:PathFilter

a filter which returns true if the path name is an exact match

isChildOf back to summary

isChildOf	back to summary
public static PathFilter isChildOf(String path) Get a path filter which matches any path which is a child of the given path name (not including the path name itself). Parameters path:String the path name Returns:PathFilter a filter which returns `true` if the path name is a child of the given path

public static PathFilter isChildOf(String path)

Get a path filter which matches any path which is a child of the given path name (not including the path name itself).

Parameters

path:String: the path name

Returns:PathFilter

a filter which returns true if the path name is a child of the given path

isOrIsChildOf back to summary

isOrIsChildOf	back to summary
public static PathFilter isOrIsChildOf(String path) Get a path filter which matches any path which is equal to, or a child of, the given path name. Parameters path:String the path name Returns:PathFilter a filter which returns `true` if the path name is equal to, or a child of, the given path

public static PathFilter isOrIsChildOf(String path)

Get a path filter which matches any path which is equal to, or a child of, the given path name.

Parameters

path:String: the path name

Returns:PathFilter

a filter which returns true if the path name is equal to, or a child of, the given path

match back to summary

match	back to summary
public static PathFilter match(String glob) Get a path filter which matches a glob. The given glob is a path separated by "`/`" characters, which may include the special "``" and "`*`" segment strings which match any directory and any number of nested directories, respectively. Parameters glob:String the glob Returns:PathFilter a filter which returns `true` if the glob matches

public static PathFilter match(String glob)

Get a path filter which matches a glob. The given glob is a path separated by "/" characters, which may include the special "*" and "**" segment strings which match any directory and any number of nested directories, respectively.

Parameters

glob:String: the glob

Returns:PathFilter

a filter which returns true if the glob matches

multiplePathFilterBuilder	back to summary
public static MultiplePathFilterBuilder multiplePathFilterBuilder(boolean defaultValue) Get a builder for a multiple-path filter. Such a filter contains multiple filters, each associated with a flag which indicates that matching paths should be included or excluded. Parameters defaultValue:boolean the value to return if none of the nested filters match Returns:MultiplePathFilterBuilder the builder

multiplePathFilterBuilder

back to summary

public static MultiplePathFilterBuilder multiplePathFilterBuilder(boolean defaultValue)

Get a builder for a multiple-path filter. Such a filter contains multiple filters, each associated with a flag which indicates that matching paths should be included or excluded.

Parameters

defaultValue:boolean: the value to return if none of the nested filters match

Returns:MultiplePathFilterBuilder

the builder

none back to summary

none	back to summary
public static PathFilter none(PathFilter... filters) Get a path filter which returns `true` if none of the given filters return `true`. Parameters filters:PathFilter[] the filters Returns:PathFilter the "none" filter

public static PathFilter none(PathFilter... filters)

Get a path filter which returns true if none of the given filters return true.

Parameters

filters:PathFilter[]: the filters

Returns:PathFilter

the "none" filter

none back to summary

none	back to summary
public static PathFilter none(Collection<PathFilter> filters) Get a path filter which returns `true` if none of the given filters return `true`. Parameters filters:Collection<PathFilter> the filters Returns:PathFilter the "none" filter

public static PathFilter none(Collection<PathFilter> filters)

Get a path filter which returns true if none of the given filters return true.

Parameters

filters:Collection<PathFilter>: the filters

Returns:PathFilter

the "none" filter

not back to summary

not	back to summary
public static PathFilter not(PathFilter filter) Get a path filter which is `true` when the given filter is `false`, and vice-versa. Parameters filter:PathFilter the filter Returns:PathFilter the inverting filter

public static PathFilter not(PathFilter filter)

Get a path filter which is true when the given filter is false, and vice-versa.

Parameters

filter:PathFilter: the filter

Returns:PathFilter

the inverting filter

rejectAll back to summary

rejectAll	back to summary
public static PathFilter rejectAll() Get a filter which always returns `false`. Returns:PathFilter the reject-all filter

public static PathFilter rejectAll()

Get a filter which always returns false.

Returns:PathFilter: the reject-all filter

public final Class PathFilters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail