1 /*
2 * Copyright 2013 smartics, Kronseder & Reiner GmbH
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 de.smartics.resteasy.hypermedia.renderer;
17
18 import java.util.Locale;
19
20 /**
21 * Provides access to localized information to be requested by representation
22 * renderers.
23 */
24 public interface LocalizationProvider
25 {
26 // ********************************* Fields *********************************
27
28 // --- constants ------------------------------------------------------------
29
30 // ****************************** Initializer *******************************
31
32 // ****************************** Inner Classes *****************************
33
34 // ********************************* Methods ********************************
35
36 // --- get&set --------------------------------------------------------------
37
38 /**
39 * Returns the locale the provider provides resources for.
40 *
41 * @return the locale the provider provides resources for.
42 */
43 Locale getLocale();
44
45 // --- business -------------------------------------------------------------
46
47 /**
48 * Returns a copy of the link metadata for the given identifier. The copy may
49 * be changed by the client to add additional context information.
50 *
51 * @param id the identifier of the localized information requested.
52 * @return the localized link metadata information.
53 */
54 LinkMetadata getLinkMetadata(String id);
55
56 // --- object basics --------------------------------------------------------
57
58 }