com.deltaxml.core

Class UnsupportedFilterListMemberException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.PipelinedComparatorException

com.deltaxml.core.UnsupportedFilterListMemberException

All Implemented Interfaces:

java.io.Serializable

public class UnsupportedFilterListMemberException
extends PipelinedComparatorException

Thrown to indicate the use of an unsupported filter in a filter List.

The PipelinedComparator can be configured with lists of input and output filters. When these methods are used there are certain constraints on the Objects which can be included in the List. If an unsupported Object is found this exception is thrown. Information about the supplied class of the object and its list position can be obtained through provided methods.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
UnsupportedFilterListMemberException(java.lang.String message, java.lang.Class<?> filterClass) Creates a new UnsupportedFilterListMemberException.
UnsupportedFilterListMemberException(java.lang.String message, java.lang.Class<?> filterClass, int aggregatePosition) Creates a new FilterClassIncompatibilityException.
UnsupportedFilterListMemberException(java.lang.String message, java.lang.Class<?> filterClass, 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<?>	getFilterClass() Provides information about the Object which cannot be used as a filter.
PipelineIOIdentifier	getLocationId() Returns the identity of the filter chain in which the error occurs.

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

UnsupportedFilterListMemberException

public UnsupportedFilterListMemberException(java.lang.String message,
                                            java.lang.Class<?> filterClass)

Creates a new UnsupportedFilterListMemberException.

Parameters:

message - The exception message String

filterClass - the class of the object which cannot be used as a filter

UnsupportedFilterListMemberException

public UnsupportedFilterListMemberException(java.lang.String message,
                                            java.lang.Class<?> filterClass,
                                            int aggregatePosition)

Creates a new FilterClassIncompatibilityException.

Parameters:

message - The exception message String

filterClass - the class of the object which cannot be used as a filter

aggregatePosition - the index into the List of the filter causing the problem

UnsupportedFilterListMemberException

public UnsupportedFilterListMemberException(java.lang.String message,
                                            java.lang.Class<?> filterClass,
                                            int aggregatePosition,
                                            PipelineIOIdentifier locationId)

Creates a new FilterClassIncompatibilityException.

Parameters:

message - The exception message String

filterClass - the class of the object which cannot be used as a filter

aggregatePosition - the index into the List of the filter causing the problem

locationId - specifies which filter chain causes the problem

Since:

6.0

Method Detail

getLocationId

public PipelineIOIdentifier getLocationId()

Returns the identity of the filter chain in which the error occurs.

Returns:

the location of the erroneous filter chain

Since:

6.0

getFilterClass

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

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

Returns:

the class of the object which cannot be used as a filter

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