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.ant.freeform.spi;
043:
044: import java.util.List;
045: import java.util.Set;
046: import org.netbeans.api.project.Project;
047: import org.netbeans.spi.project.AuxiliaryConfiguration;
048: import org.netbeans.spi.project.support.ant.AntProjectHelper;
049: import org.netbeans.spi.project.support.ant.PropertyEvaluator;
050: import org.openide.filesystems.FileObject;
051: import org.openide.nodes.Node;
052: import org.openide.util.Lookup;
053:
054: /**
055: * Description of base freeform project extension. Instances should be
056: * registered into default lookup. Freeform project will always call all
057: * registered implementations of this interface and it is up to the
058: * implementation to decide (based on the project's metadata) whether they
059: * want or should enhance the project or not.
060: *
061: * @author David Konecny, Jesse Glick
062: */
063: public interface ProjectNature {
064:
065: /**
066: * Check project and provide additional build targets to be shown in
067: * target mapping customizer panel if it is project of your type. Order
068: * of targets is important.
069: * @return a list of {@link TargetDescriptor}s (can be empty but not null)
070: */
071: List<TargetDescriptor> getExtraTargets(Project project,
072: AntProjectHelper projectHelper,
073: PropertyEvaluator projectEvaluator,
074: AuxiliaryConfiguration aux);
075:
076: /**
077: * Returns set of XML schemas describing syntax of <code>project.xml</code> defined by this project extension.
078: * @return set of <code>String</code>s whose value is URL of XML schema file
079: */
080: Set<String> getSchemas();
081:
082: /**
083: * Get a set of view styles supported by the nature for displaying source folders in the logical view.
084: * @return a set of <code>String</code> style names (may be empty but not null)
085: */
086: Set<String> getSourceFolderViewStyles();
087:
088: /**
089: * Produce a logical view of a source folder in a style supported by the nature.
090: * @param project a project displaying the view
091: * @param folder a file folder (typically part of the project but not necessarily) to produce a view of
092: * @param includes an Ant-style includes list, or null
093: * @param excludes an Ant-style excludes list, or null
094: * @param style a view style; will be one of {@link #getSourceFolderViewStyles}
095: * @param name a suggested code name for the new node
096: * @param displayName a suggested display name for the new node (may be null, in which case provider is free to pick an appropriate display name)
097: * @return a logical view of that folder
098: * @throws IllegalArgumentException if the supplied style is not one of {@link #getSourceFolderViewStyles}
099: * @see org.netbeans.spi.project.support.ant.PathMatcher
100: * @since org.netbeans.modules.ant.freeform/1 1.15
101: */
102: Node createSourceFolderView(Project project, FileObject folder,
103: String includes, String excludes, String style,
104: String name, String displayName)
105: throws IllegalArgumentException;
106:
107: /**
108: * Try to find a node selection in a source folder logical view.
109: * @param project a project displaying the view
110: * @param root a source folder view node which may have been returned by {@link #createSourceFolderView} (or not)
111: * @param target a lookup entry indicating the node to find (e.g. a {@link FileObject})
112: * @return a subnode of the root node representing the target, or null if either the target could not be found, or the root node was not recognized
113: * @see org.netbeans.spi.project.ui.LogicalViewProvider#findPath
114: */
115: Node findSourceFolderViewPath(Project project, Node root,
116: Object target);
117:
118: }
|