001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.project.support.ant;
043:
044: import java.io.IOException;
045: import org.netbeans.api.project.Project;
046:
047: /**
048: * Plugin for an Ant project type.
049: * Register one instance to default lookup in order to define an Ant project type.
050: * @author Jesse Glick
051: */
052: public interface AntBasedProjectType {
053:
054: /**
055: * Get a unique type identifier for this kind of project.
056: * No two registered {@link AntBasedProjectType} instances may share the same type.
057: * The type is stored in <code>nbproject/project.xml</code> in the <code>type</code> element.
058: * It is forbidden for the result of this method to change from call to call.
059: * @return the project type
060: */
061: String getType();
062:
063: /**
064: * Create the project object with a support class.
065: * Normally the project should retain a reference to the helper object in
066: * order to implement various required methods.
067: * Do <em>not</em> do any caching here; the infrastructure will call this
068: * method only when the project needs to be loaded into memory.
069: * @param helper a helper object encapsulating the generic project structure
070: * @return a project implementation
071: * @throws IOException if there is some problem loading additional data
072: */
073: Project createProject(AntProjectHelper helper) throws IOException;
074:
075: /**
076: * Get the simple name of the XML element that should be used to store
077: * the project's specific configuration data in <code>nbproject/project.xml</code>
078: * (inside <code><configuration></code>) or <code>nbproject/private/private.xml</code>
079: * (inside <code><project-private></code>).
080: * It is forbidden for the result of this method to change from call to call.
081: * @param shared if true, refers to <code>project.xml</code>, else refers to
082: * <code>private.xml</code>
083: * @return a simple name; <samp>data</samp> is recommended but not required
084: */
085: String getPrimaryConfigurationDataElementName(boolean shared);
086:
087: /**
088: * Get the namespace of the XML element that should be used to store
089: * the project's specific configuration data in <code>nbproject/project.xml</code>
090: * (inside <code><configuration></code>) or <code>nbproject/private/private.xml</code>
091: * (inside <code><project-private></code>).
092: * It is forbidden for the result of this method to change from call to call.
093: * @param shared if true, refers to <code>project.xml</code>, else refers to
094: * <code>private.xml</code>
095: * @return an XML namespace, e.g. <samp>http://www.netbeans.org/ns/j2se-project</samp>
096: * or <samp>http://www.netbeans.org/ns/j2se-project-private</samp>
097: */
098: String getPrimaryConfigurationDataElementNamespace(boolean shared);
099:
100: }
|