| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Plugin (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.config.plugins, annotation type: Plugin"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Plugin.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#annotation-interface-optional-element-summary">Optional</a> | </li> |
| <li><a href="#annotation-interface-required-element-summary">Required</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#annotation-interface-element-detail">Element</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.config.plugins</a></div> |
| <h1 title="Annotation Type Plugin" class="title">Annotation Type Plugin</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>) |
| </span><span class="modifiers">public @interface </span><span class="element-name type-name-label">Plugin</span></div> |
| <div class="block">Annotation that identifies a Class as a Plugin.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <li> |
| <section class="member-summary" id="annotation-interface-required-element-summary"> |
| <h2>Required Element Summary</h2> |
| <div class="caption"><span>Required Elements</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Required Element</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#category()" class="member-name-link">category</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Category to place the plugin under.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#name()" class="member-name-link">name</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Name of the plugin.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <li> |
| <section class="member-summary" id="annotation-interface-optional-element-summary"> |
| <h2>Optional Element Summary</h2> |
| <div class="caption"><span>Optional Elements</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Optional Element</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#deferChildren()" class="member-name-link">deferChildren</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#elementType()" class="member-name-link">elementType</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Name of the corresponding category of elements this plugin belongs under.</div> |
| </div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#printObject()" class="member-name-link">printObject</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Indicates if the plugin class implements a useful <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a> method for use in log messages.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#EMPTY" class="member-name-link">EMPTY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Value of the elementType when none is specified.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details" id="annotation-interface-element-detail"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EMPTY"> |
| <h3>EMPTY</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">EMPTY</span></div> |
| <div class="block">Value of the elementType when none is specified.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.config.plugins.Plugin.EMPTY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <li> |
| <section class="member-details"> |
| <h2>Element Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="name()"> |
| <h3>name</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">name</span></div> |
| <div class="block">Name of the plugin. Note that this name is case-insensitive.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="category()"> |
| <h3>category</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">category</span></div> |
| <div class="block">Category to place the plugin under. Category names are case-sensitive.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <li> |
| <section class="member-details"> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="elementType()"> |
| <h3>elementType</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">elementType</span></div> |
| <div class="block">Name of the corresponding category of elements this plugin belongs under. For example, <code>appender</code> would |
| indicate an <a href="../../Appender.html" title="interface in org.apache.logging.log4j.core"><code>Appender</code></a> plugin which would be in the |
| <code><Appenders/></code> element of a <a href="../Configuration.html" title="interface in org.apache.logging.log4j.core.config"><code>Configuration</code></a>.</div> |
| <dl class="notes"> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="printObject()"> |
| <h3>printObject</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">printObject</span></div> |
| <div class="block">Indicates if the plugin class implements a useful <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a> method for use in log messages.</div> |
| <dl class="notes"> |
| <dt>Default:</dt> |
| <dd>false</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deferChildren()"> |
| <h3>deferChildren</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">deferChildren</span></div> |
| <dl class="notes"> |
| <dt>Default:</dt> |
| <dd>false</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, 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> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
