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.mkdir;
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.command.AbstractCommand;
027import org.apache.maven.scm.provider.ScmProviderRepository;
028
029/**
030 * @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
031 *
032 */
033public abstract class AbstractMkdirCommand extends AbstractCommand {
034    /**
035     * Creates directories in the remote repository.
036     *
037     * @param repository TODO
038     * @param fileSet TODO
039     * @param message TODO
040     * @param createInLocal TODO
041     * @return TODO
042     * @throws ScmException if any
043     */
044    protected abstract MkdirScmResult executeMkdirCommand(
045            ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean createInLocal)
046            throws ScmException;
047
048    /** {@inheritDoc} */
049    protected ScmResult executeCommand(
050            ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
051        if (fileSet.getFileList().isEmpty()) {
052            throw new IllegalArgumentException("fileSet can not be empty");
053        }
054
055        return executeMkdirCommand(
056                repository,
057                fileSet,
058                parameters.getString(CommandParameter.MESSAGE),
059                parameters.getBoolean(CommandParameter.SCM_MKDIR_CREATE_IN_LOCAL));
060    }
061}