blob: 82c74dc49830a56de8e8730b71edc638ed193bd3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>RewritePolicy xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/log4j/rewrite/RewritePolicy.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.log4j.rewrite;
<a class="jxr_linenumber" name="L2" href="#L2">2</a>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.LoggingEvent;
<a class="jxr_linenumber" name="L4" href="#L4">4</a>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment">* Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment">* contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment">* this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment">* The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment">* (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment">* the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment">*</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment">* <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment">*</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment">* Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment">* distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment">* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment">* See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment">* limitations under the License.</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment">*/</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * This interface is implemented to provide a rewrite</em>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * strategy for RewriteAppender. RewriteAppender will</em>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * call the rewrite method with a source logging event.</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * The strategy may return that event, create a new event</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * or return null to suppress the logging request.</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/log4j/rewrite/RewritePolicy.html">RewritePolicy</a> {
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Rewrite a logging event.</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * @param source a logging event that may be returned or</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * used to create a new logging event.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @return a logging event or null to suppress processing.</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> LoggingEvent rewrite(<strong class="jxr_keyword">final</strong> LoggingEvent source);
<a class="jxr_linenumber" name="L37" href="#L37">37</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2002&#x2013;2018 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>