You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2014/09/03 03:37:35 UTC
[14/29] git commit: Javadoc: Use the active voice.
Javadoc: Use the active voice.
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/e9a39074
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/e9a39074
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/e9a39074
Branch: refs/heads/LOG4J2-608
Commit: e9a390748c2ac5e372f16da870741b75dd33239f
Parents: 6e3a565
Author: Gary Gregory <ga...@gmail.com>
Authored: Tue Sep 2 10:15:37 2014 -0400
Committer: Gary Gregory <ga...@gmail.com>
Committed: Tue Sep 2 10:15:37 2014 -0400
----------------------------------------------------------------------
.../log4j/streams/LoggerInputStream.java | 9 +++--
.../log4j/streams/LoggerOutputStream.java | 16 ++++----
.../log4j/streams/LoggerPrintStream.java | 41 +++++++++++---------
.../log4j/streams/LoggerPrintWriter.java | 22 +++++------
.../logging/log4j/streams/LoggerReader.java | 8 ++--
5 files changed, 51 insertions(+), 45 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/e9a39074/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerInputStream.java
----------------------------------------------------------------------
diff --git a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerInputStream.java b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerInputStream.java
index 57a59bd..1ac53ae 100644
--- a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerInputStream.java
+++ b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerInputStream.java
@@ -29,8 +29,7 @@ import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.streams.util.ByteStreamLogger;
/**
- * Input stream that logs each line read to a pre-defined level. Can also be configured with a
- * Marker.
+ * Logs each line read to a pre-defined level. Can also be configured with a Marker.
*/
public class LoggerInputStream extends FilterInputStream {
private static final String FQCN = LoggerInputStream.class.getName();
@@ -38,7 +37,8 @@ public class LoggerInputStream extends FilterInputStream {
private final String fqcn;
private final ByteStreamLogger logger;
- public LoggerInputStream(final InputStream in, final Charset charset, final ExtendedLogger logger, final String fqcn, final Level level, final Marker marker) {
+ public LoggerInputStream(final InputStream in, final Charset charset, final ExtendedLogger logger,
+ final String fqcn, final Level level, final Marker marker) {
super(in);
this.logger = new ByteStreamLogger(logger, level, marker, charset);
this.fqcn = fqcn;
@@ -48,7 +48,8 @@ public class LoggerInputStream extends FilterInputStream {
this(in, charset, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerInputStream(final InputStream in, final Charset charset, final Logger logger, final Level level, final Marker marker) {
+ public LoggerInputStream(final InputStream in, final Charset charset, final Logger logger, final Level level,
+ final Marker marker) {
this(in, charset, (ExtendedLogger) logger, FQCN, level, marker);
}
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/e9a39074/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerOutputStream.java
----------------------------------------------------------------------
diff --git a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerOutputStream.java b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerOutputStream.java
index 4b11415..b10f805 100644
--- a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerOutputStream.java
+++ b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerOutputStream.java
@@ -28,11 +28,10 @@ import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.streams.util.ByteStreamLogger;
/**
- * Output stream that logs each line written to a pre-defined level. Can also be configured with a
- * Marker. This class provides an interface that follows the {@link java.io.OutputStream} methods in
- * spirit, but doesn't require output to any external stream. This class should <em>not</em> be used
- * as a stream for an underlying logger unless it's being used as a bridge. Otherwise, infinite
- * loops may occur!
+ * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
+ * that follows the {@link java.io.OutputStream} methods in spirit, but doesn't require output to any external stream.
+ * This class should <em>not</em> be used as a stream for an underlying logger unless it's being used as a bridge.
+ * Otherwise, infinite loops may occur!
*/
public class LoggerOutputStream extends OutputStream {
private static final String FQCN = LoggerOutputStream.class.getName();
@@ -57,8 +56,8 @@ public class LoggerOutputStream extends OutputStream {
this(null, Charset.defaultCharset(), (ExtendedLogger) logger, FQCN, level, marker);
}
- public LoggerOutputStream(final OutputStream out, final Charset charset, final ExtendedLogger logger, final String fqcn, final Level level,
- final Marker marker) {
+ public LoggerOutputStream(final OutputStream out, final Charset charset, final ExtendedLogger logger,
+ final String fqcn, final Level level, final Marker marker) {
this.out = out;
this.logger = new ByteStreamLogger(logger, level, marker, charset);
this.fqcn = fqcn;
@@ -68,7 +67,8 @@ public class LoggerOutputStream extends OutputStream {
this(out, charset, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerOutputStream(final OutputStream out, final Charset charset, final Logger logger, final Level level, final Marker marker) {
+ public LoggerOutputStream(final OutputStream out, final Charset charset, final Logger logger, final Level level,
+ final Marker marker) {
this(out, charset, (ExtendedLogger) logger, FQCN, level, marker);
}
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/e9a39074/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintStream.java
----------------------------------------------------------------------
diff --git a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintStream.java b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintStream.java
index fe171b1..ad7fcb7 100644
--- a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintStream.java
+++ b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintStream.java
@@ -30,20 +30,21 @@ import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.spi.ExtendedLogger;
/**
- * Output stream that logs each line written to a pre-defined level. Can also be configured with a
- * Marker. This class provides an interface that follows the {@link java.io.PrintStream} methods in
- * spirit, but doesn't require output to any external stream. This class should <em>not</em> be used
- * as a stream for an underlying logger unless it's being used as a bridge. Otherwise, infinite
- * loops may occur!
+ * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
+ * that follows the {@link java.io.PrintStream} methods in spirit, but doesn't require output to any external stream.
+ * This class should <em>not</em> be used as a stream for an underlying logger unless it's being used as a bridge.
+ * Otherwise, infinite loops may occur!
*/
public class LoggerPrintStream extends PrintStream {
private static final String FQCN = LoggerPrintStream.class.getName();
- public LoggerPrintStream(final Charset charset, final Logger logger, final Level level) throws UnsupportedEncodingException {
+ public LoggerPrintStream(final Charset charset, final Logger logger, final Level level)
+ throws UnsupportedEncodingException {
this(null, false, charset, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerPrintStream(final Charset charset, final Logger logger, final Level level, final Marker marker) throws UnsupportedEncodingException {
+ public LoggerPrintStream(final Charset charset, final Logger logger, final Level level, final Marker marker)
+ throws UnsupportedEncodingException {
this(null, false, charset, (ExtendedLogger) logger, FQCN, level, marker);
}
@@ -55,22 +56,24 @@ public class LoggerPrintStream extends PrintStream {
this(null, false, (ExtendedLogger) logger, FQCN, level, marker);
}
- public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset, final ExtendedLogger logger, final String fqcn,
- final Level level, final Marker marker) throws UnsupportedEncodingException {
+ public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset,
+ final ExtendedLogger logger, final String fqcn, final Level level, final Marker marker)
+ throws UnsupportedEncodingException {
super(new LoggerOutputStream(out, charset, logger, fqcn, level, marker), autoFlush, charset.name());
}
- public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset, final Logger logger, final Level level)
- throws UnsupportedEncodingException {
+ public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset,
+ final Logger logger, final Level level) throws UnsupportedEncodingException {
this(out, autoFlush, charset, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset, final Logger logger, final Level level, final Marker marker)
- throws UnsupportedEncodingException {
+ public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Charset charset,
+ final Logger logger, final Level level, final Marker marker) throws UnsupportedEncodingException {
this(out, autoFlush, charset, (ExtendedLogger) logger, FQCN, level, marker);
}
- public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final ExtendedLogger logger, final String fqcn, final Level level, final Marker marker) {
+ public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final ExtendedLogger logger,
+ final String fqcn, final Level level, final Marker marker) {
super(new LoggerOutputStream(out, Charset.defaultCharset(), logger, fqcn, level, marker), autoFlush);
}
@@ -78,16 +81,18 @@ public class LoggerPrintStream extends PrintStream {
this(out, autoFlush, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Logger logger, final Level level, final Marker marker) {
+ public LoggerPrintStream(final OutputStream out, final boolean autoFlush, final Logger logger, final Level level,
+ final Marker marker) {
this(out, autoFlush, (ExtendedLogger) logger, FQCN, level, marker);
}
- public LoggerPrintStream(final OutputStream out, final Charset charset, final Logger logger, final Level level) throws UnsupportedEncodingException {
+ public LoggerPrintStream(final OutputStream out, final Charset charset, final Logger logger, final Level level)
+ throws UnsupportedEncodingException {
this(out, false, charset, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerPrintStream(final OutputStream out, final Charset charset, final Logger logger, final Level level, final Marker marker)
- throws UnsupportedEncodingException {
+ public LoggerPrintStream(final OutputStream out, final Charset charset, final Logger logger, final Level level,
+ final Marker marker) throws UnsupportedEncodingException {
this(out, false, charset, (ExtendedLogger) logger, FQCN, level, marker);
}
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/e9a39074/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintWriter.java
----------------------------------------------------------------------
diff --git a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintWriter.java b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintWriter.java
index e896329..1dc6e4f 100644
--- a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintWriter.java
+++ b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerPrintWriter.java
@@ -27,9 +27,8 @@ import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.spi.ExtendedLogger;
/**
- * Print Writer that logs each line written to a pre-defined level. Can also be configured with a
- * Marker. This class provides an interface that follows the {@link java.io.PrintWriter} methods in
- * spirit, but doesn't require output to any external writer.
+ * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
+ * that follows the {@link java.io.PrintWriter} methods in spirit, but doesn't require output to any external writer.
*/
public class LoggerPrintWriter extends PrintWriter {
private static final String FQCN = LoggerPrintWriter.class.getName();
@@ -49,8 +48,8 @@ public class LoggerPrintWriter extends PrintWriter {
}
@SuppressWarnings("resource")
- public LoggerPrintWriter(final Writer writer, final boolean autoFlush, final ExtendedLogger logger, final String fqcn,
- final Level level, final Marker marker) {
+ public LoggerPrintWriter(final Writer writer, final boolean autoFlush, final ExtendedLogger logger,
+ final String fqcn, final Level level, final Marker marker) {
super(new LoggerWriterFilter(writer, logger, fqcn, level, marker), autoFlush);
}
@@ -58,7 +57,8 @@ public class LoggerPrintWriter extends PrintWriter {
this(writer, autoFlush, (ExtendedLogger) logger, FQCN, level, null);
}
- public LoggerPrintWriter(final Writer writer, final boolean autoFlush, final Logger logger, final Level level, final Marker marker) {
+ public LoggerPrintWriter(final Writer writer, final boolean autoFlush, final Logger logger, final Level level,
+ final Marker marker) {
this(writer, autoFlush, (ExtendedLogger) logger, FQCN, level, marker);
}
@@ -75,24 +75,24 @@ public class LoggerPrintWriter extends PrintWriter {
super.append(c);
return this;
}
-
+
@Override
public LoggerPrintWriter append(final CharSequence csq) {
super.append(csq);
return this;
}
-
+
@Override
public LoggerPrintWriter append(final CharSequence csq, final int start, final int end) {
super.append(csq, start, end);
return this;
}
-
+
@Override
public boolean checkError() {
return super.checkError();
}
-
+
@Override
public void close() {
super.close();
@@ -241,7 +241,7 @@ public class LoggerPrintWriter extends PrintWriter {
public void write(final int c) {
super.write(c);
}
-
+
@Override
public void write(final String s) {
super.write(s);
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/e9a39074/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerReader.java
----------------------------------------------------------------------
diff --git a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerReader.java b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerReader.java
index 39fa6fe..d156f67 100644
--- a/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerReader.java
+++ b/log4j-streams/src/main/java/org/apache/logging/log4j/streams/LoggerReader.java
@@ -29,9 +29,8 @@ import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.streams.util.CharStreamLogger;
/**
- * Writer that logs each line written to a pre-defined level. Can also be configured with a Marker.
- * This class provides an interface that follows the {@link java.io.Writer} methods in spirit, but
- * doesn't require output to any external writer.
+ * Logs each line written to a pre-defined level. Can also be configured with a Marker. This class provides an interface
+ * that follows the {@link java.io.Writer} methods in spirit, but doesn't require output to any external writer.
*/
public class LoggerReader extends FilterReader {
private static final String FQCN = LoggerReader.class.getName();
@@ -39,7 +38,8 @@ public class LoggerReader extends FilterReader {
private final CharStreamLogger logger;
private final String fqcn;
- public LoggerReader(final Reader reader, final ExtendedLogger logger, final String fqcn, final Level level, final Marker marker) {
+ public LoggerReader(final Reader reader, final ExtendedLogger logger, final String fqcn, final Level level,
+ final Marker marker) {
super(reader);
this.logger = new CharStreamLogger(logger, level, marker);
this.fqcn = fqcn;