com.deltaxml.core

Class PropertySettingNotSupportedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.PipelinedComparatorException

com.deltaxml.core.PropertySettingNotSupportedException

All Implemented Interfaces:

java.io.Serializable

public class PropertySettingNotSupportedException
extends PipelinedComparatorException

Thrown to indicate a problem setting a property with an unsupported value or type.

Properties provide an extensible mechanism for configuring the operation of the pipeline. Unlike features these methods accept or provide complex String, or more generally Object, values rather than booleans. They are used in different contexts:

• SAX Parser configuration through PipelinedComparator#setParserProperty(String, Object)
• Comparator configuration through PipelinedComparator#setComparatorProperty(String, Object)
• Output formation specification with: PipelinedComparator#setOutputProperty(String, String)

In certain circumstances the acceptable types and values which can be assigned are restricted. This exception is used to indicate when these restrictions have been broken. The PropertySettingNotSupportedException.getSuppliedClass() can be used to report the Class of argument supplied, while PropertySettingNotSupportedException.getRequiredClass() lists the class with which the supplied value must be assignment compatible.

See Also:

PipelinedComparator#setParserProperty(String, Object), PipelinedComparator#setComparatorProperty(String, Object), PipelinedComparator#setOutputProperty(String, String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
PropertySettingNotSupportedException(java.lang.String message, java.lang.String propertyName, java.lang.Class<?> suppliedClass) Creates a new PropertySettingNotSupportedException.
PropertySettingNotSupportedException(java.lang.String message, java.lang.String propertyName, java.lang.Class<?> suppliedClass, java.lang.Class<?> requiredClass) Creates a new PropertySettingNotSupportedException.
PropertySettingNotSupportedException(java.lang.String message, java.lang.Throwable e, java.lang.String propertyName, java.lang.Class<?> suppliedClass, java.lang.Class<?> requiredClass) Creates a new PropertySettingNotSupportedException.
PropertySettingNotSupportedException(java.lang.Throwable e, java.lang.String propertyName, java.lang.Class<?> suppliedClass, java.lang.Class<?> requiredClass) Creates a new PropertySettingNotSupportedException.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPropertyName() Reports the property name which was being set.
java.lang.Class<?>	getRequiredClass() Reports the Class to which the supplied value must be assignment compatible.
java.lang.Class<?>	getSuppliedClass() Reports the Class of the value supplied when trying to set the property.

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

PropertySettingNotSupportedException

public PropertySettingNotSupportedException(java.lang.String message,
                                            java.lang.Throwable e,
                                            java.lang.String propertyName,
                                            java.lang.Class<?> suppliedClass,
                                            java.lang.Class<?> requiredClass)

Creates a new PropertySettingNotSupportedException.

Parameters:

message - The message string

e - A nested throwable should it have lead to this exception

propertyName - the name of the property that caused the problem

suppliedClass - the class of the supplied value

requiredClass - the class which the supplied value should be compatible with

PropertySettingNotSupportedException

public PropertySettingNotSupportedException(java.lang.String message,
                                            java.lang.String propertyName,
                                            java.lang.Class<?> suppliedClass)

Creates a new PropertySettingNotSupportedException.

Parameters:

message - The message string

propertyName - the name of the property being set or requested

suppliedClass - the class of the supplied value

PropertySettingNotSupportedException

public PropertySettingNotSupportedException(java.lang.String message,
                                            java.lang.String propertyName,
                                            java.lang.Class<?> suppliedClass,
                                            java.lang.Class<?> requiredClass)

Creates a new PropertySettingNotSupportedException.

Parameters:

message - The message string

propertyName - the name of the property being set or requested

suppliedClass - the class of the supplied value

requiredClass - the class which the supplied value should be compatible with

PropertySettingNotSupportedException

public PropertySettingNotSupportedException(java.lang.Throwable e,
                                            java.lang.String propertyName,
                                            java.lang.Class<?> suppliedClass,
                                            java.lang.Class<?> requiredClass)

Creates a new PropertySettingNotSupportedException.

Parameters:

e - A nested throwable should it have lead to this exception

propertyName - the name of the property being set or requested

suppliedClass - the class of the supplied value

requiredClass - the class which the supplied value should be compatible with

Method Detail

getSuppliedClass

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

Reports the Class of the value supplied when trying to set the property.

Returns:

provides the Class of the value supplied when trying to set the property

getRequiredClass

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

Reports the Class to which the supplied value must be assignment compatible.

Returns:

the Class to which the supplied value must be assignment compatible, or null if unknown

getPropertyName

public java.lang.String getPropertyName()

Reports the property name which was being set.

Returns:

the property name which was being set