blob: b4d25289199a0b390c5a3ed13960f3b8fe0bb965 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:45 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PluginAttribute (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<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="PluginAttribute (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
</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/PluginAttribute.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/logging/log4j/core/config/plugins/PluginAliases.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginBuilderAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" target="_top">Frames</a></li>
<li><a href="PluginAttribute.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>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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.logging.log4j.core.config.plugins</div>
<h2 title="Annotation Type PluginAttribute" class="title">Annotation Type PluginAttribute</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>})
<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginVisitorStrategy.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginVisitorStrategy</a>(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginVisitorStrategy.html#value--">value</a>=<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginAttributeVisitor.class</a>)
public @interface <a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.39">PluginAttribute</a></pre>
<div class="block">Identifies a Plugin Attribute and its default value. Note that only one of the defaultFoo attributes will be
used based on the type this annotation is attached to. Thus, for primitive types, the default<i>Type</i>
attribute will be used for some <i>Type</i>. However, for more complex types (including enums), the default
string value is used instead and should correspond to the string that would correctly convert to the appropriate
enum value using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang"><code>Enum.valueOf</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.required.element.summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a></span></code>
<div class="block">Specifies the name of the attribute (case-insensitive) this annotation corresponds to.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultBoolean--">defaultBoolean</a></span></code>
<div class="block">Specifies the default boolean value to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultByte--">defaultByte</a></span></code>
<div class="block">Specifies the default byte value to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultChar--">defaultChar</a></span></code>
<div class="block">Specifies the default byte value to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultClass--">defaultClass</a></span></code>
<div class="block">Specifies the default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> value to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultDouble--">defaultDouble</a></span></code>
<div class="block">Specifies the default double floating point value to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultFloat--">defaultFloat</a></span></code>
<div class="block">Specifies the default floating point value to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultInt--">defaultInt</a></span></code>
<div class="block">Specifies the default integer value to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultLong--">defaultLong</a></span></code>
<div class="block">Specifies the default long value to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultShort--">defaultShort</a></span></code>
<div class="block">Specifies the default long value to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/logging/log4j/core/config/plugins/PluginAttribute.html#defaultString--">defaultString</a></span></code>
<div class="block">Specifies the default value this attribute should use if none is provided or if the provided value is invalid.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#sensitive--">sensitive</a></span></code>
<div class="block">Indicates that this attribute is a sensitive one that shouldn't be logged directly.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="value--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.95">value</a></pre>
<div class="block">Specifies the name of the attribute (case-insensitive) this annotation corresponds to.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="defaultBoolean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultBoolean</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.44">defaultBoolean</a></pre>
<div class="block">Specifies the default boolean value to use.</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultByte--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultByte</h4>
<pre>public abstract&nbsp;byte&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.49">defaultByte</a></pre>
<div class="block">Specifies the default byte value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultChar--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultChar</h4>
<pre>public abstract&nbsp;char&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.54">defaultChar</a></pre>
<div class="block">Specifies the default byte value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultClass</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.59">defaultClass</a></pre>
<div class="block">Specifies the default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> value to use.</div>
<dl>
<dt>Default:</dt>
<dd>java.lang.Object.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultDouble--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultDouble</h4>
<pre>public abstract&nbsp;double&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.64">defaultDouble</a></pre>
<div class="block">Specifies the default double floating point value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultFloat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultFloat</h4>
<pre>public abstract&nbsp;float&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.69">defaultFloat</a></pre>
<div class="block">Specifies the default floating point value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0.0f</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultInt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultInt</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.74">defaultInt</a></pre>
<div class="block">Specifies the default integer value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultLong</h4>
<pre>public abstract&nbsp;long&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.79">defaultLong</a></pre>
<div class="block">Specifies the default long value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0L</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultShort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultShort</h4>
<pre>public abstract&nbsp;short&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.84">defaultShort</a></pre>
<div class="block">Specifies the default long value to use.</div>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultString</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.89">defaultString</a></pre>
<div class="block">Specifies the default value this attribute should use if none is provided or if the provided value is invalid.</div>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="sensitive--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sensitive</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#line.101">sensitive</a></pre>
<div class="block">Indicates that this attribute is a sensitive one that shouldn't be logged directly. Such attributes will instead
be output as a hashed value.</div>
<dl>
<dt>Default:</dt>
<dd>false</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/PluginAttribute.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/logging/log4j/core/config/plugins/PluginAliases.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginBuilderAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" target="_top">Frames</a></li>
<li><a href="PluginAttribute.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>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>