View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.scm.command.list;
20  
21  import org.apache.maven.scm.CommandParameter;
22  import org.apache.maven.scm.CommandParameters;
23  import org.apache.maven.scm.ScmException;
24  import org.apache.maven.scm.ScmFileSet;
25  import org.apache.maven.scm.ScmResult;
26  import org.apache.maven.scm.ScmVersion;
27  import org.apache.maven.scm.command.AbstractCommand;
28  import org.apache.maven.scm.provider.ScmProviderRepository;
29  
30  /**
31   * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
32   *
33   */
34  public abstract class AbstractListCommand extends AbstractCommand {
35      /**
36       * List contents of the remote repository
37       *
38       * @param repository what to list
39       * @param fileSet    the files to list
40       * @param recursive  whether list should return subfolder listing
41       * @param scmVersion TODO
42       * @return the list of files
43       * @throws ScmException if any
44       */
45      protected abstract ListScmResult executeListCommand(
46              ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
47              throws ScmException;
48  
49      /** {@inheritDoc} */
50      public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
51              throws ScmException {
52          if (fileSet.getFileList().isEmpty()) {
53              throw new IllegalArgumentException("fileSet can not be empty");
54          }
55  
56          boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE);
57  
58          ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
59  
60          return executeListCommand(repository, fileSet, recursive, scmVersion);
61      }
62  }