| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.io;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.InputStream;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.OutputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.PrintStream;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.PrintWriter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.Reader;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.UnsupportedEncodingException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.io.Writer;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.nio.charset.Charset;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Objects;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.Level;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.LogManager;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.Logger;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.LoggingException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.Marker;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.spi.ExtendedLogger;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.util.StackLocatorUtil;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Builder class to wrap {@link Logger Loggers} into Java IO compatible classes.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p>Both the {@link InputStream}/{@link OutputStream} and {@link Reader}/{@link Writer} family of classes are<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * supported. {@link OutputStream} and {@link Writer} instances can be wrapped by a filtered version of their<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * corresponding classes ({@link java.io.FilterOutputStream} and {@link java.io.FilterWriter}) in order to log all<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * lines written to these instances. {@link InputStream} and {@link Reader} instances can be wrapped by a sort of<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * wiretapped version of their respective classes; all lines read from these instances will be logged.</p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p>The main feature, however, is the ability to create a {@link PrintWriter}, {@link PrintStream}, {@link Writer},<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * {@link java.io.BufferedWriter}, {@link OutputStream}, or {@link java.io.BufferedOutputStream} that is backed by a<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * {@link Logger}. The main inspiration for this feature is the JDBC API which uses a PrintWriter to perform debug<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * logging. In order to properly integrate APIs like JDBC into Log4j, create a PrintWriter using this class.</p><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p>The IoBuilder support configuration of the logging {@link Level} it should use (defaults to the level of<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * the underlying Logger), and an optional {@link Marker}. The other configurable objects are explained in more<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * detail below.</p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @since 2.1<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public class IoBuilder {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private final ExtendedLogger logger;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private Level level;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private Marker marker;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private String fqcn;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private boolean autoFlush;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private boolean buffered;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private int bufferSize;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private Charset charset;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private Reader reader;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private Writer writer;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private InputStream inputStream;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private OutputStream outputStream;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> /**<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * Creates a new builder for a given {@link Logger}. The Logger instance must implement {@link ExtendedLogger} or<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * an exception will be thrown.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param logger the Logger to wrap into a LoggerStream<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @return a new IoBuilder<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @throws UnsupportedOperationException if {@code logger} does not implement {@link ExtendedLogger} or if<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * {@code logger} is {@code null}<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static IoBuilder forLogger(final Logger logger) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return new IoBuilder(logger);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Creates a new builder using a Logger name. The name provided is used to get a Logger from<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * {@link LogManager#getLogger(String)} which will be wrapped into a LoggerStream.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param loggerName the name of the Logger to wrap into a LoggerStream<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @return a new IoBuilder<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public static IoBuilder forLogger(final String loggerName) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return new IoBuilder(LogManager.getLogger(loggerName));<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Creates a new builder using a Logger named after a given Class. The Class provided is used to get a Logger from<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * {@link LogManager#getLogger(Class)} which will be wrapped into a LoggerStream.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param clazz the Class to use as the Logger name to wrap into a LoggerStream<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @return a new IoBuilder<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public static IoBuilder forLogger(final Class<?> clazz) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return new IoBuilder(LogManager.getLogger(clazz));<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Creates a new builder using a Logger named after the calling Class. This is equivalent to the following:<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <pre><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * IoBuilder builder = IoBuilder.forLogger(LogManager.getLogger());<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * </pre><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> *<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return a new IoBuilder<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public static IoBuilder forLogger() {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return new IoBuilder(LogManager.getLogger(StackLocatorUtil.getCallerClass(2)));<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * Constructs a new IoBuilder for the given Logger. This method is provided for extensibility of this builder<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * class. The static factory methods should be used normally.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> *<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param logger the {@link ExtendedLogger} to wrap<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> protected IoBuilder(final Logger logger) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (!(logger instanceof ExtendedLogger)) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> throw new UnsupportedOperationException("The provided Logger [" + String.valueOf(logger) +<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> "] does not implement " + ExtendedLogger.class.getName());<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.logger = (ExtendedLogger) logger;<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Specifies the {@link Level} to log at. If no Level is configured, then the Level of the wrapped Logger will be<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * used.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param level the Level to use for logging<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @return {@code this}<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public IoBuilder setLevel(final Level level) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> this.level = level;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return this;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Specifies an optional {@link Marker} to use in all logging messages. If no Marker is specified, then no Marker<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * will be used.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> *<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @param marker the Marker to associate with all logging messages<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @return {@code this}<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> public IoBuilder setMarker(final Marker marker) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> this.marker = marker;<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return this;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Specifies the fully qualified class name of the IO wrapper class implementation. This method should only be<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * used when making significant extensions to the provided classes in this component and is normally unnecessary.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @param fqcn the fully qualified class name of the IO wrapper class being built<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @return {@code this}<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public IoBuilder setWrapperClassName(final String fqcn) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> this.fqcn = fqcn;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return this;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Indicates whether or not a built {@link PrintWriter} or {@link PrintStream} should automatically flush when<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * one of the {@code println}, {@code printf}, or {@code format} methods are invoked, or when a new line character<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * is printed.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> *<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param autoFlush if {@code true}, then {@code println}, {@code printf}, and {@code format} will auto flush<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @return {@code this}<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> */<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public IoBuilder setAutoFlush(final boolean autoFlush) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> this.autoFlush = autoFlush;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return this;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Enables or disables using a buffered variant of the desired IO class. If this is set to {@code true}, then the<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * instances returned by {@link #buildReader()} and {@link #buildInputStream()} can be safely cast (if necessary)<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * to {@link java.io.BufferedReader} and {@link java.io.BufferedInputStream} respectively. This option does not<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * have any effect on the other built variants.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> *<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @param buffered indicates whether or not a wrapped {@link InputStream} or {@link Reader} should be buffered<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return {@code this}<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> */<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> public IoBuilder setBuffered(final boolean buffered) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> this.buffered = buffered;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> return this;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> /**<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * Configures the buffer size to use when building a {@link java.io.BufferedReader} or<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * {@link java.io.BufferedInputStream} LoggerStream.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> *<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @param bufferSize the buffer size to use or a non-positive integer to use the default size<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @return {@code this}<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> */<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> public IoBuilder setBufferSize(final int bufferSize) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> this.bufferSize = bufferSize;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> return this;<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span><a name="line.206"></a> |
| <span class="sourceLineNo">207</span> /**<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * Specifies the character set to use when building an {@link InputStream}, {@link OutputStream}, or<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * {@link PrintStream}. If no character set is specified, then {@link java.nio.charset.Charset#defaultCharset()}<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * is used.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> *<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @param charset the character set to use when building an InputStream, OutputStream, or PrintStream<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @return {@code this}<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> */<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> public IoBuilder setCharset(final Charset charset) {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> this.charset = charset;<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> return this;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> /**<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * Configures a {@link Reader} to be wiretapped when building a Reader. This must be set to a non-{@code null}<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * value in order to call {@link #buildReader()}.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> *<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @param reader the Reader to wiretap<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @return {@code this}<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> */<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> public IoBuilder filter(final Reader reader) {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> this.reader = reader;<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> return this;<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> /**<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * Configures a {@link Writer} to be written to in addition to the underlying Logger. If no Writer is specified,<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * then the built Writer or PrintWriter will only write to the underlying Logger.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> *<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param writer the Writer to write to in addition to the Logger<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @return {@code this}<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> */<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> public IoBuilder filter(final Writer writer) {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> this.writer = writer;<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return this;<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Configures an {@link InputStream} to be wiretapped when building an InputStream. This must be set to a<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * non-{@code null} value in order to call {@link #buildInputStream()}.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> *<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @param inputStream the InputStream to wiretap<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @return {@code this}<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> */<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public IoBuilder filter(final InputStream inputStream) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> this.inputStream = inputStream;<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> return this;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> /**<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Configures an {@link OutputStream} to be written to in addition to the underlying Logger. If no OutputStream is<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * specified, then the built OutputStream or PrintStream will only write to the underlying Logger.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> *<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * @param outputStream the OutputStream to write to in addition to the Logger<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * @return {@code this}<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> */<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public IoBuilder filter(final OutputStream outputStream) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> this.outputStream = outputStream;<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> return this;<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> // TODO: could this builder use generics to infer the desired IO class?<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * Builds a new {@link Reader} that is wiretapped by its underlying Logger. If buffering is enabled, then a<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * {@link java.io.BufferedReader} will be returned.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> *<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @return a new Reader wiretapped by a Logger<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @throws IllegalStateException if no Reader was configured for this builder<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> */<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> public Reader buildReader() {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> final Reader in = Objects.requireNonNull(this.reader, "reader");<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> if (this.buffered) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> if (this.bufferSize > 0) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> return new LoggerBufferedReader(in, this.bufferSize, this.logger, this.fqcn, this.level, this.marker);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> return new LoggerBufferedReader(in, this.logger, this.fqcn, this.level, this.marker);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> return new LoggerReader(in, this.logger, this.fqcn, this.level, this.marker);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> }<a name="line.286"></a> |
| <span class="sourceLineNo">287</span><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> /**<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * Builds a new {@link Writer} that is backed by a Logger and optionally writes to another Writer as well. If no<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * Writer is configured for this builder, then the returned Writer will only write to its underlying Logger.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> *<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * @return a new Writer or {@link java.io.FilterWriter} backed by a Logger<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> */<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> public Writer buildWriter() {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> if (this.writer == null) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> return new LoggerWriter(this.logger, this.fqcn, this.level, this.marker);<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> }<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> return new LoggerFilterWriter(this.writer, this.logger, this.fqcn, this.level, this.marker);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span><a name="line.300"></a> |
| <span class="sourceLineNo">301</span> /**<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * Builds a new {@link PrintWriter} that is backed by a Logger and optionally writes to another Writer as well. If<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * no Writer is configured for this builder, then the returned PrintWriter will only write to its underlying<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * Logger.<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> *<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @return a new PrintWriter that optionally writes to another Writer in addition to its underlying Logger<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> */<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> public PrintWriter buildPrintWriter() {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> if (this.writer == null) {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> return new LoggerPrintWriter(this.logger, this.autoFlush, this.fqcn, this.level, this.marker);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> }<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> return new LoggerPrintWriter(this.writer, this.autoFlush, this.logger, this.fqcn, this.level, this.marker);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> /**<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * Builds a new {@link InputStream} that is wiretapped by its underlying Logger. If buffering is enabled, then a<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * {@link java.io.BufferedInputStream} will be returned.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> *<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * @return a new InputStream wiretapped by a Logger<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * @throws IllegalStateException if no InputStream was configured for this builder<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> */<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> public InputStream buildInputStream() {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> final InputStream in = Objects.requireNonNull(this.inputStream, "inputStream");<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> if (this.buffered) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> if (this.bufferSize > 0) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> return new LoggerBufferedInputStream(in, this.charset, this.bufferSize, this.logger, this.fqcn,<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> this.level, this.marker);<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> return new LoggerBufferedInputStream(in, this.charset, this.logger, this.fqcn, this.level, this.marker);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> return new LoggerInputStream(in, this.charset, this.logger, this.fqcn, this.level, this.marker);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> /**<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * Builds a new {@link OutputStream} that is backed by a Logger and optionally writes to another OutputStream as<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * well. If no OutputStream is configured for this builder, then the returned OutputStream will only write to its<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * underlying Logger.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> *<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @return a new OutputStream that optionally writes to another OutputStream in addition to its underlying Logger<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> */<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> public OutputStream buildOutputStream() {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (this.outputStream == null) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> return new LoggerOutputStream(this.logger, this.level, this.marker, this.charset, this.fqcn);<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> return new LoggerFilterOutputStream(this.outputStream, this.charset, this.logger, this.fqcn, this.level,<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> this.marker);<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> /**<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Builds a new {@link PrintStream} that is backed by a Logger and optionally writes to another OutputStream as<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * well. If no OutputStream is configured for this builder, then the returned PrintStream will only write to its<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * underlying Logger.<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> *<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @return a new PrintStream that optionally writes to another OutputStream in addition to its underlying Logger<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * @throws LoggingException if the configured character set is unsupported by {@link PrintStream}<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> */<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> public PrintStream buildPrintStream() {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> try {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> if (this.outputStream == null) {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> return new LoggerPrintStream(this.logger, this.autoFlush, this.charset, this.fqcn, this.level,<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> this.marker);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> }<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> return new LoggerPrintStream(this.outputStream, this.autoFlush, this.charset, this.logger, this.fqcn,<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> this.level, this.marker);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> } catch (final UnsupportedEncodingException e) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> // this exception shouldn't really happen since we use Charset and not String<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> throw new LoggingException(e);<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> }<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> }<a name="line.369"></a> |
| <span class="sourceLineNo">370</span><a name="line.370"></a> |
| <span class="sourceLineNo">371</span>}<a name="line.371"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
