Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ResourceLocalizer |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.l10n; | |
16 | ||
17 | import java.util.Locale; | |
18 | ||
19 | import org.apache.hivemind.Resource; | |
20 | ||
21 | /** | |
22 | * An interface that defines how to localize a particular resource. A default implementation will | |
23 | * use {@link org.apache.hivemind.Resource#getLocalization(java.util.Locale)}, but this interface | |
24 | * (and associated chain of command configuration point) allows for alternative approaches to | |
25 | * localizing a resource. | |
26 | * | |
27 | * @author Howard M. Lewis Ship | |
28 | * @since 4.0 | |
29 | */ | |
30 | public interface ResourceLocalizer | |
31 | { | |
32 | /** | |
33 | * Finds and returns a localization of a root resource for the indicated locale. | |
34 | * | |
35 | * @param rootResource | |
36 | * the base resource for which a localization is needed | |
37 | * @param locale | |
38 | * the locale to find a localization for | |
39 | * @return the localized version of the resource, or null if not found | |
40 | */ | |
41 | Resource findLocalization(Resource rootResource, Locale locale); | |
42 | } |