AbortedByHookException.java

  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.api.errors;

  44. import java.text.MessageFormat;

  45. import org.eclipse.jgit.internal.JGitText;

  46. /**
  47.  * Exception thrown when a hook returns a process result with a value different
  48.  * from 0. It is up to the caller to decide whether this should block execution
  49.  * or not.
  50.  *
  51.  * @since 4.0
  52.  */
  53. public class AbortedByHookException extends GitAPIException {
  54.     private static final long serialVersionUID = 1L;

  55.     /**
  56.      * The hook that caused this exception.
  57.      */
  58.     private final String hookName;

  59.     /**
  60.      * The process result.
  61.      */
  62.     private final int returnCode;

  63.     /**
  64.      * Constructor for AbortedByHookException
  65.      *
  66.      * @param message
  67.      *            The error details.
  68.      * @param hookName
  69.      *            The name of the hook that interrupted the command, must not be
  70.      *            null.
  71.      * @param returnCode
  72.      *            The return code of the hook process that has been run.
  73.      */
  74.     public AbortedByHookException(String message, String hookName,
  75.             int returnCode) {
  76.         super(message);
  77.         this.hookName = hookName;
  78.         this.returnCode = returnCode;
  79.     }

  80.     /**
  81.      * Get hook name
  82.      *
  83.      * @return the type of the hook that interrupted the git command.
  84.      */
  85.     public String getHookName() {
  86.         return hookName;
  87.     }

  88.     /**
  89.      * Get return code
  90.      *
  91.      * @return the hook process result.
  92.      */
  93.     public int getReturnCode() {
  94.         return returnCode;
  95.     }

  96.     /** {@inheritDoc} */
  97.     @Override
  98.     public String getMessage() {
  99.         return MessageFormat.format(JGitText.get().commandRejectedByHook,
  100.                 hookName, super.getMessage());
  101.     }
  102. }