1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.i18n;
18
19 import java.text.MessageFormat;
20 import java.util.Locale;
21
22 import org.apache.commons.i18n.bundles.ErrorBundle;
23
24 /**
25 * The <code>LocalizedError</code> class is the base class for all errors
26 * that provide locaized error informations. This class should be subclassed
27 * in order to provide specific errors capable of localization support.
28 *
29 */
30 public class LocalizedError extends Error {
31 private ErrorBundle errorMessage;
32
33 /**
34 * @param errorMessage The error message contains a detailed localized description of this error
35 * @param throwable The <code>Throwable</code> that caused this error
36 */
37 public LocalizedError(ErrorBundle errorMessage, Throwable throwable) {
38 super(errorMessage.getSummary(Locale.getDefault(), throwable.getMessage()), throwable);
39 this.errorMessage = errorMessage;
40 }
41
42 /**
43 * @param errorMessage The error message contains a detailed localized description of this error
44 */
45 public LocalizedError(ErrorBundle errorMessage) {
46 super(errorMessage.getSummary(
47 Locale.getDefault(),
48 MessageFormat.format(
49 I18nUtils.INTERNAL_MESSAGES.getString(I18nUtils.MESSAGE_ENTRY_NOT_FOUND),
50 new String[] { errorMessage.getId(), ErrorBundle.SUMMARY })));
51 this.errorMessage = errorMessage;
52 }
53
54
55 /**
56 * @return the detailed error message that describes this error
57 */
58 public ErrorBundle getErrorMessage() {
59 return errorMessage;
60 }
61 }