Most visited

Recently visited

Added in API level 8

DOMError

public interface DOMError

org.w3c.dom.DOMError


DOMError is an interface that describes an error.

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

Summary

Constants

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 methods

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

SEVERITY_ERROR

Added in API level 8
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 (0x00000002)

SEVERITY_FATAL_ERROR

Added in API level 8
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 (0x00000003)

SEVERITY_WARNING

Added in API level 8
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 (0x00000001)

Public methods

getLocation

Added in API level 8
DOMLocator getLocation ()

The location of the error.

Returns
DOMLocator

getMessage

Added in API level 8
String getMessage ()

An implementation specific string describing the error that occurred.

Returns
String

getRelatedData

Added in API level 8
Object getRelatedData ()

The related DOMError.type dependent data if any.

Returns
Object

getRelatedException

Added in API level 8
Object getRelatedException ()

The related platform dependent exception if any.

Returns
Object

getSeverity

Added in API level 8
short getSeverity ()

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

Returns
short

getType

Added in API level 8
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.

Returns
String

Hooray!