KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > xml > cookies > CheckXMLCookie


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.xml.cookies;
21
22 import org.openide.nodes.Node;
23
24 /**
25  * Fast (and preferably standalone mode) XML parsed entity syntax checker.
26  * <p>Implemenmtation should follow XML specification for non-validating
27  * processors. Implementation is allowed to support any XML parsed entities.
28  * It must not change UI state.
29  * <p>
30  * It should be gracefully served by all data objects and explorer nodes
31  * representing non-validateable XML resources.
32  *
33  * @author Petr Kuzel
34  * @see ValidateXMLCookie
35  * @see <a HREF="http://www.w3.org/TR/REC-xml#proc-types">XML 1.0</a>
36  */
37 public interface CheckXMLCookie extends Node.Cookie {
38     
39     /**
40      * Check XML parsed entity for syntax wellformedness.
41      * @param observer optional listener (<code>null</code> allowed)
42      * giving judgement details via {@link XMLProcessorDetail}s.
43      * @return <code>true</code> if syntax check passes
44      */
45     boolean checkXML(CookieObserver observer);
46     
47 }
48
Popular Tags