1 /*
2 * Copyright (c) 2001-2004,
3 * RedVerst Group, ISP RAS http://www.ispras.ru
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice, this
10 * list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17 * may not be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 package com.unitesk.atp.text.localize;
33
34 /***
35 * The manager of localized strings.
36 * It maintains associations between objects and bundles of named localized strings.
37 *
38 * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
39 * @version $Id: StringManager.java,v 1.2 2004/10/11 15:00:43 all-x Exp $
40 */
41 public interface StringManager
42 {
43 /***
44 * Get localized string for the specified object.
45 * <code>getString( name, obj )</code> call is equivalent to
46 * {@link #getString(Class,String,Object) getString( obj.getClass(), name, obj )}.
47 *
48 * @param obj The specified object.
49 * @param name The name of localized string for this object.
50 * @return Localized string or <code>null</code> if it is not found.
51 */
52 String getString( String name, Object obj );
53
54 /***
55 * Get localized string for the specified class.
56 *
57 * <code>getString( cls, name )</code> call is equivalent to
58 * {@link #getString(Class,String,Object) getString( cls, name, null )}.
59 *
60 * @param cls The specified class.
61 * @param name The name of localized string for the specified class.
62 * @return Localized string or <code>null</code> if it is not found.
63 */
64 String getString( Class cls, String name );
65
66 /***
67 * Get localized string for the specified class and
68 * customize it for the specified object.
69 *
70 * @param cls The specified class.
71 * @param obj The specified object.
72 * @param name The name of localized string for the specified class.
73 * @return Localized string or <code>null</code> if it is not found.
74 */
75 String getString( Class cls, String name, Object obj );
76 }