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.mkdir;
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.command.AbstractCommand;
27  import org.apache.maven.scm.provider.ScmProviderRepository;
28  
29  /**
30   * @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
31   */
32  public abstract class AbstractMkdirCommand extends AbstractCommand {
33      /**
34       * Creates directories in the remote repository.
35       *
36       * @param repository TODO
37       * @param fileSet TODO
38       * @param message TODO
39       * @param createInLocal TODO
40       * @return TODO
41       * @throws ScmException if any
42       */
43      protected abstract MkdirScmResult executeMkdirCommand(
44              ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean createInLocal)
45              throws ScmException;
46  
47      /**
48       * {@inheritDoc}
49       */
50      protected ScmResult executeCommand(
51              ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
52          if (fileSet.getFileList().isEmpty()) {
53              throw new IllegalArgumentException("fileSet can not be empty");
54          }
55  
56          return executeMkdirCommand(
57                  repository,
58                  fileSet,
59                  parameters.getString(CommandParameter.MESSAGE),
60                  parameters.getBoolean(CommandParameter.SCM_MKDIR_CREATE_IN_LOCAL));
61      }
62  }