KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > nightlabs > l10n > DateFormatProvider


1 /* ************************************************************************** *
2  * Copyright (C) 2004 NightLabs GmbH, Marco Schulze *
3  * All rights reserved. *
4  * http://www.NightLabs.de *
5  * *
6  * This program and the accompanying materials are free software; you can re- *
7  * distribute it and/or modify it under the terms of the GNU General Public *
8  * License as published by the Free Software Foundation; either ver 2 of the *
9  * License, or any later version. *
10  * *
11  * This module is distributed in the hope that it will be useful, but WITHOUT *
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FIT- *
13  * NESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more *
14  * details. *
15  * *
16  * You should have received a copy of the GNU General Public License along *
17  * with this module; if not, write to the Free Software Foundation, Inc.: *
18  * 59 Temple Place, Suite 330 *
19  * Boston MA 02111-1307 *
20  * USA *
21  * *
22  * Or get it online: *
23  * http://www.opensource.org/licenses/gpl-license.php *
24  * *
25  * In case, you want to use this module or parts of it in a proprietary pro- *
26  * ject, you can purchase it under the NightLabs Commercial License. Please *
27  * contact NightLabs GmbH under info AT nightlabs DOT com for more infos or *
28  * visit http://www.NightLabs.com *
29  * ************************************************************************** */
30
31 /*
32  * Created on Dec 23, 2004
33  */
34 package com.nightlabs.l10n;
35
36 import java.text.DateFormat JavaDoc;
37
38 import com.nightlabs.config.Config;
39
40 /**
41  * @author Marco Schulze - marco at nightlabs dot de
42  * @author Marc Klinger - marc at nightlabs dot de (API documentation fixes)
43  */
44 public interface DateFormatProvider
45 {
46     /**
47      * This method is called once directly after the DateFormatProvider
48      * has been instantiated.
49      *
50      * @param config The configuration
51      * @param isoLanguage The language to use
52      * @param isoCountry The country to use
53      */
54     public void init(Config config, String JavaDoc isoLanguage, String JavaDoc isoCountry);
55
56     public static final long DATE = 0x000001L;
57     public static final long DATE_LONG = 0x000002L | DATE;
58     public static final long DATE_SHORT = 0x000004L | DATE;
59     public static final long DATE_WEEKDAY = 0x000008L | DATE;
60
61     public static final long TIME = 0x100000L;
62     public static final long TIME_SEC = 0x200000L | TIME;
63     public static final long TIME_MSEC = 0x400000L | TIME_SEC;
64
65     /**
66      * Warning! The DateFormatProvider can cache the DateFormat instances
67      * and therefore you should NEVER change the returned object. The
68      * effects on other parts of the software are unpredictable.
69      *
70      * @param flags The flags define the behaviour of the DateFormat.
71      * @return Returns an instance of DateFormat according to the given flags.
72      */
73     public DateFormat JavaDoc getDateFormat(long flags);
74 }
75
Popular Tags