001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.scm.command.list;
020
021import org.apache.maven.scm.CommandParameter;
022import org.apache.maven.scm.CommandParameters;
023import org.apache.maven.scm.ScmException;
024import org.apache.maven.scm.ScmFileSet;
025import org.apache.maven.scm.ScmResult;
026import org.apache.maven.scm.ScmVersion;
027import org.apache.maven.scm.command.AbstractCommand;
028import org.apache.maven.scm.provider.ScmProviderRepository;
029
030/**
031 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
032 */
033public abstract class AbstractListCommand extends AbstractCommand {
034    /**
035     * List contents of the remote repository.
036     *
037     * @param repository what to list
038     * @param fileSet    the files to list
039     * @param recursive  whether list should return subfolder listing
040     * @param scmVersion TODO
041     * @return the list of files
042     * @throws ScmException if any
043     */
044    protected abstract ListScmResult executeListCommand(
045            ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
046            throws ScmException;
047
048    /**
049     * {@inheritDoc}
050     */
051    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
052            throws ScmException {
053        if (fileSet.getFileList().isEmpty()) {
054            throw new IllegalArgumentException("fileSet can not be empty");
055        }
056
057        boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE);
058
059        ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
060
061        return executeListCommand(repository, fileSet, recursive, scmVersion);
062    }
063}