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 *
033 */
034public abstract class AbstractListCommand extends AbstractCommand {
035    /**
036     * List contents of the remote repository
037     *
038     * @param repository what to list
039     * @param fileSet    the files to list
040     * @param recursive  whether list should return subfolder listing
041     * @param scmVersion TODO
042     * @return the list of files
043     * @throws ScmException if any
044     */
045    protected abstract ListScmResult executeListCommand(
046            ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
047            throws ScmException;
048
049    /** {@inheritDoc} */
050    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
051            throws ScmException {
052        if (fileSet.getFileList().isEmpty()) {
053            throw new IllegalArgumentException("fileSet can not be empty");
054        }
055
056        boolean recursive = parameters.getBoolean(CommandParameter.RECURSIVE);
057
058        ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
059
060        return executeListCommand(repository, fileSet, recursive, scmVersion);
061    }
062}