content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one or more
   *  contributor license agreements.  See the NOTICE file distributed with
   *  this work for additional information regarding copyright ownership.
   *  The ASF licenses this file to You under the Apache License, Version 2.0
   *  (the "License"); you may not use this file except in compliance with
   *  the License.  You may obtain a copy of the License at
   *
   *      https://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS,
   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   *
   */
  
  package org.apache.tools.ant.taskdefs.optional.clearcase;
  
  import org.apache.tools.ant.BuildException;
  import org.apache.tools.ant.Project;
  import org.apache.tools.ant.taskdefs.Execute;
  import org.apache.tools.ant.types.Commandline;
  
  /**
   * Performs ClearCase UnCheckout command.
   *
   * <p>
   * The following attributes are interpreted:
   * <table border="1">
   *   <caption>Task attributes</caption>
   *   <tr>
   *     <th>Attribute</th>
   *     <th>Values</th>
   *     <th>Required</th>
   *   </tr>
   *   <tr>
   *      <td>viewpath</td>
   *      <td>Path to the ClearCase view file or directory that the command will operate on</td>
   *      <td>No</td>
   *   <tr>
   *   <tr>
   *      <td>keepcopy</td>
   *      <td>Specifies whether to keep a copy of the file with a .keep extension or not</td>
   *      <td>No</td>
   *   <tr>
   *   <tr>
   *      <td>failonerr</td>
   *      <td>Throw an exception if the command fails. Default is true</td>
   *      <td>No</td>
   *   <tr>
   * </table>
   *
   */
  public class CCUnCheckout extends ClearCase {
      /**
       *  -keep flag -- keep a copy of the file with .keep extension
       */
      public static final String FLAG_KEEPCOPY = "-keep";
      /**
       *  -rm flag -- remove the copy of the file
       */
      public static final String FLAG_RM = "-rm";
  
      private boolean mKeep = false;
  
      /**
       * Executes the task.
       * <p>
       * Builds a command line to execute cleartool and then calls Exec's run method
       * to execute the command line.
       * @throws BuildException if the command fails and failonerr is set to true
       */
      @Override
      public void execute() throws BuildException {
          Commandline commandLine = new Commandline();
          Project aProj = getProject();
  
          // Default the viewpath to basedir if it is not specified
          if (getViewPath() == null) {
              setViewPath(aProj.getBaseDir().getPath());
          }
  
          // build the command line from what we got the format is
          // cleartool uncheckout [options...] [viewpath ...]
          // as specified in the CLEARTOOL.EXE help
          commandLine.setExecutable(getClearToolCommand());
          commandLine.createArgument().setValue(COMMAND_UNCHECKOUT);
  
          checkOptions(commandLine);
  
          if (!getFailOnErr()) {
              getProject().log("Ignoring any errors that occur for: "
                      + getViewPathBasename(), Project.MSG_VERBOSE);
          }
          int result = run(commandLine);
          if (Execute.isFailure(result) && getFailOnErr()) {
              throw new BuildException("Failed executing: " + commandLine,
                  getLocation());
          }
      }
  
      /**
       * Check the command line options.
       */
      private void checkOptions(Commandline cmd) {
          // ClearCase items
          if (getKeepCopy()) {
              // -keep
              cmd.createArgument().setValue(FLAG_KEEPCOPY);
          } else {
              // -rm
              cmd.createArgument().setValue(FLAG_RM);
          }
  
          // viewpath
          cmd.createArgument().setValue(getViewPath());
      }
  
      /**
       * If true, keep a copy of the file with a .keep extension.
       *
       * @param keep the status to set the flag to
       */
      public void setKeepCopy(boolean keep) {
          mKeep = keep;
      }
  
      /**
       * Get keepcopy flag status
       *
       * @return boolean containing status of keep flag
       */
      public boolean getKeepCopy() {
          return mKeep;
      }
  
  }
  