APIdia Launch Partner
Top Description Fields Methods
org.w3c.dom

public Interface DOMError

Known Direct Implementers
com.sun.org.apache.xerces.internal.dom.DOMErrorImpl, com.sun.org.apache.xml.internal.serializer.dom3.DOMErrorImpl
DOMError is an interface that describes an error.

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

Since
1.5, DOM Level 3

Field Summary

Modifier and TypeField and Description
public static final short
SEVERITY_ERROR

The severity of the error described by the DOMError is error.

public static final short
SEVERITY_FATAL_ERROR

The severity of the error described by the DOMError is fatal error.

public static final short
SEVERITY_WARNING

The severity of the error described by the DOMError is warning.

Method Summary

Modifier and TypeMethod and Description
public DOMLocator
getLocation()

The location of the error.

public String
getMessage()

An implementation specific string describing the error that occurred.

public Object
getRelatedData()

The related DOMError.type dependent data if any.

public Object
getRelatedException()

The related platform dependent exception if any.

public short
getSeverity()

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

public String
getType()

A DOMString indicating which related data is expected in relatedData.

Field Detail

SEVERITY_ERRORback to summary
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.

SEVERITY_FATAL_ERRORback to summary
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.

SEVERITY_WARNINGback to summary
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.

Method Detail

getLocationback to summary
public DOMLocator getLocation()

The location of the error.

getMessageback to summary
public String getMessage()

An implementation specific string describing the error that occurred.

getRelatedDataback to summary
public Object getRelatedData()

The related DOMError.type dependent data if any.

getRelatedExceptionback to summary
public Object getRelatedException()

The related platform dependent exception if any.

getSeverityback to summary
public short getSeverity()

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

getTypeback to summary
public 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.