1 /*
2 * Copyright 2001-2005 Stephen Colebourne
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.joda.time.tz;
17
18 import java.util.Locale;
19
20 /**
21 * Service provider factory for localized time zone names.
22 *
23 * @author Brian S O'Neill
24 * @since 1.0
25 */
26 public interface NameProvider {
27 /**
28 * Returns a localized short name, or null if not found.
29 *
30 * @param locale locale to use for selecting name set
31 * @param id time zone id
32 * @param nameKey time zone name key
33 */
34 String getShortName(Locale locale, String id, String nameKey);
35
36 /**
37 * Returns a localized name, or null if not found.
38 *
39 * @param locale locale to use for selecting name set
40 * @param id time zone id
41 * @param nameKey time zone name key
42 */
43 String getName(Locale locale, String id, String nameKey);
44 }