KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > tools > localization > Localizable


1 package org.tigris.scarab.tools.localization;
2
3 /* ================================================================
4  * Copyright (c) 2000 CollabNet. 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
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by CollabNet (http://www.collab.net/)."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" name
28  * nor may "Tigris" appear in their names without prior written
29  * permission of CollabNet.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of CollabNet.
47  */
48
49 import org.tigris.scarab.tools.ScarabLocalizationTool;
50
51
52 /**
53  * Interface identifying instances capable of being localized
54  * using a <code>ScarabLocalizationTool</code> instance.
55  * <p>
56  * In order to localize throwables, one could reuse the following pattern:
57  * <code>
58  * public class MyLocalizedThrowable extends MyThrowableClass implements Localizable
59  * {
60  * // may be null
61  * private ScarabLocalizationTool localizer;
62  *
63  * // Set the localizer to be used in later calls to {@link #getLocalizedMessage()}
64  * // @param theLocalizer the localizer (may be <code>null</code>)
65  * public void setLocalizer(final ScarabLocalizationTool theLocalizer)
66  * {
67  * localizer = theLocalizer;
68  * }
69  *
70  * // Return the localized message for that throwable, if a localizer
71  * // was defined using {@link #setLocalizer(ScarabLocalizationTool)}
72  * // @return the localized message.
73  * public String getLocalizedMessage()
74  * {
75  * // we effectively implement an IoC pattern, made necessary by
76  * // the design of the Throwable base class
77  * if (localizer != null)
78  * {
79  * return toString(localizer);
80  * }
81  * else
82  * {
83  * return super.getLocalizedMessage();
84  * }
85  * }
86  * }
87  * </code>
88  * This should be particularly thought when one subclasses instances from a
89  * different framework, because that framework may be or may become localized
90  * one day.
91  *
92  * @version $Id: Localizable.java 9104 2004-05-10 21:04:51Z dabbous $
93  * @author <a HREF="mailto:dabbous@saxess.com">Hussayn Dabbous</a>
94  */
95
96 public interface Localizable
97 {
98     /**
99      * resolve the instance to the ScarabLocalizationTool.DEFAULT_LOCALE
100      * Note: This method should return english messages independent of
101      * any l10n settings. If a ScarabLocalizationTool instance is
102      * available, it is preferreable to use
103      * {@link resolve(ScarabLocalizationTool) } instead.
104      * @return the resolved String
105      */
106     public String JavaDoc getMessage();
107
108     /**
109      * resolve the message according to the parameters of the
110      * given ScarabLocalizationTool instance. It may contain L10NMessage
111      * instances and Exceptions. The parameters should be resolved
112      * recursively if necessary.
113      * @return
114      */
115     public String JavaDoc getMessage(ScarabLocalizationTool l10n);
116
117 }
118
Popular Tags