001: /*
002: * Portions Copyright 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: /*
027: * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
028: * (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved
029: *
030: * The original version of this source code and documentation
031: * is copyrighted and owned by Taligent, Inc., a wholly-owned
032: * subsidiary of IBM. These materials are provided under terms
033: * of a License Agreement between Taligent and Sun. This technology
034: * is protected by multiple US and International patents.
035: *
036: * This notice and attribution to Taligent may not be removed.
037: * Taligent is a registered trademark of Taligent, Inc.
038: *
039: */
040:
041: package sun.util.resources;
042:
043: import java.util.Map;
044: import java.util.LinkedHashMap;
045:
046: /**
047: * Subclass of <code>ResourceBundle</code> with special
048: * functionality for time zone names. The additional functionality:
049: * <ul>
050: * <li>Preserves the order of entries in the <code>getContents</code>
051: * array for the enumeration returned by <code>getKeys</code>.
052: * <li>Inserts the time zone ID (the key of the bundle entries) into
053: * the string arrays returned by <code>handleGetObject</code>.
054: * <ul>
055: * All <code>TimeZoneNames</code> resource bundles must extend this
056: * class and implement the <code>getContents</code> method.
057: */
058: public abstract class TimeZoneNamesBundle extends
059: OpenListResourceBundle {
060:
061: /**
062: * Maps time zone IDs to locale-specific names.
063: * The value returned is an array of five strings:
064: * <ul>
065: * <li>The time zone ID (same as the key, not localized).
066: * <li>The long name of the time zone in standard time (localized).
067: * <li>The short name of the time zone in standard time (localized).
068: * <li>The long name of the time zone in daylight savings time (localized).
069: * <li>The short name of the time zone in daylight savings time (localized).
070: * </ul>
071: * The localized names come from the subclasses's
072: * <code>getContents</code> implementations, while the time zone
073: * ID is inserted into the returned array by this method.
074: */
075: public Object handleGetObject(String key) {
076: String[] contents = (String[]) super .handleGetObject(key);
077: if (contents == null) {
078: return null;
079: }
080:
081: int clen = contents.length;
082: String[] tmpobj = new String[clen + 1];
083: tmpobj[0] = key;
084: for (int i = 0; i < clen; i++) {
085: tmpobj[i + 1] = contents[i];
086: }
087: return tmpobj;
088: }
089:
090: /**
091: * Use LinkedHashMap to preserve order of bundle entries.
092: */
093: protected Map createMap(int size) {
094: return new LinkedHashMap(size);
095: }
096:
097: /**
098: * Provides key/value mappings for a specific
099: * resource bundle. Each entry of the array
100: * returned must be an array with two elements:
101: * <ul>
102: * <li>The key, which must be a string.
103: * <li>The value, which must be an array of
104: * four strings:
105: * <ul>
106: * <li>The long name of the time zone in standard time.
107: * <li>The short name of the time zone in standard time.
108: * <li>The long name of the time zone in daylight savings time.
109: * <li>The short name of the time zone in daylight savings time.
110: * </ul>
111: * </ul>
112: */
113: protected abstract Object[][] getContents();
114: }
|