1 /*
2 * Copyright (C) 2015 Obeo.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.hooks;
44
45 import java.io.IOException;
46 import java.io.PrintStream;
47
48 import org.eclipse.jgit.api.errors.AbortedByHookException;
49 import org.eclipse.jgit.lib.Repository;
50
51 /**
52 * The <code>pre-commit</code> hook implementation. This hook is run before the
53 * commit and can reject the commit.
54 *
55 * @since 4.0
56 */
57 public class PreCommitHook extends GitHook<Void> {
58
59 /** The pre-commit hook name. */
60 public static final String NAME = "pre-commit"; //$NON-NLS-1$
61
62 /**
63 * Constructor for PreCommitHook
64 *
65 * @param repo
66 * The repository
67 * @param outputStream
68 * The output stream the hook must use. {@code null} is allowed,
69 * in which case the hook will use {@code System.out}.
70 */
71 protected PreCommitHook(Repository repo, PrintStream outputStream) {
72 super(repo, outputStream);
73 }
74
75 /** {@inheritDoc} */
76 @Override
77 public Void call() throws IOException, AbortedByHookException {
78 doRun();
79 return null;
80 }
81
82 /** {@inheritDoc} */
83 @Override
84 public String getHookName() {
85 return NAME;
86 }
87
88 }