View Javadoc

1   package org.apache.maven.scm.provider.jazz.command.checkout;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.scm.ScmFile;
23  import org.apache.maven.scm.ScmFileStatus;
24  import org.apache.maven.scm.log.ScmLogger;
25  import org.apache.maven.scm.provider.ScmProviderRepository;
26  import org.apache.maven.scm.provider.jazz.command.consumer.AbstractRepositoryConsumer;
27  import org.apache.regexp.RE;
28  import org.apache.regexp.RESyntaxException;
29  
30  import java.util.ArrayList;
31  import java.util.List;
32  
33  /**
34   * Consume the output of the scm command for the "load" operation.
35   *
36   * @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a>
37   */
38  public class JazzCheckOutConsumer
39      extends AbstractRepositoryConsumer
40  {
41      private static final String DOWNLOAD_PATTERN = "^Downloading\\s(.*)\\s\\s\\(\\d.*B\\)$";
42  
43      /**
44       * @see #DOWNLOAD_PATTERN
45       */
46      private RE downloadRegexp;
47  
48      protected String fCurrentDir = "";
49  
50      private List<ScmFile> fCheckedOutFiles = new ArrayList<ScmFile>();
51  
52      /**
53       * Construct the JazzCheckOutCommand consumer.
54       *
55       * @param repository The repository we are working with.
56       * @param logger     The logger to use.
57       */
58      public JazzCheckOutConsumer( ScmProviderRepository repository, ScmLogger logger )
59      {
60          super( repository, logger );
61  
62          try
63          {
64              downloadRegexp = new RE( DOWNLOAD_PATTERN );
65          }
66          catch ( RESyntaxException ex )
67          {
68              throw new RuntimeException(
69                  "INTERNAL ERROR: Could not create regexp to parse jazz scm checkout output. This shouldn't happen. Something is probably wrong with the oro installation.",
70                  ex );
71          }
72      }
73  
74      /**
75       * Process one line of output from the execution of the "scm load" command.
76       *
77       * @param line The line of output from the external command that has been pumped to us.
78       * @see org.codehaus.plexus.util.cli.StreamConsumer#consumeLine(java.lang.String)
79       */
80      public void consumeLine( String line )
81      {
82          // Examples:
83          // Downloading /checkout-test/src/emptyFile.txt (0 B)
84          // Downloading /checkout-test/src/folder with spaces/file with spaces.java (24.0 KB)
85          if ( downloadRegexp.match( line ) )
86          {
87              fCheckedOutFiles.add( new ScmFile( downloadRegexp.getParen( 1 ), ScmFileStatus.CHECKED_OUT ) );
88          }
89      }
90  
91      public List<ScmFile> getCheckedOutFiles()
92      {
93          return fCheckedOutFiles;
94      }
95  
96  }