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.api.project;
043:
044: import java.beans.PropertyChangeListener;
045: import javax.swing.Icon;
046: import org.netbeans.api.project.Project;
047:
048: /**
049: * General information about a project.
050: * <strong>Use {@link ProjectUtils#getInformation} as a client.</strong>
051: * Use {@link Project#getLookup} as a provider.
052: * @author Jesse Glick
053: */
054: public interface ProjectInformation {
055:
056: /** Property name fired when the code name changes. */
057: String PROP_NAME = "name"; // NOI18N
058:
059: /** Property name fired when the display name changes. */
060: String PROP_DISPLAY_NAME = "displayName"; // NOI18N
061:
062: /** Property name fired when the icon changes. */
063: String PROP_ICON = "icon"; // NOI18N
064:
065: /**
066: * Get a programmatic code name suitable for use in build scripts or other
067: * references.
068: * <p>
069: * Project names should typically be distinctive enough to distinguish
070: * between different projects with some kind of relationships, <em>but</em>
071: * any usage of this name must take into account that they are not forced
072: * to be unique.
073: * <p>
074: * Should not contain odd characters; should be usable as a directory name
075: * on disk, as (part of) an Ant property name, etc.
076: * XXX precise format - at least conforms to XML NMTOKEN or ID
077: * @return a code name
078: * @see <a href="@org-netbeans-modules-project-ant@/org/netbeans/spi/project/support/ant/PropertyUtils.html#getUsablePropertyName(java.lang.String)"><code>PropertyUtils.getUsablePropertyName</code></a>
079: */
080: String getName();
081:
082: /**
083: * Get a human-readable display name for the project.
084: * May contain spaces, international characters, etc.
085: * XXX precise format - probably XML PCDATA
086: * @return a display name for the project
087: */
088: String getDisplayName();
089:
090: /**
091: * Gets icon for given project.
092: * Usually determined by the project type.
093: * @return icon of the project.
094: */
095: Icon getIcon();
096:
097: /**
098: * Get the associated project.
099: * @return the project for which information is being provided
100: */
101: Project getProject();
102:
103: /**
104: * Add a listener to property changes.
105: * Only {@link #PROP_NAME}, {@link #PROP_DISPLAY_NAME}, and {@link #PROP_ICON} may be fired.
106: * Since the event source is the info object, you may use {@link #getProject}.
107: * @param listener a listener to add
108: */
109: void addPropertyChangeListener(PropertyChangeListener listener);
110:
111: /**
112: * Remove a listener to property changes.
113: * @param listener a listener to remove
114: */
115: void removePropertyChangeListener(PropertyChangeListener listener);
116:
117: }
|