ProjectClassPathExtender (NetBeans Java Project API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.java.project.classpath
Interface ProjectClassPathExtender

public interface ProjectClassPathExtender

Interface for project's compile classpath extension Project can provide this interface in its lookup to allow clients to extend its compilation classpath by new classpath element (jar, folder, dependent project, library).

Since:: org.netbeans.modules.java.project/1 1.3

Method Summary

boolean addAntArtifact(AntArtifact artifact, URI artifactElement)
          Adds AntArtifact into project's compile classpath if the artifact is not already on it.

boolean addArchiveFile(FileObject archiveFile)
          Adds archive file into project's compile classpath if the file is not already on it.

boolean addLibrary(Library library)
          Adds Library into project's compile classpath if the library is not already included.

Method Detail

addLibrary

public boolean addLibrary(Library library)
                   throws IOException

Adds Library into project's compile classpath if the library is not already included.

Parameters:: library - to be added, not null.
Returns:: true in case the classpath was changed
Throws:: IOException - in case the project metadata can not be stored.

addArchiveFile

public boolean addArchiveFile(FileObject archiveFile)
                       throws IOException

Adds archive file into project's compile classpath if the file is not already on it.

Parameters:: archiveFile - to be added, can't be null.
Returns:: true in case the classpath was changed
Throws:: IOException - in case the project metadata can not be stored.

addAntArtifact

public boolean addAntArtifact(AntArtifact artifact,
                              URI artifactElement)
                       throws IOException

Adds AntArtifact into project's compile classpath if the artifact is not already on it.

Parameters:: artifact - to be added, can't be null.; artifactElement - the URI of the build output, the artifactElement has to be owned by the artifact and must be relative to it.
Returns:: true in case the classpath was changed
Throws:: IOException - in case the project metadata can not be stored.