001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2004 World Wide Web Consortium,
032 *
033 * (Massachusetts Institute of Technology, European Research Consortium for
034 * Informatics and Mathematics, Keio University). All Rights Reserved. This
035 * work is distributed under the W3C(r) Software License [1] in the hope that
036 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
037 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
038 *
039 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
040 */
041
042 package org.w3c.dom;
043
044 /**
045 * <code>DOMError</code> is an interface that describes an error.
046 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
047 * @since DOM Level 3
048 */
049 public interface DOMError {
050 // ErrorSeverity
051 /**
052 * The severity of the error described by the <code>DOMError</code> is
053 * warning. A <code>SEVERITY_WARNING</code> will not cause the
054 * processing to stop, unless <code>DOMErrorHandler.handleError()</code>
055 * returns <code>false</code>.
056 */
057 public static final short SEVERITY_WARNING = 1;
058 /**
059 * The severity of the error described by the <code>DOMError</code> is
060 * error. A <code>SEVERITY_ERROR</code> may not cause the processing to
061 * stop if the error can be recovered, unless
062 * <code>DOMErrorHandler.handleError()</code> returns <code>false</code>.
063 */
064 public static final short SEVERITY_ERROR = 2;
065 /**
066 * The severity of the error described by the <code>DOMError</code> is
067 * fatal error. A <code>SEVERITY_FATAL_ERROR</code> will cause the
068 * normal processing to stop. The return value of
069 * <code>DOMErrorHandler.handleError()</code> is ignored unless the
070 * implementation chooses to continue, in which case the behavior
071 * becomes undefined.
072 */
073 public static final short SEVERITY_FATAL_ERROR = 3;
074
075 /**
076 * The severity of the error, either <code>SEVERITY_WARNING</code>,
077 * <code>SEVERITY_ERROR</code>, or <code>SEVERITY_FATAL_ERROR</code>.
078 */
079 public short getSeverity();
080
081 /**
082 * An implementation specific string describing the error that occurred.
083 */
084 public String getMessage();
085
086 /**
087 * A <code>DOMString</code> indicating which related data is expected in
088 * <code>relatedData</code>. Users should refer to the specification of
089 * the error in order to find its <code>DOMString</code> type and
090 * <code>relatedData</code> definitions if any.
091 * <p ><b>Note:</b> As an example,
092 * <code>Document.normalizeDocument()</code> does generate warnings when
093 * the "split-cdata-sections" parameter is in use. Therefore, the method
094 * generates a <code>SEVERITY_WARNING</code> with <code>type</code>
095 * <code>"cdata-sections-splitted"</code> and the first
096 * <code>CDATASection</code> node in document order resulting from the
097 * split is returned by the <code>relatedData</code> attribute.
098 */
099 public String getType();
100
101 /**
102 * The related platform dependent exception if any.
103 */
104 public Object getRelatedException();
105
106 /**
107 * The related <code>DOMError.type</code> dependent data if any.
108 */
109 public Object getRelatedData();
110
111 /**
112 * The location of the error.
113 */
114 public DOMLocator getLocation();
115
116 }
|