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.PrintStream;
46
47 import org.eclipse.jgit.lib.Repository;
48
49 /**
50 * Factory class for instantiating supported hooks.
51 *
52 * @since 4.0
53 */
54 public class Hooks {
55
56 /**
57 * @param repo
58 * @param outputStream
59 * The output stream, or {@code null} to use {@code System.out}
60 * @return The pre-commit hook for the given repository.
61 */
62 public static PreCommitHook preCommit(Repository repo,
63 PrintStream outputStream) {
64 return new PreCommitHook(repo, outputStream);
65 }
66
67 /**
68 * @param repo
69 * @param outputStream
70 * The output stream, or {@code null} to use {@code System.out}
71 * @return The post-commit hook for the given repository.
72 * @since 4.5
73 */
74 public static PostCommitHook postCommit(Repository repo,
75 PrintStream outputStream) {
76 return new PostCommitHook(repo, outputStream);
77 }
78
79 /**
80 * @param repo
81 * @param outputStream
82 * The output stream, or {@code null} to use {@code System.out}
83 * @return The commit-msg hook for the given repository.
84 */
85 public static CommitMsgHook commitMsg(Repository repo,
86 PrintStream outputStream) {
87 return new CommitMsgHook(repo, outputStream);
88 }
89
90 /**
91 * @param repo
92 * @param outputStream
93 * The output stream, or {@code null} to use {@code System.out}
94 * @return The pre-push hook for the given repository.
95 * @since 4.2
96 */
97 public static PrePushHook prePush(Repository repo, PrintStream outputStream) {
98 return new PrePushHook(repo, outputStream);
99 }
100 }