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.math3.exception.util;
18
19 import java.io.Serializable;
20 import java.util.Locale;
21
22 /**
23 * Interface for localizable strings.
24 *
25 * @version $Id: Localizable.java 1416643 2012-12-03 19:37:14Z tn $
26 * @since 2.2
27 */
28 public interface Localizable extends Serializable {
29 /**
30 * Gets the source (non-localized) string.
31 *
32 * @return the source string.
33 */
34 String getSourceString();
35
36 /**
37 * Gets the localized string.
38 *
39 * @param locale locale into which to get the string.
40 * @return the localized string or the source string if no
41 * localized version is available.
42 */
43 String getLocalizedString(Locale locale);
44 }