Initial import.

[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / global / VariableTask.java

/** @file\r
 * This file is ANT task VariableTask. \r
 *\r
 * VariableTask task implements part of ANT property task. The difference is\r
 * this task will override variable with same name, but ANT property task do not.\r
 *\r
 * Copyright (c) 2006, Intel Corporation\r
 * All rights reserved. This program and the accompanying materials\r
 * are licensed and made available under the terms and conditions of the BSD License\r
 * which accompanies this distribution.  The full text of the license may be found at\r
 * http://opensource.org/licenses/bsd-license.php\r
 *\r
 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 */\r
package org.tianocore.build.global;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Task;\r
\r
/**\r
 * VariableTask task implements part of ANT property task. The difference is\r
 * this task will override variable with same name, but ANT property task do not.\r
 * \r
 * @since GenBuild 1.0\r
 */\r
public class VariableTask extends Task {\r
\r
   /**\r
    * property value\r
    */\r
   private String value;\r
   \r
   /**\r
    * property name\r
    */\r
   private String name;\r
\r
   /**\r
    * Set property name.\r
    *\r
    * @param name property name\r
    */\r
   public void setName( String name ) {\r
      this.name = name;\r
   }\r
\r
\r
   /**\r
    * Set property value.\r
    *\r
    * @param value  property value\r
    */\r
   public void setValue( String value ) {\r
      this.value = value;\r
   }\r
\r
   /**\r
    * ANT task's entry point, will be called after init(). \r
    *\r
    * @exception BuildException\r
    *            If name or value is null\r
    */\r
   public void execute() throws BuildException {\r
       if (name == null || value == null) {\r
           throw new BuildException("Name or value must not null.");\r
       }\r
       getProject().setProperty(name, value);\r
   }\r
}\r
\r