org.eclipse.jgit.hooks.PreCommitHook.java Source code

Introduction

Here is the source code for org.eclipse.jgit.hooks.PreCommitHook.java

Source

/*
 * Copyright (C) 2015 Obeo.
 * and other copyright owners as documented in the project's IP log.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.eclipse.jgit.hooks;

import java.io.IOException;
import java.io.PrintStream;

import org.eclipse.jgit.api.errors.AbortedByHookException;
import org.eclipse.jgit.lib.Repository;

/**
 * The <code>pre-commit</code> hook implementation. This hook is run before the
 * commit and can reject the commit.
 *
 * @since 4.0
 */
public class PreCommitHook extends GitHook<Void> {

    /** The pre-commit hook name. */
    public static final String NAME = "pre-commit"; //$NON-NLS-1$

    /**
     * Constructor for PreCommitHook
     * <p>
     * This constructor will use the default error stream.
     * </p>
     *
     * @param repo
     *            The repository
     * @param outputStream
     *            The output stream the hook must use. {@code null} is allowed,
     *            in which case the hook will use {@code System.out}.
     */
    protected PreCommitHook(Repository repo, PrintStream outputStream) {
        super(repo, outputStream);
    }

    /**
     * Constructor for PreCommitHook
     *
     * @param repo
     *            The repository
     * @param outputStream
     *            The output stream the hook must use. {@code null} is allowed,
     *            in which case the hook will use {@code System.out}.
     * @param errorStream
     *            The error stream the hook must use. {@code null} is allowed,
     *            in which case the hook will use {@code System.err}.
     * @since 5.6
     */
    protected PreCommitHook(Repository repo, PrintStream outputStream, PrintStream errorStream) {
        super(repo, outputStream, errorStream);
    }

    /** {@inheritDoc} */
    @Override
    public Void call() throws IOException, AbortedByHookException {
        doRun();
        return null;
    }

    /** {@inheritDoc} */
    @Override
    public String getHookName() {
        return NAME;
    }

}