001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.java.source.engine;
043:
044: import java.io.IOException;
045: import javax.swing.text.BadLocationException;
046:
047: /**
048: * Defines methods used by Jackpot's source rewriting service. These methods
049: * treat the source file as a stream , but an interface is used rather than a
050: * java.io.Writer subclass so that non-stream implementations are possible.
051: * For example, if a source file is already represented by a javax.swing.Document,
052: * it may be more efficient to map these methods to that interface.
053: */
054: public interface SourceRewriter {
055:
056: /**
057: * Writes the specified string to the source file at the current position.
058: *
059: * @param s the string to write to the source file.
060: */
061: void writeTo(String s) throws IOException, BadLocationException;
062:
063: /**
064: * Skips the text from the current SourceReader position to the specified
065: * offset. Equivalent to java.io.Reader.skip().
066: *
067: * @param in the SourceReader to copy text from.
068: * @param offset the ending offset of the text range to copy.
069: * @throws IOException if the SourceReader's current position is greater
070: * than the offset, or if the offset is outside the
071: * range of the SourceReader's character array.
072: */
073: void skipThrough(SourceReader in, int offset) throws IOException,
074: BadLocationException;
075:
076: /**
077: * Copies the contents of a SourceReader from its current position to the
078: * specified source file offset.
079: *
080: * @param in the SourceReader to copy text from.
081: * @param offset the ending offset of the text range to copy.
082: * @throws IOException if the SourceReader's current position is greater
083: * than the offset, or if the offset is outside the
084: * range of the SourceReader's character array.
085: */
086: void copyTo(SourceReader in, int offset) throws IOException;
087:
088: /**
089: * Copies the remaining text from a SourceReader to the SourceWriter.
090: *
091: * @param in the SourceReader to copy text from.
092: */
093: void copyRest(SourceReader in) throws IOException;
094:
095: /**
096: * Flush and close the SourceRewriter.
097: *
098: * @param save flush the SourceRewriter before closing.
099: */
100: void close(boolean save) throws IOException;
101: }
|