View Javadoc

1   package org.apache.maven.scm.command.mkdir;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.scm.CommandParameter;
23  import org.apache.maven.scm.CommandParameters;
24  import org.apache.maven.scm.ScmException;
25  import org.apache.maven.scm.ScmFileSet;
26  import org.apache.maven.scm.ScmResult;
27  import org.apache.maven.scm.command.AbstractCommand;
28  import org.apache.maven.scm.provider.ScmProviderRepository;
29  
30  /**
31   * @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
32   *
33   */
34  public abstract class AbstractMkdirCommand
35      extends AbstractCommand
36  {
37      /**
38       * Creates directories in the remote repository.
39       * 
40       * @param repository
41       * @param fileSet
42       * @param createInLocal TODO
43       * @param scmVersion
44       * @return
45       * @throws ScmException
46       */
47      protected abstract MkdirScmResult executeMkdirCommand( ScmProviderRepository repository, ScmFileSet fileSet,
48                                                             String message, boolean createInLocal )
49          throws ScmException;
50  
51      /** {@inheritDoc} */
52      protected ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
53                                          CommandParameters parameters )
54          throws ScmException
55      {
56          if ( fileSet.getFileList().isEmpty() )
57          {
58              throw new IllegalArgumentException( "fileSet can not be empty" );
59          }
60  
61          return executeMkdirCommand( repository, fileSet, parameters.getString( CommandParameter.MESSAGE ),
62                                      parameters.getBoolean( CommandParameter.SCM_MKDIR_CREATE_IN_LOCAL ) );
63      }
64  
65  }