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 General
007: * Public License Version 2 only ("GPL") or the Common Development and Distribution
008: * License("CDDL") (collectively, the "License"). You may not use this file except in
009: * compliance with the License. You can obtain a copy of the License at
010: * http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP. See the
011: * License for the specific language governing permissions and limitations under the
012: * License. When distributing the software, include this License Header Notice in
013: * each file and include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun
014: * designates this particular file as subject to the "Classpath" exception as
015: * provided by Sun in the GPL Version 2 section of the License file that
016: * accompanied this code. If applicable, add the following below the License Header,
017: * with the fields enclosed by brackets [] replaced by your own identifying
018: * information: "Portions Copyrighted [year] [name of copyright owner]"
019: *
020: * Contributor(s):
021: *
022: * The Original Software is NetBeans. The Initial Developer of the Original Software
023: * is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun Microsystems, Inc. All
024: * Rights Reserved.
025: *
026: * If you wish your version of this file to be governed by only the CDDL or only the
027: * GPL Version 2, indicate your decision by adding "[Contributor] elects to include
028: * this software in this distribution under the [CDDL or GPL Version 2] license." If
029: * you do not indicate a single choice of license, a recipient has the option to
030: * distribute your version of this file under either the CDDL, the GPL Version 2 or
031: * to extend the choice of license to its licensees as provided above. However, if
032: * you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then
033: * the option applies only if the new code is made subject to such option by the
034: * copyright holder.
035: */
036:
037: package org.netbeans.installer.infra.build.ant;
038:
039: import java.util.LinkedList;
040: import java.util.List;
041: import org.apache.tools.ant.BuildException;
042: import org.apache.tools.ant.Task;
043: import org.apache.tools.ant.TaskContainer;
044:
045: /**
046: * This class is an ant task, which adds conditional execution capabilities. It
047: * examines the value of the given property and executed the nested tasks only if
048: * the the property's value equals to the given string.
049: *
050: * @author Kirill Sorokin
051: */
052: public class If extends Task implements TaskContainer {
053: /////////////////////////////////////////////////////////////////////////////////
054: // Instance
055: /**
056: * Name of the property whose value should be checked.
057: */
058: private String property;
059:
060: /**
061: * String which should be equal to the property's value in order for the nested
062: * tasks to execute.
063: */
064: private String value;
065:
066: /**
067: * List of child tasks which should be executed if the condition is satisfied.
068: */
069: private List<Task> children;
070:
071: // constructor //////////////////////////////////////////////////////////////////
072: /**
073: * Constructs a new instance of the {@link If} task. It simply sets the
074: * default values for the attributes.
075: */
076: public If() {
077: children = new LinkedList<Task>();
078: }
079:
080: // setters //////////////////////////////////////////////////////////////////////
081: /**
082: * Setter for the 'property' property.
083: *
084: * @param property The new value for the 'property' property.
085: */
086: public void setProperty(final String property) {
087: this .property = property;
088: }
089:
090: /**
091: * Setter for the 'value' property.
092: *
093: * @param value The new value for the 'value' property.
094: */
095: public void setValue(final String value) {
096: this .value = value;
097: }
098:
099: /**
100: * Registers a child task. The supplied <code>Task</code> object will be added
101: * to the list of child tasks and executed if the condition is satisfied.
102: *
103: * @param task The <code>Task</code> object to register.
104: */
105: public void addTask(final Task task) {
106: children.add(task);
107: }
108:
109: // execution ////////////////////////////////////////////////////////////////////
110: /**
111: * Executes the task. If the required value is set, then the property's value is
112: * compared to it and the child tasks are executes if they are equal. If the
113: * required value is not set, then the child tasks are executed if the property
114: * was set, without regard to its value.
115: *
116: * @throws org.apache.tools.ant.BuildException if a child task fails to execute.
117: */
118: public void execute() throws BuildException {
119: if (getProject().getProperty(property) != null) {
120: if (value != null) {
121: if (getProject().getProperty(property).equals(value)) {
122: executeChildren();
123: }
124: } else {
125: executeChildren();
126: }
127: }
128: }
129:
130: // private //////////////////////////////////////////////////////////////////////
131: /**
132: * Executes the child tasks.
133: */
134: private void executeChildren() throws BuildException {
135: for (Task task : this.children) {
136: task.perform();
137: }
138: }
139: }
|