| <!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>TriggeringPolicy xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../apidocs/org/apache/logging/log4j/core/appender/rolling/TriggeringPolicy.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</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="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender.rolling; |
| <a class="jxr_linenumber" name="18" href="#18">18</a> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * A <code>TriggeringPolicy</code> controls the conditions under which rollover</em> |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * occurs. Such conditions include time of day, file size, an</em> |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * external event, the log request or a combination thereof.</em> |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/TriggeringPolicy.html">TriggeringPolicy</a> { |
| <a class="jxr_linenumber" name="27" href="#27">27</a> |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Initialize the Policy.</em> |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @param manager The RollingFileManager.</em> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">void</strong> initialize(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rolling/RollingFileManager.html">RollingFileManager</a> manager); |
| <a class="jxr_linenumber" name="34" href="#34">34</a> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Determines if a rollover may be appropriate at this time. If</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * true is returned, RolloverPolicy.rollover will be called but it</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * can determine that a rollover is not warranted.</em> |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @param event A reference to the currently event.</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @return true if a rollover should occur.</em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">boolean</strong> isTriggeringEvent(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event); |
| <a class="jxr_linenumber" name="44" href="#44">44</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
