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 public abstract class AbstractListCommand extends AbstractCommand {
34 /**
35 * List contents of the remote repository.
36 *
37 * @param repository what to list
38 * @param fileSet the files to list
39 * @param recursive whether list should return subfolder listing
40 * @param scmVersion TODO
41 * @return the list of files
42 * @throws ScmException if any
43 */
44 protected abstract ListScmResult executeListCommand(
45 ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
46 throws ScmException;
47
48 /**
49 * {@inheritDoc}
50 */
51 public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
52 throws ScmException {
53 if (fileSet.getFileList().isEmpty()) {
54 throw new IllegalArgumentException("fileSet can not be empty");
55 }
56
57 boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE);
58
59 ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
60
61 return executeListCommand(repository, fileSet, recursive, scmVersion);
62 }
63 }