Class ExceptionTypeFilter

java.lang.Object

org.springframework.util.InstanceFilter<Class<? extends Throwable>>

org.springframework.util.ExceptionTypeFilter

public class ExceptionTypeFilter
extends InstanceFilter<Class<? extends Throwable>>

An InstanceFilter that handles exception types.

An exception type will match against a given candidate if it is assignable to that candidate.

Since:

4.1

Author:

Stephane Nicoll, Sam Brannen

Field Summary

Fields inherited from class InstanceFilter

excludes, includes, matchIfEmpty

Constructor Summary

Constructors

Constructor	Description
ExceptionTypeFilter(@Nullable Collection<? extends Class<? extends Throwable>> includes, @Nullable Collection<? extends Class<? extends Throwable>> excludes, boolean matchIfEmpty)	Create a new ExceptionTypeFilter based on include and exclude collections.
ExceptionTypeFilter(@Nullable Collection<Class<? extends Throwable>> includes, @Nullable Collection<Class<? extends Throwable>> excludes)	Create a new ExceptionTypeFilter based on include and exclude collections, with the matchIfEmpty flag set to true.

Method Summary

Modifier and Type	Method	Description
protected boolean	match(Class<? extends Throwable> instance, Class<? extends Throwable> candidate)	Determine if the specified instance matches the specified candidate.
boolean	match(Throwable exception)	Determine if the type of the supplied exception matches this filter.
boolean	match(Throwable exception, boolean traverseCauses)	Determine if the type of the supplied exception matches this filter, potentially matching against nested causes.

Methods inherited from class InstanceFilter

match, match, toString

Methods inherited from class Object

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

Constructor Details

ExceptionTypeFilter

public ExceptionTypeFilter(@Nullable Collection<Class<? extends Throwable>> includes,
 @Nullable Collection<Class<? extends Throwable>> excludes)

Create a new ExceptionTypeFilter based on include and exclude collections, with the matchIfEmpty flag set to true.

See ExceptionTypeFilter(Collection, Collection, boolean) for details.

Parameters:

includes - the collection of includes

excludes - the collection of excludes

Since:

7.0

ExceptionTypeFilter

public ExceptionTypeFilter(@Nullable Collection<? extends Class<? extends Throwable>> includes,
 @Nullable Collection<? extends Class<? extends Throwable>> excludes,
 boolean matchIfEmpty)

Create a new ExceptionTypeFilter based on include and exclude collections.

See InstanceFilter for details.

Parameters:

includes - the collection of includes

excludes - the collection of excludes

matchIfEmpty - the matching result if the includes and the excludes collections are both null or empty

Method Details

match

public boolean match(Throwable exception)

Determine if the type of the supplied exception matches this filter.

Parameters:

exception - the exception to match against

Returns:

true if this filter matches the supplied exception

Since:

7.0

See Also:

• match(Throwable, boolean)

match

public boolean match(Throwable exception,
 boolean traverseCauses)

Determine if the type of the supplied exception matches this filter, potentially matching against nested causes.

Parameters:

exception - the exception to match against

traverseCauses - whether the matching algorithm should recursively match against nested causes of the exception

Returns:

true if this filter matches the supplied exception or one of its nested causes

Since:

7.0

See Also:

• InstanceFilter.match(Object)

match

protected boolean match(Class<? extends Throwable> instance,
 Class<? extends Throwable> candidate)

Determine if the specified instance matches the specified candidate.

By default, the two instances match if the candidate type is is assignable from the instance type.

Can be overridden by subclasses.

Overrides:

match in class InstanceFilter<Class<? extends Throwable>>

Parameters:

instance - the instance to check

candidate - a candidate defined by this filter

Returns:

true if the instance matches the candidate