Package com.wavemaker.commons.io

Class FilterOn

java.lang.Object

com.wavemaker.commons.io.FilterOn

public abstract class FilterOn
extends java.lang.Object

Builder class that can be used to easily construct ResourceFilters. Filters can be built for Files, Folders or Resources with matching performed on names or paths. Builders can be chained together to form compound (AND) matches.

See Also:

ResourceFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterOn.AttributeFilter	The ResourceFilter and builder used to further restrict filtering.
static class	FilterOn.PathStyle
static class	FilterOn.ResourceAttribute	Various attributes that can be used to filter resources.

Constructor Summary

Constructors

Constructor	Description
FilterOn()

Method Summary

Modifier and Type	Method	Description
static ResourceFilter	antPattern(FilterOn.PathStyle pathStyle, java.lang.String... pattern)	Returns an resource filter based on ant patterns.
static ResourceFilter	antPattern(java.lang.String... pattern)	Returns an resource filter based on ant patterns.
static FilterOn.AttributeFilter	caseSensitiveNames()	Start filtering based on Resource names.
static FilterOn.AttributeFilter	caseSensitivePaths()	Start filtering based on Resource paths.
static FilterOn.AttributeFilter	caseSensitivePaths(FilterOn.PathStyle pathStyle)	Start filtering based on Resource paths.
static FilterOn.AttributeFilter	getFor(FilterOn.ResourceAttribute attribute)	Start filtering based on the specified resource type and attribute.
static ResourceFilter	hidden()	Filter all hidden resources (ie resource names starting '.')
static FilterOn.AttributeFilter	names()	Start filtering based on Resource names.
static ResourceFilter	nonHidden()	Filter all non-hidden resources (ie resource names not starting '.');
static FilterOn.AttributeFilter	paths()	Start filtering based on Resource paths.
static FilterOn.AttributeFilter	paths(FilterOn.PathStyle pathStyle)	Start filtering based on Resource paths.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterOn

public FilterOn()

Method Detail

names

public static FilterOn.AttributeFilter names()

Start filtering based on Resource names. NOTE: matching is case sensitive.

Returns:

the filter

caseSensitiveNames

public static FilterOn.AttributeFilter caseSensitiveNames()

Start filtering based on Resource names. NOTE: matching is case insensitive.

Returns:

the filter

paths

public static FilterOn.AttributeFilter paths()

Start filtering based on Resource paths. NOTE: matching is case insensitive and paths are considered relative to ResourceFilterContext.getSource().

Returns:

the filter

paths

public static FilterOn.AttributeFilter paths(FilterOn.PathStyle pathStyle)

Start filtering based on Resource paths. NOTE: matching is case insensitive.

Parameters:

pathStyle - the path match style

Returns:

the filter

caseSensitivePaths

public static FilterOn.AttributeFilter caseSensitivePaths()

Start filtering based on Resource paths. NOTE: matching is case sensitive and paths are considered relative to ResourceFilterContext.getSource().

Returns:

the filter

caseSensitivePaths

public static FilterOn.AttributeFilter caseSensitivePaths(FilterOn.PathStyle pathStyle)

Start filtering based on Resource paths. NOTE: matching is case sensitive.

Returns:

the filter

getFor

public static FilterOn.AttributeFilter getFor(FilterOn.ResourceAttribute attribute)

Start filtering based on the specified resource type and attribute.

Parameters:

resourceType - the resource type

attribute - the attribute

Returns:

the filter

hidden

public static ResourceFilter hidden()

Filter all hidden resources (ie resource names starting '.')

Returns:

the filter

nonHidden

public static ResourceFilter nonHidden()

Filter all non-hidden resources (ie resource names not starting '.');

Returns:

the filter

antPattern

public static ResourceFilter antPattern(java.lang.String... pattern)

Returns an resource filter based on ant patterns. Paths are considered relative from the ResourceFilterContext.getSource().

Parameters:

pattern - the ant pattern

Returns:

a ant pattern based resource filter

antPattern

public static ResourceFilter antPattern(FilterOn.PathStyle pathStyle,
                                        java.lang.String... pattern)

Returns an resource filter based on ant patterns.

Parameters:

pattern - the ant pattern

Returns:

a ant pattern based resource filter