Source Code Cross Referenced for AutomaticExtraClasspathProvider.java in  » IDE-Netbeans » library » org » apache » tools » ant » module » spi » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03:         *
04:         * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05:         *
06:         * The contents of this file are subject to the terms of either the GNU
07:         * General Public License Version 2 only ("GPL") or the Common
08:         * Development and Distribution License("CDDL") (collectively, the
09:         * "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.apache.tools.ant.module.spi;
43:
44:        import java.io.File;
45:
46:        /**
47:         * Permits a module to register special additional JARs (or directories)
48:         * to be added to Ant's primary classpath by default.
49:         * This should <em>only</em> be used to supply libraries needed by
50:         * standard "optional" tasks that ship with Ant - e.g. <code>junit.jar</code>
51:         * as needed by the <code>&lt;junit&gt;</code> task.
52:         * Register instances to default lookup.
53:         * <p>
54:         * Since version <code>org.apache.tools.ant.module/3 3.26</code> there is a
55:         * way to register a library declaratively. Just put fragment like this into
56:         * your layer file:
57:         * <pre>
58:         * &lt;filesystem&gt;
59:         *   &lt;folder name="Services"&gt;
60:         *     &lt;folder name="Hidden"&gt;
61:         *       &lt;file name="org-your-lib-ant-registration.instance"&gt;
62:         *         &lt;attr name="instanceCreate" methodvalue="org.apache.tools.ant.module.spi.AutomaticExtraClasspath.url"/&gt;
63:         *         &lt;attr name="url" urlvalue="nbinst://org.your.module.name/modules/ext/org-your-lib.jar"/&gt;
64:         *         &lt;attr name="instanceOf" stringvalue="org.apache.tools.ant.module.spi.AutomaticExtraClasspathProvider"/&gt;
65:         *       &lt;/file&gt;
66:         *     &lt;/folder&gt;
67:         *   &lt;/folder&gt;
68:         * &lt;/filesystem&gt;
69:         * </pre>
70:         *
71:         *
72:         * @since org.apache.tools.ant.module/3 3.8
73:         * @author Jesse Glick
74:         */
75:        public interface AutomaticExtraClasspathProvider {
76:
77:            /**
78:             * Return a (possibly empty) list of items to add to the
79:             * automatic classpath used by default when running Ant.
80:             * Note that the result is not permitted to change between calls
81:             * in the same VM session.
82:             * <p>
83:             * The user may be able to override this path, so there is no
84:             * firm guarantee that the items will be available when Ant is run.
85:             * However by default they will be.
86:             * @return zero or more directories or JARs to add to Ant's startup classpath
87:             * @see org.openide.modules.InstalledFileLocator
88:             */
89:            File[] getClasspathItems();
90:
91:        }