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   */
33  public abstract class AbstractMkdirCommand extends AbstractCommand {
34      /**
35       * Creates directories in the remote repository.
36       *
37       * @param repository TODO
38       * @param fileSet TODO
39       * @param message TODO
40       * @param createInLocal TODO
41       * @return TODO
42       * @throws ScmException if any
43       */
44      protected abstract MkdirScmResult executeMkdirCommand(
45              ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean createInLocal)
46              throws ScmException;
47  
48      /** {@inheritDoc} */
49      protected ScmResult executeCommand(
50              ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
51          if (fileSet.getFileList().isEmpty()) {
52              throw new IllegalArgumentException("fileSet can not be empty");
53          }
54  
55          return executeMkdirCommand(
56                  repository,
57                  fileSet,
58                  parameters.getString(CommandParameter.MESSAGE),
59                  parameters.getBoolean(CommandParameter.SCM_MKDIR_CREATE_IN_LOCAL));
60      }
61  }