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.modules.apisupport.project.spi;
043:
044: import java.io.File;
045: import java.io.IOException;
046: import org.openide.filesystems.FileObject;
047: import org.openide.modules.SpecificationVersion;
048:
049: /**
050: * Interface to be implemented by NetBeans module projects.
051: *
052: * @see org.netbeans.api.project.Project#getLookup
053: * @author Martin Krauskopf, Milos Kleint
054: * @since org.netbeans.modules.apisupport.project 1.15
055: */
056: public interface NbModuleProvider {
057:
058: // These are just for convenience:
059: NbModuleType STANDALONE = NbModuleType.STANDALONE;
060: NbModuleType SUITE_COMPONENT = NbModuleType.SUITE_COMPONENT;
061: NbModuleType NETBEANS_ORG = NbModuleType.NETBEANS_ORG;
062:
063: /** Used for a type-safe enumeration of NetBeans module types. */
064: enum NbModuleType {
065: STANDALONE, SUITE_COMPONENT, NETBEANS_ORG
066: }
067:
068: /** Returns type of this NetBeans module.
069: * @return STANDALONE SUITE_COMPONENT or NETBEANS_ORG
070: */
071: NbModuleType getModuleType();
072:
073: /**
074: * Returns the specification version of the module
075: * @return specification version of the module
076: */
077: String getSpecVersion();
078:
079: /**
080: * Returns the codenamebase of the module
081: * @return module's codenamebase
082: */
083: String getCodeNameBase();
084:
085: /** Returns a relative path to a project's source directory.
086: * @return relative path to sources..
087: */
088: String getSourceDirectoryPath();
089:
090: /**
091: * relative path to the directory which contains/is to contain resources, META-INF/services folder or layer file for example
092: * @param inTests
093: * @return relative path from project root to resource root.
094: */
095: String getResourceDirectoryPath(boolean inTests);
096:
097: /**
098: * returns the relative path to the main project file (eg. nbproject/project.xml)
099: * @return relative path from project root to the main project file.
100: */
101: String getProjectFilePath();
102:
103: /**
104: * returns root directory with sources.
105: * @return sources root FileObject
106: */
107: FileObject getSourceDirectory();
108:
109: /**
110: * returns the location of the module's manifest
111: * @return manifest FileObject.
112: */
113: FileObject getManifestFile();
114:
115: /**
116: * add/updates the given dependency to the project
117: */
118: boolean addDependency(final String codeNameBase,
119: final String releaseVersion,
120: final SpecificationVersion version,
121: final boolean useInCompiler) throws IOException;
122:
123: /**
124: * checks the declared version of the given dependency
125: * @param codenamebase
126: * @return
127: */
128: SpecificationVersion getDependencyVersion(String codenamebase)
129: throws IOException;
130:
131: /**
132: * get the NetBeans platform for the module
133: * @return location of the root directory of NetBeans platform installation
134: */
135: File getActivePlatformLocation();
136:
137: }
|