01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.api.xml.cookies;
43:
44: import org.openide.nodes.Node;
45:
46: /**
47: * Validate XML document entity (in polyform manner).
48: * <p>Implemenmtation must follow XML 1.0 specification for processors
49: * conformance. It is allowed to extend the contract to support domain
50: * specifics semantics checks (i.e. XML Schema). It must not change UI state.
51: * <p>
52: * It should be gracefully served by all data objects and explorer nodes
53: * representing validateable XML resources.
54: * <p>
55: * <h3>Use Cases</h3>
56: * <ul>
57: * <li><b>Provider</b> needs to define domain specifics semantics checks such as
58: * XML Schema based validation, Ant script dependency cycles checking, etc.
59: * <li><b>Client</b> needs to check XML document entities transparently without
60: * appriory knowledge how to perform it for specifics XML document type.
61: * </ul>
62: *
63: * @author Petr Kuzel
64: * @see CheckXMLCookie
65: * @see <a href="http://www.w3.org/TR/REC-xml#proc-types">XML 1.0</a>
66: */
67: public interface ValidateXMLCookie extends Node.Cookie {
68:
69: /**
70: * Validate XML document entity.
71: * @param observer Optional listener (<code>null</code> allowed)
72: * giving judgement details via {@link XMLProcessorDetail}s.
73: * @return true if validity check passes.
74: */
75: boolean validateXML(CookieObserver observer);
76:
77: }
|