01: /*
02: * Copyright 2006 Dan Shellman
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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.iscreen.impl;
17:
18: import java.util.Locale;
19:
20: /**
21: * A Resource is a collection of String resources that are accessible via
22: * a particular key. Basically, a resource is a dictionary/map.
23: *
24: * @author Shellman, Dan
25: */
26: public interface Resource {
27: /**
28: * Retrieves a particular value from the resource based upon a given
29: * key.
30: *
31: * @param key The key to the resource string.
32: * @param locale The locale to use when retrieving the resource value.
33: *
34: * @return Returns the resource string for the given key.
35: */
36: String getValue(String key, Locale locale);
37: } //end Resource
|