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;
20  
21  import org.apache.maven.scm.CommandParameters;
22  import org.apache.maven.scm.ScmException;
23  import org.apache.maven.scm.ScmFileSet;
24  import org.apache.maven.scm.ScmResult;
25  import org.apache.maven.scm.provider.ScmProviderRepository;
26  
27  /**
28   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
29   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
30   *
31   */
32  public interface Command {
33      /** Plexus component key */
34      String ROLE = Command.class.getName();
35  
36      /**
37       * @param repository not null
38       * @param fileSet not null
39       * @param parameters could be null
40       * @return the result object
41       * @throws ScmException if any
42       */
43      ScmResult execute(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
44              throws ScmException;
45  }