organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-08 06:53:45 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 2

ICU-6710 Add description to ICULogger and implement in TimeZone.

Browse source 
X-SVN-Rev: 26492
This commit is contained in:
Michael Ow 2009-08-13 19:12:20 +00:00
parent 5f2ff249fd
commit 257bf86726
2 changed files with 45 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
icu4j/main/classes/core/src/com/ibm/icu/impl/ICULogger.java
View file

@ -10,6 +10,8 @@ import java.util.logging.ConsoleHandler;
import java.util.logging.Logger;
import java.util.logging.Level;
import com.ibm.icu.util.TimeZone;
/**
*
* Extends the Java Logger class adding a method to turn off/on logging.
@ -23,7 +25,38 @@ import java.util.logging.Level;
* To use logging, the system property "icu4j.debug.logging" must be set to "on" or "all",
* otherwise the static ICULogger object will be null. This will help lower any unneccessary
* resource usage when logging is not desired.
*
* <P>
* <strong>Examples</strong>:<P>
* Usage in code
* <blockquote>
* <pre>
* public class Class {
* // Create logger object (usually with the class name)
* public static ICULogger ClassLogger = ICULogger.getICULogger(Class.class.getName());
*
* // Method that will use logger.
* public boolean hasSomething(Object obj) {
* if (obj == null) {
* // Log that obj is null.
* // Note: Good to check for null and if logging is turned on to minimize resource usage when logging is not needed.
* if (ClassLogger != null && ClassLogger.isLoggingOn()) {
* ClassLogger.warning("obj is null so false was returned by default.");
* }
* return false;
* }
*
* ...
*
* }
* }
* </pre>
* </blockquote>
* Turning on logging (using the default settings)
* <blockquote>
* <pre>
* java -Dicu4j.debug.logging=all program
* </pre>
* </blockquote>
* @author Michael Ow
* @draft ICU 4.4
*/

11
icu4j/main/classes/core/src/com/ibm/icu/util/TimeZone.java
View file

@ -20,6 +20,7 @@ import com.ibm.icu.impl.SimpleCache;
import com.ibm.icu.impl.TimeZoneAdapter;
import com.ibm.icu.impl.ZoneMeta;
import com.ibm.icu.text.SimpleDateFormat;
import com.ibm.icu.impl.ICULogger;
/**
* <code>TimeZone</code> represents a time zone offset, and also figures out daylight
@ -99,6 +100,12 @@ import com.ibm.icu.text.SimpleDateFormat;
* @stable ICU 2.0
*/
abstract public class TimeZone implements Serializable, Cloneable {
/**
* A logger for TimeZone. Will be null if logging is not on by way of system property: "icu4j.debug.logging"
* @draft ICU 4.4
*/
public static ICULogger TimeZoneLogger = ICULogger.getICULogger(TimeZone.class.getName());
// using serialver from jdk1.4.2_05
private static final long serialVersionUID = -744942128318337471L;
@ -600,6 +607,10 @@ abstract public class TimeZone implements Serializable, Cloneable {
result = ZoneMeta.getCustomTimeZone(ID);
}
if (result == null) {
/* Log that timezone is using GMT if logging is on. */
if (TimeZoneLogger != null && TimeZoneLogger.isLoggingOn()) {
TimeZoneLogger.warning("\"" +ID + "\" is a bogus id so timezone is falling back to GMT.");
}
result = ZoneMeta.getGMT();
}
}