001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.math3.exception.util;
018    
019    import java.io.Serializable;
020    import java.util.Locale;
021    
022    /**
023     * Interface for localizable strings.
024     *
025     * @version $Id: Localizable.java 1416643 2012-12-03 19:37:14Z tn $
026     * @since 2.2
027     */
028    public interface Localizable extends Serializable {
029        /**
030         * Gets the source (non-localized) string.
031         *
032         * @return the source string.
033         */
034        String getSourceString();
035    
036        /**
037         * Gets the localized string.
038         *
039         * @param locale locale into which to get the string.
040         * @return the localized string or the source string if no
041         * localized version is available.
042         */
043        String getLocalizedString(Locale locale);
044    }