Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-core / org / apache / logging / log4j / core / config / plugins / PluginAttribute.html
blob: 77473df1ea2b8bea5afbd6808d1ba5e563b32368 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>PluginAttribute (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: PluginAttribute">
<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/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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation-interface-optional-element-summary">Optional</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation-interface-required-element-summary">Required</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.config.plugins</a></div>
<h1 title="Annotation Type PluginAttribute" class="title">Annotation Type PluginAttribute</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#PARAMETER" title="class or interface in java.lang.annotation" class="external-link">PARAMETER</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html#FIELD" title="class or interface in java.lang.annotation" class="external-link">FIELD</a>})
<a href="PluginVisitorStrategy.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginVisitorStrategy</a>(<a href="visitors/PluginAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginAttributeVisitor.class</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">PluginAttribute</span></div>
<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#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang" class="external-link"><code>Enum.valueOf</code></a>.</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="#value()" class="member-name-link">value</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the name of the attribute (case-insensitive) this annotation corresponds to.</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="#defaultBoolean()" class="member-name-link">defaultBoolean</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the default boolean value to use.</div>
</div>
<div class="col-first odd-row-color"><code>byte</code></div>
<div class="col-second odd-row-color"><code><a href="#defaultByte()" class="member-name-link">defaultByte</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the default byte value to use.</div>
</div>
<div class="col-first even-row-color"><code>char</code></div>
<div class="col-second even-row-color"><code><a href="#defaultChar()" class="member-name-link">defaultChar</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the default byte value to use.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#defaultClass()" class="member-name-link">defaultClass</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> value to use.</div>
</div>
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#defaultDouble()" class="member-name-link">defaultDouble</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the default double floating point value to use.</div>
</div>
<div class="col-first odd-row-color"><code>float</code></div>
<div class="col-second odd-row-color"><code><a href="#defaultFloat()" class="member-name-link">defaultFloat</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the default floating point value to use.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#defaultInt()" class="member-name-link">defaultInt</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the default integer value to use.</div>
</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><code><a href="#defaultLong()" class="member-name-link">defaultLong</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the default long value to use.</div>
</div>
<div class="col-first even-row-color"><code>short</code></div>
<div class="col-second even-row-color"><code><a href="#defaultShort()" class="member-name-link">defaultShort</a></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the default long value to use.</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="#defaultString()" class="member-name-link">defaultString</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the default value this attribute should use if none is provided or if the provided value is invalid.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#sensitive()" class="member-name-link">sensitive</a></code></div>
<div class="col-last even-row-color">
<div class="block">Indicates that this attribute is a sensitive one that shouldn't be logged directly.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details" id="annotation-interface-element-detail">
<ul class="details-list">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<li>
<section class="member-details">
<h2>Element Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="value()">
<h3>value</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>&nbsp;<span class="element-name">value</span></div>
<div class="block">Specifies the name of the attribute (case-insensitive) this annotation corresponds to.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<li>
<section class="member-details">
<ul class="member-list">
<li>
<section class="detail" id="defaultBoolean()">
<h3>defaultBoolean</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">defaultBoolean</span></div>
<div class="block">Specifies the default boolean value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>false</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultByte()">
<h3>defaultByte</h3>
<div class="member-signature"><span class="return-type">byte</span>&nbsp;<span class="element-name">defaultByte</span></div>
<div class="block">Specifies the default byte value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>(byte)0x00</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultChar()">
<h3>defaultChar</h3>
<div class="member-signature"><span class="return-type">char</span>&nbsp;<span class="element-name">defaultChar</span></div>
<div class="block">Specifies the default byte value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>'\u0000'</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultClass()">
<h3>defaultClass</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;</span>&nbsp;<span class="element-name">defaultClass</span></div>
<div class="block">Specifies the default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>java.lang.Object.class</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultDouble()">
<h3>defaultDouble</h3>
<div class="member-signature"><span class="return-type">double</span>&nbsp;<span class="element-name">defaultDouble</span></div>
<div class="block">Specifies the default double floating point value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>0.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultFloat()">
<h3>defaultFloat</h3>
<div class="member-signature"><span class="return-type">float</span>&nbsp;<span class="element-name">defaultFloat</span></div>
<div class="block">Specifies the default floating point value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>0.0f</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultInt()">
<h3>defaultInt</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">defaultInt</span></div>
<div class="block">Specifies the default integer value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultLong()">
<h3>defaultLong</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">defaultLong</span></div>
<div class="block">Specifies the default long value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>0L</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultShort()">
<h3>defaultShort</h3>
<div class="member-signature"><span class="return-type">short</span>&nbsp;<span class="element-name">defaultShort</span></div>
<div class="block">Specifies the default long value to use.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultString()">
<h3>defaultString</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>&nbsp;<span class="element-name">defaultString</span></div>
<div class="block">Specifies the default value this attribute should use if none is provided or if the provided value is invalid.</div>
<dl class="notes">
<dt>Default:</dt>
<dd>""</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="sensitive()">
<h3>sensitive</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">sensitive</span></div>
<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 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 &copy; 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>