blob: 5c81974219ba5e872048972c0c1fdef9d839c9ba [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Wed Aug 02 06:39:22 CEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Thresholdable (Apache Chainsaw 2.1.0-SNAPSHOT API)</title>
<meta name="date" content="2017-08-02">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Thresholdable (Apache Chainsaw 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Thresholdable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/spi/SimpleULogger.html" title="class in org.apache.log4j.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/spi/Thresholdable.html" target="_top">Frames</a></li>
<li><a href="Thresholdable.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.log4j.spi</div>
<h2 title="Interface Thresholdable" class="title">Interface Thresholdable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/log4j/db/CustomSQLDBReceiver.html" title="class in org.apache.log4j.db">CustomSQLDBReceiver</a>, <a href="../../../../org/apache/log4j/db/DBReceiver.html" title="class in org.apache.log4j.db">DBReceiver</a>, <a href="../../../../org/apache/log4j/chainsaw/Generator.html" title="class in org.apache.log4j.chainsaw">Generator</a>, <a href="../../../../org/apache/log4j/net/JMSReceiver.html" title="class in org.apache.log4j.net">JMSReceiver</a>, <a href="../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a>, <a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html" title="class in org.apache.log4j.xml">LogFileXMLReceiver</a>, <a href="../../../../org/apache/log4j/net/MulticastReceiver.html" title="class in org.apache.log4j.net">MulticastReceiver</a>, <a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a>, <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html" title="class in org.apache.log4j.net">SocketHubReceiver</a>, <a href="../../../../org/apache/log4j/net/SocketReceiver.html" title="class in org.apache.log4j.net">SocketReceiver</a>, <a href="../../../../org/apache/log4j/net/UDPReceiver.html" title="class in org.apache.log4j.net">UDPReceiver</a>, <a href="../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html" title="class in org.apache.log4j.chainsaw.vfs">VFSLogFilePatternReceiver</a>, <a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html" title="class in org.apache.log4j.net">XMLSocketReceiver</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Thresholdable</span></pre>
<div class="block">An interface that defines the required methods for supporting the
setting and getting of a level threshold. Components should implement
this interface if logging events they process should meet a certain
threshold before being processed further. Examples of this are
Appenders and Receivers which will not process logging events unless
the event level is at or greater than a set threshold level.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Paul Smith (psmith@apache.org), Mark Womack</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.log4j.Level</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/Thresholdable.html#getThreshold--">getThreshold</a></span>()</code>
<div class="block">Gets the current threshold setting of the component.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/Thresholdable.html#isAsSevereAsThreshold-org.apache.log4j.Level-">isAsSevereAsThreshold</a></span>(org.apache.log4j.Level&nbsp;level)</code>
<div class="block">Returns true if the given level is equals or greater than the current
threshold value of the component.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/Thresholdable.html#setThreshold-org.apache.log4j.Level-">setThreshold</a></span>(org.apache.log4j.Level&nbsp;level)</code>
<div class="block">Sets the component theshold to the given level.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setThreshold-org.apache.log4j.Level-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreshold</h4>
<pre>void&nbsp;setThreshold(org.apache.log4j.Level&nbsp;level)</pre>
<div class="block">Sets the component theshold to the given level.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - The threshold level events must equal or be greater
than before further processing can be done.</dd>
</dl>
</li>
</ul>
<a name="getThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreshold</h4>
<pre>org.apache.log4j.Level&nbsp;getThreshold()</pre>
<div class="block">Gets the current threshold setting of the component.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Level The current threshold level of the component.</dd>
</dl>
</li>
</ul>
<a name="isAsSevereAsThreshold-org.apache.log4j.Level-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAsSevereAsThreshold</h4>
<pre>boolean&nbsp;isAsSevereAsThreshold(org.apache.log4j.Level&nbsp;level)</pre>
<div class="block">Returns true if the given level is equals or greater than the current
threshold value of the component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - The level to test against the component threshold.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean True if level is equal or greater than the
component threshold.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Thresholdable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/spi/SimpleULogger.html" title="class in org.apache.log4j.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/spi/Thresholdable.html" target="_top">Frames</a></li>
<li><a href="Thresholdable.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 2002-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache Chainsaw, Chainsaw, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>