package org.apache.maven.scm.provider.starteam.command.checkout;
   
   /*
    * 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
   *
   * http://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.
   */
  
  import org.apache.maven.scm.ScmException;
  import org.apache.maven.scm.ScmFileSet;
  import org.apache.maven.scm.ScmVersion;
  import org.apache.maven.scm.command.checkout.AbstractCheckOutCommand;
  import org.apache.maven.scm.command.checkout.CheckOutScmResult;
  import org.apache.maven.scm.provider.ScmProviderRepository;
  import org.apache.maven.scm.provider.starteam.command.StarteamCommand;
  import org.apache.maven.scm.provider.starteam.command.StarteamCommandLineUtils;
  import org.apache.maven.scm.provider.starteam.repository.StarteamScmProviderRepository;
  import org.codehaus.plexus.util.StringUtils;
  import org.codehaus.plexus.util.cli.CommandLineUtils;
  import org.codehaus.plexus.util.cli.Commandline;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
   * @author <a href="mailto:dantran@gmail.com">Dan T. Tran</a>
   * @author Olivier Lamy
   *
   */
  public class StarteamCheckOutCommand
      extends AbstractCheckOutCommand
      implements StarteamCommand
  {
      // ----------------------------------------------------------------------
      // AbstractCheckOutCommand Implementation
      // ----------------------------------------------------------------------
  
      /** {@inheritDoc} */
      protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repo, ScmFileSet fileSet,
                                                          ScmVersion version, boolean recursive )
          throws ScmException
      {
          if ( fileSet.getFileList().size() != 0 )
          {
              throw new ScmException( "This provider doesn't support checking out subsets of a directory" );
          }
  
          if ( getLogger().isInfoEnabled() )
          {
              getLogger().info( "Working directory: " + fileSet.getBasedir().getAbsolutePath() );
          }
  
          StarteamScmProviderRepository repository = (StarteamScmProviderRepository) repo;
  
          StarteamCheckOutConsumer consumer = new StarteamCheckOutConsumer( getLogger(), fileSet.getBasedir() );
  
          CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
  
          Commandline cl = createCommandLine( repository, fileSet, version );
  
          int exitCode = StarteamCommandLineUtils.executeCommandline( cl, consumer, stderr, getLogger() );
  
          if ( exitCode != 0 )
          {
              return new CheckOutScmResult( cl.toString(), "The starteam command failed.", stderr.getOutput(), false );
          }
  
          return new CheckOutScmResult( cl.toString(), consumer.getCheckedOutFiles() );
      }
  
      // ----------------------------------------------------------------------
      //
      // ----------------------------------------------------------------------
  
      public static Commandline createCommandLine( StarteamScmProviderRepository repo, ScmFileSet baseDir,
                                                   ScmVersion version )
      {
          List<String> args = new ArrayList<String>();
  
          if ( version != null && StringUtils.isNotEmpty( version.getName() ) )
          {
              args.add( "-vl" );
              args.add( version.getName() );
          }
  
         StarteamCommandLineUtils.addEOLOption( args );
 
         return StarteamCommandLineUtils.createStarteamCommandLine( "co", args, baseDir, repo );
     }
 }