KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > java > source > parsing > DocumentProvider


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.modules.java.source.parsing;
21
22 import javax.swing.text.StyledDocument JavaDoc;
23
24 /**XXX: maybe not needed anymore
25  *
26  * @author Tomas Zezula
27  */
28 public interface DocumentProvider {
29
30     /**
31      * Returns the document which was used to get source
32      * code.
33      * @return {@link StyledDocument} or null
34      */
35     StyledDocument JavaDoc getDocument ();
36
37     /**
38      * Performs an atomic action on the document.
39      * May be called only if {@link DocumentProvider#getDocument}
40      * returns non null
41      * @param {@link Runnable} the atomic action
42      * @throws {@link IllegalStateException} is thrown if the {@link JavaFileObject} has no {@link Document}
43      */
44     void runAtomic (Runnable JavaDoc r);
45 }
46
Popular Tags