/*
 *                 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-2004 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.project.support.ant;

import java.io.IOException;
import org.netbeans.api.project.Project;

/**
 * Plugin for an Ant project type.
 * Register one instance to default lookup in order to define an Ant project type.
 * @author Jesse Glick
 */
public interface AntBasedProjectType {
    
    /**
     * Get a unique type identifier for this kind of project.
     * No two registered {@link AntBasedProjectType} instances may share the same type.
     * The type is stored in nbproject/project.xml in the type element.
     * It is forbidden for the result of this method to change from call to call.
     * @return the project type
     */
    String getType();
    
    /**
     * Create the project object with a support class.
     * Normally the project should retain a reference to the helper object in
     * order to implement various required methods.
     * @param helper a helper object encapsulating the generic project structure
     * @return a project implementation
     * @throws IOException if there is some problem loading additional data
     */
    Project createProject(AntProjectHelper helper) throws IOException;
    
    /**
     * Get the simple name of the XML element that should be used to store
     * the project's specific configuration data in nbproject/project.xml
     * (inside <configuration>) or nbproject/private/private.xml
     * (inside <project-private>).
     * It is forbidden for the result of this method to change from call to call.
     * @param shared if true, refers to project.xml, else refers to
     *               private.xml
     * @return a simple name; data is recommended but not required
     */
    String getPrimaryConfigurationDataElementName(boolean shared);
    
    /**
     * Get the namespace of the XML element that should be used to store
     * the project's specific configuration data in nbproject/project.xml
     * (inside <configuration>) or nbproject/private/private.xml
     * (inside <project-private>).
     * It is forbidden for the result of this method to change from call to call.
     * @param shared if true, refers to project.xml, else refers to
     *               private.xml
     * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project
     *         or http://www.netbeans.org/ns/j2se-project-private
     */
    String getPrimaryConfigurationDataElementNamespace(boolean shared);

}