KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > java > project > classpath > ProjectClassPathExtender


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.spi.java.project.classpath;
21
22 import java.io.IOException JavaDoc;
23 import java.net.URI JavaDoc;
24 import org.netbeans.api.project.ant.AntArtifact;
25 import org.netbeans.api.project.libraries.Library;
26 import org.openide.filesystems.FileObject;
27
28 /**
29  * Interface for project's compile classpath extension.
30  * A project can provide this interface in its {@link org.netbeans.api.project.Project#getLookup lookup} to
31  * allow clients to extend its compilation classpath
32  * by a new classpath element (JAR, folder, dependent project, or library).
33  * @since org.netbeans.modules.java.project/1 1.3
34  * @deprecated Please use the {@link ProjectClassPathModifier} instead.
35  */

36 @Deprecated JavaDoc
37 public interface ProjectClassPathExtender {
38
39     /**
40      * Adds a library into the project's compile classpath if the
41      * library is not already included.
42      * @param library to be added
43      * @return true in case the classpath was changed
44      * @exception IOException in case the project metadata cannot be changed
45      * @deprecated Please use {@link ProjectClassPathModifier#addLibrary} instead.
46      */

47     @Deprecated JavaDoc
48     boolean addLibrary(Library library) throws IOException JavaDoc;
49
50     /**
51      * Adds an archive file or folder into the project's compile classpath if the
52      * entry is not already there.
53      * @param archiveFile ZIP/JAR file to be added
54      * @return true in case the classpath was changed
55      * @exception IOException in case the project metadata cannot be changed
56      * @deprecated Please use {@link ProjectClassPathModifier#addArchive} instead.
57      */

58     @Deprecated JavaDoc
59     boolean addArchiveFile(FileObject archiveFile) throws IOException JavaDoc;
60
61     /**
62      * Adds an artifact (e.g. subproject) into project's compile classpath if the
63      * artifact is not already on it.
64      * @param artifact to be added
65      * @param artifactElement the URI of the build output
66      * (must be owned by the artifact and be relative to it)
67      * @return true in case the classpath was changed
68      * @exception IOException in case the project metadata cannot be changed
69      * @deprecated Please use {@link ProjectClassPathModifier#addAntArtifact} instead.
70      */

71     @Deprecated JavaDoc
72     boolean addAntArtifact(AntArtifact artifact, URI JavaDoc artifactElement) throws IOException JavaDoc;
73
74 }
75
Popular Tags