org.jsr107.ri.annotations

Class ClassFilter

java.lang.Object

org.jsr107.ri.annotations.ClassFilter

public final class ClassFilter
extends Object

Utility that matches an object's type against a list of included and excluded classes.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

Methods

Modifier and Type	Method and Description
static <T> boolean	isIncluded(T candidate, Class<? extends T>[] included, Class<? extends T>[] excluded, boolean includeBothEmpty) Determines if a candidate object's type passes a set of included/excluded filters Returns true of one of the following conditions is true If included and excluded are both empty then the value passed as includeBothEmpty is returned If included is not empty and excluded is empty and candidate is an instanceof a member of the included array If included is empty and excluded is not empty and candidate is not an instanceof a member of the excluded array If included and excluded are not empty and candidate is an instanceof a member of the included array and candidate is not an instanceof a member of the excluded array
static <T> boolean	matches(T candidate, Class<? extends T>[] classes) Determines if a candidate object's type matches an element in the classes array.

Methods inherited from class java.lang.Object

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

Method Detail

isIncluded

public static <T> boolean isIncluded(T candidate,
                     Class<? extends T>[] included,
                     Class<? extends T>[] excluded,
                     boolean includeBothEmpty)

Determines if a candidate object's type passes a set of included/excluded filters

Returns true of one of the following conditions is true

1. If included and excluded are both empty then the value passed as includeBothEmpty is returned
2. If included is not empty and excluded is empty and candidate is an instanceof a member of the included array
3. If included is empty and excluded is not empty and candidate is not an instanceof a member of the excluded array
4. If included and excluded are not empty and candidate is an instanceof a member of the included array and candidate is not an instanceof a member of the excluded array

Parameters:

candidate - The object to check if it is included or excluded

included - Array of included classes, may be null

excluded - Array of excluded classes, may be null

includeBothEmpty - If true then if both the included and excluded arrays are null true will be returned.

matches

public static <T> boolean matches(T candidate,
                  Class<? extends T>[] classes)

Determines if a candidate object's type matches an element in the classes array.

Parameters:

candidate - The object to check if its type matches one of the classes in the array, must not be null.

classes - List of classes to check against, may be null.

Returns:

null if classes array is null or if candidate is not an instanceof any member of the classes array.