com.deltaxml.core

Class FilterClassIncompatibilityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.PipelinedComparatorException

com.deltaxml.core.FilterClassIncompatibilityException

All Implemented Interfaces:

java.io.Serializable

public class FilterClassIncompatibilityException
extends PipelinedComparatorException

Thrown to indicate that a filter class incompatibility has been detected.

SAX event filters implemented in Java have to be assignment compatible with a small set of appropriate classes in order for them to be deployed in a pipeline. The set of appropriate classes depends on whether the filter is being used for input filtering prior to the comparator, or output filtering after the comparator. See the documentation for the various overloaded setInputFilters and setOutputFilters methods for full details of the allowable classes.

The classes which are allowable in the given context can be determined with the FilterClassIncompatibilityException.getAllowableFilterClasses() method. The class which is assignment incompatible, and caused the exception, is available with the FilterClassIncompatibilityException.getProposedFilterClass() method.

In some cases the filter setting methods take aggregates (Arrays, Lists) of filters. The FilterClassIncompatibilityException.getAggregatePosition() method can be used to report which element of the aggregate caused the problem.

See Also:

PipelinedComparator#setInputFilters(Class[]), PipelinedComparator#setInputFilters(java.util.List), PipelinedComparator#setOutputFilters(Class[]), PipelinedComparator#setOutputFilters(java.util.List), Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterClassIncompatibilityException(java.lang.String message, java.lang.Class<?> proposedFilterClass, java.lang.Class<?>[] allowableFilterClasses) Creates a new FilterClassIncompatibilityException.
FilterClassIncompatibilityException(java.lang.String message, java.lang.Class<?> proposedFilterClass, java.lang.Class<?>[] allowableFilterClasses, int aggregatePosition) Creates a new FilterClassIncompatibilityException.
FilterClassIncompatibilityException(java.lang.String message, java.lang.Class<?> proposedFilterClass, java.lang.Class<?>[] allowableFilterClasses, int aggregatePosition, PipelineIOIdentifier locationId) Creates a new FilterClassIncompatibilityException.

Method Summary

Modifier and Type	Method and Description
int	getAggregatePosition() Reports the member of an aggregate which caused the problem.
java.lang.Class<?>[]	getAllowableFilterClasses() Reports the classes which may be used as a filter in this context.
PipelineIOIdentifier	getLocationId() Returns the identity of the filter chain in which the problem occurred.
java.lang.Class<?>	getProposedFilterClass() Provides information about the class which cannot be used as a filter.

Methods inherited from class com.deltaxml.api.DeltaXMLException

getCause, getThrowable

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterClassIncompatibilityException

public FilterClassIncompatibilityException(java.lang.String message,
                                           java.lang.Class<?> proposedFilterClass,
                                           java.lang.Class<?>[] allowableFilterClasses)

Creates a new FilterClassIncompatibilityException.

Parameters:

message - The exception message String

proposedFilterClass - the class causing the incompatibility

allowableFilterClasses - the set of classes allowed in the context, passed as an array

FilterClassIncompatibilityException

public FilterClassIncompatibilityException(java.lang.String message,
                                           java.lang.Class<?> proposedFilterClass,
                                           java.lang.Class<?>[] allowableFilterClasses,
                                           int aggregatePosition)

Creates a new FilterClassIncompatibilityException.

Parameters:

message - The exception message String

proposedFilterClass - the class causing the incompatibility

allowableFilterClasses - the set of classes allowed in the context, passed as an array

aggregatePosition - an index into an aggregate of filters to identify the one at fault

FilterClassIncompatibilityException

public FilterClassIncompatibilityException(java.lang.String message,
                                           java.lang.Class<?> proposedFilterClass,
                                           java.lang.Class<?>[] allowableFilterClasses,
                                           int aggregatePosition,
                                           PipelineIOIdentifier locationId)

Creates a new FilterClassIncompatibilityException.

Parameters:

message - The exception message String

proposedFilterClass - the class causing the incompatibility

allowableFilterClasses - the set of classes allowed in the context, passed as an array

aggregatePosition - an index into an aggregate of filters to identify the one at fault

locationId - the id of the pipeline on which the error has occurred

Since:

6.0

Method Detail

getProposedFilterClass

public java.lang.Class<?> getProposedFilterClass()

Provides information about the class which cannot be used as a filter.

Returns:

the class which cannot be used in this context

getAllowableFilterClasses

public java.lang.Class<?>[] getAllowableFilterClasses()

Reports the classes which may be used as a filter in this context.

Returns:

An array containing the set of classes which may be used

getAggregatePosition

public int getAggregatePosition()

Reports the member of an aggregate which caused the problem.

Returns:

an index into a list or array for the erroneous class

getLocationId

public PipelineIOIdentifier getLocationId()

Returns the identity of the filter chain in which the problem occurred.

Returns:

An identifier of the problem filter-chain

Since:

6.0