| <!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:27 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PluginSkeleton (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="PluginSkeleton (Apache Chainsaw 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/PluginSkeleton.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/plugins/PluginRegistry.html" title="class in org.apache.log4j.plugins"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/plugins/PluginSkeleton.html" target="_top">Frames</a></li> |
| <li><a href="PluginSkeleton.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.plugins</div> |
| <h2 title="Class PluginSkeleton" class="title">Class PluginSkeleton</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">org.apache.log4j.spi.ComponentBase</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.log4j.plugins.PluginSkeleton</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>, <a href="../../../../org/apache/log4j/spi/Component.html" title="interface in org.apache.log4j.spi">Component</a>, org.apache.log4j.spi.OptionHandler</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">PluginSkeleton</span> |
| extends <a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a> |
| implements <a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></pre> |
| <div class="block">A convienent abstract class for plugin subclasses that implements |
| the basic methods of the Plugin interface. Subclasses are required |
| to implement the isActive(), activateOptions(), and shutdown() |
| methods. |
| <p></p> |
| <p>Developers are not required to subclass PluginSkeleton to |
| develop their own plugins (they are only required to implement the |
| Plugin interface), but it provides a convenient base class to start |
| from. |
| <p></p> |
| Contributors: Nicko Cadell</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Mark Womack (mwomack@apache.org), Paul Smith (psmith@apache.org)</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#active">active</a></span></code> |
| <div class="block">Active state of plugin.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#name">name</a></span></code> |
| <div class="block">Name of this plugin.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.spi.ComponentBase"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.spi.<a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3> |
| <code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#repository">repository</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#PluginSkeleton--">PluginSkeleton</a></span>()</code> |
| <div class="block">Construct new instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.beans.PropertyChangeListener-">addPropertyChangeListener</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</code> |
| <div class="block">Add property change listener.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">addPropertyChangeListener</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</code> |
| <div class="block">Add property change listener for one property only.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.beans.PropertyChangeEvent-">firePropertyChange</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeEvent.html?is-external=true" title="class or interface in java.beans">PropertyChangeEvent</a> evt)</code> |
| <div class="block">Fire a property change event to appropriate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-boolean-boolean-">firePropertyChange</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| boolean oldValue, |
| boolean newValue)</code> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-int-int-">firePropertyChange</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| int oldValue, |
| int newValue)</code> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-">firePropertyChange</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oldValue, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue)</code> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.apache.log4j.spi.LoggerRepository</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#getLoggerRepository--">getLoggerRepository</a></span>()</code> |
| <div class="block">Gets the logger repository for this plugin.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#getName--">getName</a></span>()</code> |
| <div class="block">Gets the name of the plugin.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#isActive--">isActive</a></span>()</code> |
| <div class="block">Returns whether this plugin is Active or not.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></span>(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a> testPlugin)</code> |
| <div class="block">Returns true if the plugin has the same name and logger repository as the |
| testPlugin passed in.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.beans.PropertyChangeListener-">removePropertyChangeListener</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</code> |
| <div class="block">Remove property change listener.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">removePropertyChangeListener</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</code> |
| <div class="block">Remove property change listener on a specific property.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a></span>(org.apache.log4j.spi.LoggerRepository repository)</code> |
| <div class="block">Sets the logger repository used by this plugin and notifies a |
| relevant PropertyChangeListeners registered.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</code> |
| <div class="block">Sets the name of the plugin and notifies |
| PropertyChangeListeners of the change.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.spi.ComponentBase"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.spi.<a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3> |
| <code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#getLogger--">getLogger</a>, <a href="../../../../org/apache/log4j/spi/ComponentBase.html#getNonFloodingLogger--">getNonFloodingLogger</a>, <a href="../../../../org/apache/log4j/spi/ComponentBase.html#resetErrorCount--">resetErrorCount</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.Plugin"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.log4j.plugins.<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></h3> |
| <code><a href="../../../../org/apache/log4j/plugins/Plugin.html#shutdown--">shutdown</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.spi.OptionHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.log4j.spi.OptionHandler</h3> |
| <code>activateOptions</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="name"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre> |
| <div class="block">Name of this plugin.</div> |
| </li> |
| </ul> |
| <a name="active"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>active</h4> |
| <pre>protected boolean active</pre> |
| <div class="block">Active state of plugin.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PluginSkeleton--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PluginSkeleton</h4> |
| <pre>protected PluginSkeleton()</pre> |
| <div class="block">Construct new instance.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block">Gets the name of the plugin.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#getName--">getName</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String the name of the plugin.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void setName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</pre> |
| <div class="block">Sets the name of the plugin and notifies |
| PropertyChangeListeners of the change.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#setName-java.lang.String-">setName</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newName</code> - the name of the plugin to set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoggerRepository--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoggerRepository</h4> |
| <pre>public org.apache.log4j.spi.LoggerRepository getLoggerRepository()</pre> |
| <div class="block">Gets the logger repository for this plugin.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#getLoggerRepository--">getLoggerRepository</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#getLoggerRepository--">getLoggerRepository</a></code> in class <code><a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>LoggerRepository the logger repository this plugin will affect.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLoggerRepository-org.apache.log4j.spi.LoggerRepository-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLoggerRepository</h4> |
| <pre>public void setLoggerRepository(org.apache.log4j.spi.LoggerRepository repository)</pre> |
| <div class="block">Sets the logger repository used by this plugin and notifies a |
| relevant PropertyChangeListeners registered. This |
| repository will be used by the plugin functionality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/spi/Component.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a></code> in interface <code><a href="../../../../org/apache/log4j/spi/Component.html" title="interface in org.apache.log4j.spi">Component</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a></code> in class <code><a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>repository</code> - the logger repository that this plugin should affect.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isActive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isActive</h4> |
| <pre>public boolean isActive()</pre> |
| <div class="block">Returns whether this plugin is Active or not.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#isActive--">isActive</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true/false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEquivalent-org.apache.log4j.plugins.Plugin-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEquivalent</h4> |
| <pre>public boolean isEquivalent(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a> testPlugin)</pre> |
| <div class="block">Returns true if the plugin has the same name and logger repository as the |
| testPlugin passed in.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>testPlugin</code> - The plugin to test equivalency against.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns true if testPlugin is considered to be equivalent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPropertyChangeListener-java.beans.PropertyChangeListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPropertyChangeListener</h4> |
| <pre>public final void addPropertyChangeListener(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</pre> |
| <div class="block">Add property change listener.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#addPropertyChangeListener-java.beans.PropertyChangeListener-">addPropertyChangeListener</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - listener.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPropertyChangeListener</h4> |
| <pre>public final void addPropertyChangeListener(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</pre> |
| <div class="block">Add property change listener for one property only.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#addPropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">addPropertyChangeListener</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name.</dd> |
| <dd><code>listener</code> - listener.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removePropertyChangeListener-java.beans.PropertyChangeListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePropertyChangeListener</h4> |
| <pre>public final void removePropertyChangeListener(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</pre> |
| <div class="block">Remove property change listener.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#removePropertyChangeListener-java.beans.PropertyChangeListener-">removePropertyChangeListener</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - listener.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removePropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePropertyChangeListener</h4> |
| <pre>public final void removePropertyChangeListener(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener)</pre> |
| <div class="block">Remove property change listener on a specific property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#removePropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">removePropertyChangeListener</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name.</dd> |
| <dd><code>listener</code> - listener.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="firePropertyChange-java.beans.PropertyChangeEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firePropertyChange</h4> |
| <pre>protected final void firePropertyChange(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/beans/PropertyChangeEvent.html?is-external=true" title="class or interface in java.beans">PropertyChangeEvent</a> evt)</pre> |
| <div class="block">Fire a property change event to appropriate listeners.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>evt</code> - change event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="firePropertyChange-java.lang.String-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firePropertyChange</h4> |
| <pre>protected final void firePropertyChange(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| boolean oldValue, |
| boolean newValue)</pre> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name.</dd> |
| <dd><code>oldValue</code> - old value.</dd> |
| <dd><code>newValue</code> - new value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="firePropertyChange-java.lang.String-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firePropertyChange</h4> |
| <pre>protected final void firePropertyChange(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| int oldValue, |
| int newValue)</pre> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name.</dd> |
| <dd><code>oldValue</code> - old value.</dd> |
| <dd><code>newValue</code> - new value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>firePropertyChange</h4> |
| <pre>protected final void firePropertyChange(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oldValue, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue)</pre> |
| <div class="block">Fire property change event to appropriate listeners.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name.</dd> |
| <dd><code>oldValue</code> - old value.</dd> |
| <dd><code>newValue</code> - new value.</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/PluginSkeleton.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/plugins/PluginRegistry.html" title="class in org.apache.log4j.plugins"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/plugins/PluginSkeleton.html" target="_top">Frames</a></li> |
| <li><a href="PluginSkeleton.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 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> |