DOMError

  • DOMError is an interface that provides information about errors that occur during DOM operations, including severity level, location, and description.

  • It defines three severity levels: SEVERITY_WARNING, SEVERITY_ERROR, and SEVERITY_FATAL_ERROR, indicating the impact of the error on processing.

  • Several methods allow access to the error's location, message, related data, and related exception, if available.

  • The type property and relatedData can provide specific details about the error, dependent on the context in which it occurred.
public interface DOMError

DOMError is an interface that describes an error.

See also the Document Object Model (DOM) Level 3 Core Specification.

Constant Summary

short SEVERITY_ERROR The severity of the error described by the DOMError is error.
short SEVERITY_FATAL_ERROR The severity of the error described by the DOMError is fatal error.
short SEVERITY_WARNING The severity of the error described by the DOMError is warning.

Public Method Summary

abstract DOMLocator
getLocation()
The location of the error.
abstract String
getMessage()
An implementation specific string describing the error that occurred.
abstract Object
getRelatedData()
The related DOMError.type dependent data if any.
abstract Object
getRelatedException()
The related platform dependent exception if any.
abstract short
getSeverity()
The severity of the error, either SEVERITY_WARNING, SEVERITY_ERROR, or SEVERITY_FATAL_ERROR.
abstract String
getType()
A DOMString indicating which related data is expected in relatedData.

Constants

public static final short SEVERITY_ERROR

The severity of the error described by the DOMError is error. A SEVERITY_ERROR may not cause the processing to stop if the error can be recovered, unless DOMErrorHandler.handleError() returns false.

Constant Value: 2

public static final short SEVERITY_FATAL_ERROR

The severity of the error described by the DOMError is fatal error. A SEVERITY_FATAL_ERROR will cause the normal processing to stop. The return value of DOMErrorHandler.handleError() is ignored unless the implementation chooses to continue, in which case the behavior becomes undefined.

Constant Value: 3

public static final short SEVERITY_WARNING

The severity of the error described by the DOMError is warning. A SEVERITY_WARNING will not cause the processing to stop, unless DOMErrorHandler.handleError() returns false.

Constant Value: 1

Public Methods

public abstract DOMLocator getLocation ()

The location of the error.

public abstract String getMessage ()

An implementation specific string describing the error that occurred.

public abstract Object getRelatedData ()

The related DOMError.type dependent data if any.

public abstract Object getRelatedException ()

The related platform dependent exception if any.

public abstract short getSeverity ()

The severity of the error, either SEVERITY_WARNING, SEVERITY_ERROR, or SEVERITY_FATAL_ERROR.

public abstract String getType ()

A DOMString indicating which related data is expected in relatedData. Users should refer to the specification of the error in order to find its DOMString type and relatedData definitions if any.

Note: As an example, Document.normalizeDocument() does generate warnings when the "split-cdata-sections" parameter is in use. Therefore, the method generates a SEVERITY_WARNING with type "cdata-sections-splitted" and the first CDATASection node in document order resulting from the split is returned by the relatedData attribute.