From d1addc14d5c2430c2b9fbea3081884d4f9d62a4c Mon Sep 17 00:00:00 2001 From: Roel Spilker Date: Sat, 6 Nov 2010 22:01:18 +0100 Subject: Updated website documentation to include @Log --- website/features/Log.html | 76 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 website/features/Log.html (limited to 'website/features/Log.html') diff --git a/website/features/Log.html b/website/features/Log.html new file mode 100644 index 00000000..45beca77 --- /dev/null +++ b/website/features/Log.html @@ -0,0 +1,76 @@ + + + + + + + + @Log +
+
+
+
Project Lombok
+

@Log

+
Captain's Log, stardate 24435.7: "What was that line again?"
+
+

Overview

+

+ You can annotate any field with @Log to let lombok generate a logger field automatically.
+ The logger is named log and field's type depends on which logger you have selected. +

+ There are four @Log choices available:
+

+
@lombok.commons.Log
+
Creates private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(TargetType.class);
+
@lombok.jul.Log
+
Creates private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(TargetType.class.getName());
+
@lombok.log4j.Log
+
Creates private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(TargetType.class);
+
@lombok.slf4j.Log
+
Creates private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(TargetType.class);
+
+

+

+ All @Log annotations can take an optional parameter of type Class. If such a parameter is specified, that class will be used as the parameter for the logger factory call. +

+
+
+
+

With Lombok

+
@HTML_PRE@
+
+
+
+

Vanilla Java

+
@HTML_POST@
+
+
+
+
+

Small print

+

+ If a field called log already exists, a warning will be emitted and no code will be generated. +

+

+ Although it is possible to specify any class literal to pass to the logger factory method, passing void.class will be considered to be the same as specifying no parameter. +

+
+
+
+ Back to features | Previous feature (@SneakyThrows) | Next feature
+ credits | Copyright © 2009-2010 Reinier Zwitserloot, Roel Spilker and Robbert Jan Grootjans, licensed under the MIT license. +
+
+
+
+ + + -- cgit From 8e7334a50535ef33189c3e71fcab0d9e625c6534 Mon Sep 17 00:00:00 2001 From: Roel Spilker Date: Sat, 6 Nov 2010 23:29:43 +0100 Subject: Updated documentation on @Log and moved them all to lombok.extern.* --- website/features/Log.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'website/features/Log.html') diff --git a/website/features/Log.html b/website/features/Log.html index 45beca77..c63eeb05 100644 --- a/website/features/Log.html +++ b/website/features/Log.html @@ -20,14 +20,14 @@

There are four @Log choices available:

-
@lombok.commons.Log
-
Creates private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(TargetType.class);
-
@lombok.jul.Log
-
Creates private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(TargetType.class.getName());
-
@lombok.log4j.Log
-
Creates private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(TargetType.class);
-
@lombok.slf4j.Log
-
Creates private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(TargetType.class);
+
@lombok.extern.apachecommons.Log
+
Creates private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
+
@lombok.extern.jul.Log
+
Creates private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
+
@lombok.extern.log4j.Log
+
Creates private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
+
@lombok.extern.slf4j.Log
+
Creates private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

-- cgit From 1f0db1191a7fcc35aaeab1481a806201a450d797 Mon Sep 17 00:00:00 2001 From: Roel Spilker Date: Sun, 7 Nov 2010 02:49:01 +0100 Subject: Use the actual annotation value to process the @Log annotations instead of their String representations. --- website/features/Log.html | 3 --- 1 file changed, 3 deletions(-) (limited to 'website/features/Log.html') diff --git a/website/features/Log.html b/website/features/Log.html index c63eeb05..6912b6ed 100644 --- a/website/features/Log.html +++ b/website/features/Log.html @@ -51,9 +51,6 @@

If a field called log already exists, a warning will be emitted and no code will be generated.

-

- Although it is possible to specify any class literal to pass to the logger factory method, passing void.class will be considered to be the same as specifying no parameter. -

-- cgit