View Javadoc
1   /*
2    * Copyright (C) 2010, Sasa Zivkov <sasa.zivkov@sap.com>
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.errors;
44  
45  import java.util.Locale;
46  import java.util.ResourceBundle;
47  
48  /**
49   * Common base class for all translation bundle related exceptions.
50   */
51  public abstract class TranslationBundleException extends RuntimeException {
52  	private static final long serialVersionUID = 1L;
53  
54  	private final Class bundleClass;
55  	private final Locale locale;
56  
57  	/**
58  	 * To construct an instance of {@link TranslationBundleException}
59  	 *
60  	 * @param message
61  	 *            exception message
62  	 * @param bundleClass
63  	 *            bundle class for which the exception occurred
64  	 * @param locale
65  	 *            locale for which the exception occurred
66  	 * @param cause
67  	 *            original exception that caused this exception. Usually thrown
68  	 *            from the {@link ResourceBundle} class.
69  	 */
70  	protected TranslationBundleException(String message, Class bundleClass, Locale locale, Exception cause) {
71  		super(message, cause);
72  		this.bundleClass = bundleClass;
73  		this.locale = locale;
74  	}
75  
76  	/**
77  	 * @return bundle class for which the exception occurred
78  	 */
79  	final public Class getBundleClass() {
80  		return bundleClass;
81  	}
82  
83  	/**
84  	 * @return locale for which the exception occurred
85  	 */
86  	final public Locale getLocale() {
87  		return locale;
88  	}
89  }