com.deltaxml.api

Class DeltaXMLProcessingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.api.DeltaXMLProcessingException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CannotCompareDeltaException, DifferentRootElementException, DifferingOrderedAttributesException, InvalidClarkNameException, InvalidDeltaXmlMarkupForTable, InvalidOriginalPositionException, InvalidSoftKeyAttributeException, LicenseException, UnorderedDuplicateKeysException

public class DeltaXMLProcessingException
extends DeltaXMLException

This class specifies an exceptional condition that occurred during the comparison and recombination processes.

For release 5.0 and onwards this class has been subtyped into explicit subtypes for each error while maintaining the previous error code mechanism used in earlier releases. The following table documents this mapping:

Error code	Exception class
4	DifferentRootElementException
6	LicenseExpiredException
8	NoLicenseInstalledException
9	LicenseContentException
11	CPUCountException
12	LicenseSecurityException
13	LicenseNotYetValidException
14	InvalidLicenseException
16	LicenseConcurrencyLimitException
46	UnorderedDuplicateKeysException
49	CannotCompareDeltaException
358	InvalidOriginalPositionException
401	DifferingOrderedAttributesException

See Also:

DeltaXMLProcessingException.getErrorCode(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeltaXMLProcessingException(java.lang.String message) Creates a new exception with an identifying message.
DeltaXMLProcessingException(java.lang.String message, int errorCode) Creates a new exception with an identifying message and error code.
DeltaXMLProcessingException(java.lang.String message, int errorCode, FailureSeverity severity) Creates a new exception providing an additional message, errorCode and severity.
DeltaXMLProcessingException(java.lang.String message, java.lang.Throwable e) Creates a new exception which wraps an existing exception and provides an additional message.
DeltaXMLProcessingException(java.lang.String message, java.lang.Throwable e, int errorCode) Creates a new exception which wraps an existing exception and also provides an additional message and errorCode.
DeltaXMLProcessingException(java.lang.String message, java.lang.Throwable e, int errorCode, FailureSeverity severity) Creates a new exception which wraps an existing exception and also provides an additional message, errorCode and severity.
DeltaXMLProcessingException(java.lang.Throwable e) Creates a new exception which wraps an existing exception.
DeltaXMLProcessingException(java.lang.Throwable e, int errorCode) Creates a new exception which wraps an existing exception and provides an errorCode.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Errors detected by the Comparator and Combiner operations were each given an identifying number in releases prior to 5.0 of the XML Compare API.
FailureSeverity	getSeverity() Reports the severity of the exception.

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

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message)

Creates a new exception with an identifying message.

Parameters:

message - The error or warning message.

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message,
                                   int errorCode)

Creates a new exception with an identifying message and error code.

Parameters:

message - The error or warning message.

errorCode - The code which identifies the error type and origin.

See Also:

DeltaXMLProcessingException.getErrorCode()

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.Throwable e)

Creates a new exception which wraps an existing exception.

Parameters:

e - The Exception or Error to wrap.

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.Throwable e,
                                   int errorCode)

Creates a new exception which wraps an existing exception and provides an errorCode.

Parameters:

e - The Exception or Error to wrap.

errorCode - The code which identifies the error type and origin.

See Also:

DeltaXMLProcessingException.getErrorCode()

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message,
                                   java.lang.Throwable e)

Creates a new exception which wraps an existing exception and provides an additional message.

Parameters:

e - The Exception or Error to wrap.

message - The error or warning message.

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message,
                                   java.lang.Throwable e,
                                   int errorCode)

Creates a new exception which wraps an existing exception and also provides an additional message and errorCode.

Parameters:

e - The Exception or Error to wrap.

errorCode - The code which identifies the error type and origin.

message - The error or warning message.

See Also:

DeltaXMLProcessingException.getErrorCode()

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message,
                                   java.lang.Throwable e,
                                   int errorCode,
                                   FailureSeverity severity)

Creates a new exception which wraps an existing exception and also provides an additional message, errorCode and severity.

Parameters:

e - The Exception or Error to wrap.

errorCode - The code which identifies the error type and origin.

message - The error or warning message.

severity - The severity of the message usually reported through the Listener

Since:

5.0

See Also:

DeltaXMLProcessingException.getErrorCode()

DeltaXMLProcessingException

public DeltaXMLProcessingException(java.lang.String message,
                                   int errorCode,
                                   FailureSeverity severity)

Creates a new exception providing an additional message, errorCode and severity.

Parameters:

errorCode - The code which identifies the error type and origin.

message - The error or warning message.

severity - The severity of the message usually reported through the Listener

Since:

5.0

See Also:

DeltaXMLProcessingException.getErrorCode()

Method Detail

getErrorCode

public int getErrorCode()

Errors detected by the Comparator and Combiner operations were each given an identifying number in releases prior to 5.0 of the XML Compare API. In release 5.0 this mechanism has been improved using explicit subtypes of this class. The errors codes and this method have been maintained for backwards compatibility.

This number uniquely identifies both the type of error and the location in the code where it originates.

The error code may be useful for analyzing or interpreting errors and reporting bugs.

They can be roughly categorized by:

0 - 9

Misc errors (fatalError)

10 - 49

Verification errors when checking the base file against a DXMLConstants (fatalError)

50 - 99

Verification errors when checking DeltaXML elements (fatalError)

50 - 99

Verification errors when checking DeltaXML elements (fatalError)

100 - 199

Errors in the XML-Markup combination algorithm (error)

200 - 299

Errors in the DTD-based combination algorithm (error)

300 - 399

Errors in the Unordered combination algorithm (error)

400 - 499

Some confusion?????(warning)

Returns:

The error code which identifies the type and source of the exception. If zero then the exception may not have an associated error code.

See Also:

A description of the errors and warnings on the DeltaXML web site

getSeverity

public FailureSeverity getSeverity()

Reports the severity of the exception. The reported severity will correspond to the reporting method used in the error listener.

Returns:

the severity of the failure

Since:

5.0

See Also:

FailureSeverity