/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.java.project;

import java.io.IOException;
import org.openide.filesystems.FileObject;
import org.netbeans.api.project.libraries.Library;
import org.netbeans.api.project.ant.AntArtifact;





/**
 * Interface for project's compile classpath extension
 */
public interface ProjectClassPathExtender {

    /**
     * Adds Library into project's compile classpath if the
     * library is not already included.
     * @param library to be added, not null
     * @return true in the case when the classpath was changed
     * @exception IOException
     */
    public boolean addLibrary (Library library) throws IOException;

    /**
     * Adds archive file into project's compile classpath if the
     * file is not already on it.
     * @param archiveFile to be added, not null
     * @return true in the case when the classpath was changed
     * @exception IOException
     */
    public boolean addArchiveFile (FileObject archiveFile) throws IOException;


    /**
     * Adds AntArtifact into project's compile classpath if the
     * artifact is not already on it.
     * @param artifact the ant artifact to be added, not null
     * @return true in the case when the classpath was changed
     * @exception IOException
     */
    public boolean addAntArtifact (AntArtifact artifact) throws IOException;

}