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: package org.netbeans.modules.gsf.api;
042:
043: import java.io.IOException;
044: import java.util.Collection;
045: import java.util.List;
046: import javax.swing.text.Document;
047: import org.openide.cookies.EditorCookie;
048: import org.openide.filesystems.FileObject;
049: import org.openide.loaders.DataObject;
050:
051: /**
052: * Assorted information about the Source.
053: *
054: * @todo Pass around a context object here that is managed by the client.
055: * This would let all the multiple clients of a particular compilation result
056: * share some work, such as computing the position stack for a caret offset,
057: * and so on. (Each client checks if it's initialized, and if not, perform
058: * work and store it in the context.)
059: *
060: * @author Petr Hrebejk, Tomas Zezula, Tor Norbye
061: */
062: public abstract class CompilationInfo {
063: private FileObject fo;
064:
065: public CompilationInfo(final FileObject fo) throws IOException {
066: this .fo = fo;
067: }
068:
069: /**
070: * Get all embedded results for a given mime type for this compilation info
071: */
072: public abstract Collection<? extends ParserResult> getEmbeddedResults(
073: String mimeType);
074:
075: /**
076: * Get the embedded result of the given mime type that applies to the given offset
077: */
078: public abstract ParserResult getEmbeddedResult(String mimeType,
079: int offset);
080:
081: /**
082: * Returns the content of the file.
083: *
084: * @return String the java source
085: */
086: public abstract String getText();
087:
088: /**
089: * Returns the index associated with this file
090: */
091: public abstract Index getIndex(String mimeType);
092:
093: public FileObject getFileObject() {
094: return fo;
095: }
096:
097: public Document getDocument() throws IOException {
098: if (this .fo == null) {
099: return null;
100: }
101:
102: DataObject od = DataObject.find(fo);
103: EditorCookie ec = od.getCookie(EditorCookie.class);
104:
105: if (ec != null) {
106: return ec.getDocument();
107: } else {
108: return null;
109: }
110: }
111:
112: public abstract List<Error> getErrors();
113: }
|