net.fortuna.ical4j.filter

Class Filter


public class Filter
extends java.lang.Object

$Id: Filter.java,v 1.8 2008/12/16 12:34:54 fortuna Exp $ Created: Feb 1, 2006 Performs collection filtering based on a set of rules. A filter may dictate whether at least one rule or all rules are matched.

Field Summary

static int
MATCH_ALL
Indicates that all rules must be matched to include an object in the filtered collection.
static int
MATCH_ANY
Indicates that any rule may be matched to include an object in the filtered collection.

Constructor Summary

Filter(Rule rule)
Constructor.
Filter(Rule[] rules, int type)
Constructor.

Method Summary

Collection
filter(Collection c)
Filter the given collection into a new collection.
Object[]
filter(Object[] objects)
Returns a filtered subset of the specified array.
Rule[]
getRules()
void
setRules(Rule[] rules)

Field Details

MATCH_ALL

public static final int MATCH_ALL
Indicates that all rules must be matched to include an object in the filtered collection.
Field Value:
2

MATCH_ANY

public static final int MATCH_ANY
Indicates that any rule may be matched to include an object in the filtered collection.
Field Value:
1

Constructor Details

Filter

public Filter(Rule rule)
Constructor.
Parameters:
rule - a rule that defines this filter

Filter

public Filter(Rule[] rules,
              int type)
Constructor.
Parameters:
rules - an array of rules that define this filter

Method Details

filter

public final Collection filter(Collection c)
Filter the given collection into a new collection.
Parameters:
c - a collection to filter
Returns:
a filtered collection

filter

public final Object[] filter(Object[] objects)
Returns a filtered subset of the specified array.
Parameters:
objects - an array to filter
Returns:
a filtered array

getRules

public final Rule[] getRules()
Returns:
Returns the rules.

setRules

public final void setRules(Rule[] rules)
Parameters:
rules - The rules to set.