View Javadoc

1   /*
2   Karma core - Core of the Karma application
3   Copyright (C) 2004  Toolforge <www.toolforge.nl>
4   
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9   
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  Lesser General Public License for more details.
14  
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19  package nl.toolforge.karma.core.vc;
20  
21  import nl.toolforge.karma.core.KarmaRuntimeException;
22  import nl.toolforge.karma.core.location.Location;
23  import nl.toolforge.karma.core.vc.cvsimpl.CVSRepository;
24  import nl.toolforge.karma.core.vc.cvsimpl.CVSRunner;
25  import nl.toolforge.karma.core.vc.svnimpl.SubversionLocationImpl;
26  import org.apache.commons.logging.Log;
27  import org.apache.commons.logging.LogFactory;
28  
29  /***
30   * Factory producing {@link Runner} instances.
31   *
32   * @author D.A. Smedes
33   * @version $Id: RunnerFactory.java,v 1.14 2004/11/10 22:25:11 hippe Exp $
34   */
35  public final class RunnerFactory {
36  
37    private static Log logger = LogFactory.getLog(RunnerFactory.class);
38  
39    private RunnerFactory() {}
40  
41    /***
42     * A <code>Runner</code> might be required for a command to execute something on a version control system. A module
43     * can determine which implementation of a runner it requires through the
44     * {@link nl.toolforge.karma.core.module.Module#getLocation} method.
45     *
46     * @param location The location for which a runner is required.
47     * @return A version control system specific <code>Runner</code>.
48     * @throws VersionControlException
49     * @throws AuthenticationException
50     */
51    public static Runner getRunner(Location location) throws VersionControlException, AuthenticationException {
52  
53      if (location == null) {
54        throw new IllegalArgumentException("Location cannot be null.");
55      }
56  
57      if (location instanceof CVSRepository) {
58        return new CVSRunner(location);
59      }
60      if (location instanceof SubversionLocationImpl) {
61        throw new KarmaRuntimeException("Subversion is not possible in Karma 1.0.");
62      }
63      throw new KarmaRuntimeException("Unsupported `Location` type.");
64    }
65  }