← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to java/source/src/org/netbeans/modules/java/source/engine/SourceRewriter.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
java/source/src/org/netbeans/modules/java/source/engine/SourceRewriter.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "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.modules.java.source.engine;
 
43
 
 
44
import java.io.IOException;
 
45
import javax.swing.text.BadLocationException;
 
46
 
 
47
/**
 
48
 * Defines methods used by Jackpot's source rewriting service.  These methods
 
49
 * treat the source file as a stream , but an interface is used rather than a
 
50
 * java.io.Writer subclass so that non-stream implementations are possible.
 
51
 * For example, if a source file is already represented by a javax.swing.Document,
 
52
 * it may be more efficient to map these methods to that interface.
 
53
 */
 
54
public interface SourceRewriter {
 
55
 
 
56
    /**
 
57
     * Writes the specified string to the source file at the current position.
 
58
     *
 
59
     * @param s the string to write to the source file.
 
60
     */
 
61
    void writeTo(String s) throws IOException, BadLocationException;
 
62
    
 
63
    /**
 
64
     * Skips the text from the current SourceReader position to the specified
 
65
     * offset.  Equivalent to java.io.Reader.skip().
 
66
     *
 
67
     * @param in the SourceReader to copy text from.
 
68
     * @param offset the ending offset of the text range to copy.
 
69
     * @throws IOException if the SourceReader's current position is greater
 
70
     *                     than the offset, or if the offset is outside the 
 
71
     *                     range of the SourceReader's character array.
 
72
     */
 
73
    void skipThrough(SourceReader in, int offset) throws IOException, BadLocationException;
 
74
 
 
75
    /**
 
76
     * Copies the contents of a SourceReader from its current position to the
 
77
     * specified source file offset.
 
78
     *
 
79
     * @param in the SourceReader to copy text from.
 
80
     * @param offset the ending offset of the text range to copy.
 
81
     * @throws IOException if the SourceReader's current position is greater
 
82
     *                     than the offset, or if the offset is outside the 
 
83
     *                     range of the SourceReader's character array.
 
84
     */
 
85
    void copyTo(SourceReader in, int offset) throws IOException;
 
86
 
 
87
    /**
 
88
     * Copies the remaining text from a SourceReader to the SourceWriter.
 
89
     *
 
90
     * @param in the SourceReader to copy text from.
 
91
     */
 
92
    void copyRest(SourceReader in) throws IOException;
 
93
 
 
94
    /**
 
95
     * Flush and close the SourceRewriter.
 
96
     * 
 
97
     * @param save flush the SourceRewriter before closing.
 
98
     */
 
99
    void close(boolean save) throws IOException;
 
100
}