View Javadoc

1   package org.apache.maven.scm.command;
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.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.log.ScmLogger;
27  import org.apache.maven.scm.provider.ScmProviderRepository;
28  
29  /**
30   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
31   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
32   *
33   */
34  public interface Command
35  {
36      /** Plexus component key */
37      String ROLE = Command.class.getName();
38  
39      /**
40       * @param repository not null
41       * @param fileSet not null
42       * @param parameters could be null
43       * @return the result object
44       * @throws ScmException if any
45       */
46      ScmResult execute( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
47          throws ScmException;
48  
49      /**
50       * @param logger not null
51       */
52      void setLogger( ScmLogger logger );
53  
54      /**
55       * @return the current logger
56       */
57      ScmLogger getLogger();
58  }