1 /*
2 * #%L
3 * JavaHg parent POM
4 * %%
5 * Copyright (C) 2011 aragost Trifork ag
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package com.aragost.javahg;
27
28 /**
29 * To implement Mercurial commands for an extension create a subclass
30 * of this class.
31 * <p>
32 * Clients that would like to use the extension must add it to
33 * {@link RepositoryConfiguration}.
34 */
35 public abstract class MercurialExtension {
36
37 /**
38 * The initialize method is called once for each extension
39 */
40 public void initialize() throws Exception {
41
42 }
43
44 /**
45 *
46 * @return the name of the extension
47 */
48 public abstract String getName();
49
50 /**
51 * @return the path where the extension can be found. Return null
52 * if the extension is bundled with Mercurial
53 */
54 public String getPath() {
55 return null;
56 }
57
58 }