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.apache.tools.ant.module.bridge;
043:
044: import java.io.File;
045: import java.io.InputStream;
046: import java.util.List;
047: import java.util.Map;
048: import org.netbeans.api.progress.ProgressHandle;
049: import org.openide.windows.OutputWriter;
050:
051: /**
052: * What is implemented by bridge.jar.
053: * @author Jesse Glick
054: */
055: public interface BridgeInterface {
056:
057: /**
058: * Actually run a build script.
059: * @param buildFile an Ant build script
060: * @param targets a list of target names to run, or null to run the default target
061: * @param in an input stream for console input
062: * @param out an output stream with the ability to have hyperlinks
063: * @param err an error stream with the ability to have hyperlinks
064: * @param properties any Ant properties to define
065: * @param verbosity the intended logging level
066: * @param displayName a user-presentable name for the session
067: * @param interestingOutputCallback will be called if and when some interesting output appears, or input is requested
068: * @param handle a progress handle to update if appropriate (switch to sleeping and back to indeterminate)
069: * @return true if the build succeeded, false if it failed for any reason
070: */
071: boolean run(File buildFile, List<String> targets, InputStream in,
072: OutputWriter out, OutputWriter err,
073: Map<String, String> properties, int verbosity,
074: String displayName, Runnable interestingOutputCallback,
075: ProgressHandle handle);
076:
077: /**
078: * Try to stop a running build.
079: * The implementation may wait for a while to stop at a safe point,
080: * and/or stop forcibly.
081: * @param process the thread which is currently running the build (in which {@link #run} was invoked)
082: */
083: void stop(Thread process);
084:
085: /**
086: * Get some informational value of the Ant version.
087: * @return the version
088: */
089: String getAntVersion();
090:
091: /**
092: * Check whether Ant 1.6 is loaded.
093: * If so, additional abilities may be possible, such as namespace support.
094: */
095: boolean isAnt16();
096:
097: /**
098: * Get a proxy for IntrospectionHelper, to introspect task + type structure.
099: */
100: IntrospectionHelperProxy getIntrospectionHelper(Class<?> clazz);
101:
102: /**
103: * See Project.toBoolean.
104: */
105: boolean toBoolean(String val);
106:
107: /**
108: * Get values of an enumeration class.
109: * If it is not actually an enumeration class, return null.
110: */
111: String[] getEnumeratedValues(Class<?> c);
112:
113: }
|