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:
046: /**
047: * Description of the build target to be shown in Target Mappings customizer
048: * panel.
049: * @see ProjectNature#getExtraTargets
050: * @author David Konecny
051: */
052: public final class TargetDescriptor {
053:
054: private String actionName;
055: private List<String> defaultTargets;
056: private String actionLabel;
057: private String accessibleLabel;
058:
059: /**
060: * Constructor.
061: * @param actionName IDE action name (see {@link org.netbeans.spi.project.ActionProvider})
062: * @param defaultTargets list of regular expressions to match name of the
063: * Ant target to which this IDE action usually maps
064: * @param actionLabel localized label of this action. To be shown in UI customizer
065: * @param accessibleLabel accessible label. Used together with actionLabel
066: */
067: public TargetDescriptor(String actionName,
068: List<String> defaultTargets, String actionLabel,
069: String accessibleLabel) {
070: this .actionName = actionName;
071: this .defaultTargets = defaultTargets;
072: this .actionLabel = actionLabel;
073: this .accessibleLabel = accessibleLabel;
074: }
075:
076: /**
077: * Name of the IDE action which is mapped to an Ant script.
078: */
079: public String getIDEActionName() {
080: return actionName;
081: }
082:
083: /**
084: * List of regular expressions to match name of the target in Ant script
085: * which usually maps to the IDE action. List will be processed in the
086: * given order so it is recommended to list the most specific ones first.
087: * @return cannot be null; can be empty array
088: */
089: public List<String> getDefaultTargets() {
090: return defaultTargets;
091: }
092:
093: /**
094: * Label name under which this IDE action will be presented in the
095: * Target Mapping customizer panel.
096: */
097: public String getIDEActionLabel() {
098: return actionLabel;
099: }
100:
101: /**
102: * Accessibility of the getIDEActionLabel().
103: */
104: public String getAccessibleLabel() {
105: return accessibleLabel;
106: }
107:
108: }
|