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 abstract class AbstractCommand
35      implements Command
36  {
37      private ScmLogger logger;
38  
39      protected abstract ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
40                                                   CommandParameters parameters )
41          throws ScmException;
42  
43      /** {@inheritDoc} */
44      public final ScmResult execute( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
45          throws ScmException
46      {
47          if ( repository == null )
48          {
49              throw new NullPointerException( "repository cannot be null" );
50          }
51  
52          if ( fileSet == null )
53          {
54              throw new NullPointerException( "fileSet cannot be null" );
55          }
56  
57          try
58          {
59              return executeCommand( repository, fileSet, parameters );
60          }
61          catch ( Exception ex )
62          {
63              throw new ScmException( "Exception while executing SCM command.", ex );
64          }
65      }
66  
67      /** {@inheritDoc} */
68      public final ScmLogger getLogger()
69      {
70          return logger;
71      }
72  
73      /** {@inheritDoc} */
74      public final void setLogger( ScmLogger logger )
75      {
76          this.logger = logger;
77      }
78  }