001/*
002 *  Copyright 2001-2005 Stephen Colebourne
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.joda.time.tz;
017
018import java.util.Locale;
019
020/**
021 * Service provider factory for localized time zone names.
022 *
023 * @author Brian S O'Neill
024 * @since 1.0
025 */
026public interface NameProvider {
027    /**
028     * Returns a localized short name, or null if not found.
029     *
030     * @param locale locale to use for selecting name set
031     * @param id time zone id
032     * @param nameKey time zone name key
033     */
034    String getShortName(Locale locale, String id, String nameKey);
035    
036    /**
037     * Returns a localized name, or null if not found.
038     *
039     * @param locale locale to use for selecting name set
040     * @param id time zone id
041     * @param nameKey time zone name key
042     */
043    String getName(Locale locale, String id, String nameKey);
044}