moved exception and logger classes to org.tianocore.common package

[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / SplitfileTask.java

/** @file\r
 SplitfileTask class.\r
\r
 SplitfileTask is used to call splitfile.exe to split input file to 2 output\r
 file.\r
\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
 **/\r
package org.tianocore.framework.tasks;\r
\r
import java.io.File;\r
\r
import org.apache.tools.ant.Task;\r
import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.taskdefs.Execute;\r
import org.apache.tools.ant.taskdefs.LogStreamHandler;\r
import org.apache.tools.ant.types.Commandline;\r
\r
import org.tianocore.common.logger.EdkLog;\r
\r
/**\r
  SplitfileTask class.\r
\r
  SplitfileTask is used to call splitfile.exe to split input file to 2 output\r
  file.\r
**/\r
public class SplitfileTask extends Task implements EfiDefine {\r
    ///\r
    /// input file\r
    ///\r
    private String inputFile = "";\r
\r
    ///\r
    /// offset value\r
    ///\r
    private String offset = "";\r
\r
\r
    /**\r
     * execute\r
     *\r
     * SplitfleTask execute function is to assemble tool command line & execute\r
     * tool command line\r
     *\r
     * @throws BuidException\r
     */\r
    public void execute() throws BuildException {\r
\r
        Project project = this.getOwningTarget().getProject();\r
\r
        //\r
        // set Logger\r
        //\r
        FrameworkLogger logger = new FrameworkLogger(project, "splitfile");\r
        EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));\r
        EdkLog.setLogger(logger);\r
\r
        //\r
        // absolute path of efi tools\r
        //\r
        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
        String command;\r
        String argument;\r
        if (path == null) {\r
            command = "SplitFile";\r
        } else {\r
            command = path + File.separatorChar + "SplitFile";\r
        }\r
\r
        //\r
        // argument of tools\r
        //\r
        argument = inputFile + " " + offset;\r
\r
        //\r
        // return value of fwimage execution\r
        //\r
        int revl = -1;\r
\r
        try {\r
            Commandline cmdline = new Commandline();\r
            cmdline.setExecutable(command);\r
            cmdline.createArgument().setLine(argument);\r
\r
            LogStreamHandler streamHandler = new LogStreamHandler(this,\r
                    Project.MSG_INFO, Project.MSG_WARN);\r
            Execute runner = new Execute(streamHandler, null);\r
\r
            runner.setAntRun(project);\r
            runner.setCommandline(cmdline.getCommandline());\r
\r
            EdkLog.log(EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r
            EdkLog.log(EdkLog.EDK_INFO, (new File(this.inputFile)).getName());\r
            revl = runner.execute();\r
            if (EFI_SUCCESS == revl) {\r
                //\r
                // command execution success\r
                //\r
                EdkLog.log(EdkLog.EDK_VERBOSE, "SplitFile succeeded!");\r
            } else {\r
                //\r
                // command execution fail\r
                //\r
                EdkLog.log(EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));\r
                throw new BuildException("SplitFile failed!");\r
            }\r
        } catch (Exception e) {\r
            throw new BuildException(e.getMessage());\r
        }\r
    }\r
\r
    /**\r
     * getInputFile\r
     *\r
     * This function is to get class member "inputFile".\r
     *\r
     * @return string of input file name.\r
     */\r
    public String getInputFile() {\r
        return inputFile;\r
    }\r
\r
    /**\r
     * setComponentType\r
     *\r
     * This function is to set class member "inputFile".\r
     *\r
     * @param inputFile\r
     *            string of input file name.\r
     */\r
    public void setInputFile(String inputFile) {\r
        this.inputFile = inputFile;\r
    }\r
\r
    /**\r
      getOffset\r
\r
      This function is to get class member "offset"\r
\r
      @return offset value of string.\r
    **/\r
    public String getOffset() {\r
        return offset;\r
    }\r
\r
    /**\r
      setOffset\r
\r
      This function is to set class member "offset"\r
\r
      @param offset\r
                 string of offset value.\r
    **/\r
    public void setOffset(String offset) {\r
        this.offset = offset;\r
    }\r
\r
}\r