| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CsvParameterLayout (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.layout, class: CsvParameterLayout"> |
| <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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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/CsvParameterLayout.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="#nested-class-summary">Nested</a> | </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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</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.layout</a></div> |
| <h1 title="Class CsvParameterLayout" class="title">Class CsvParameterLayout</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractLayout</a><<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>> |
| <div class="inheritance"><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractStringLayout</a> |
| <div class="inheritance"><a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractCsvLayout</a> |
| <div class="inheritance">org.apache.logging.log4j.core.layout.CsvParameterLayout</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<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>, <code><a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>></code>, <code><a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../config/plugins/Plugin.html#name()">name</a>="CsvParameterLayout", |
| <a href="../config/plugins/Plugin.html#category()">category</a>="Core", |
| <a href="../config/plugins/Plugin.html#elementType()">elementType</a>="layout", |
| <a href="../config/plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">CsvParameterLayout</span> |
| <span class="extends-implements">extends <a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></span></div> |
| <div class="block">A Comma-Separated Value (CSV) layout to log event parameters. |
| The event message is currently ignored. |
| |
| <p> |
| Best used with: |
| </p> |
| <p> |
| <code>logger.debug(new ObjectArrayMessage(1, 2, "Bob"));</code> |
| </p> |
| |
| Depends on Apache Commons CSV 1.4.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.4</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h2> |
| <code><a href="AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a> extends <a href="AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a>>>, <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>, <a href="AbstractStringLayout.Serializer2.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractCsvLayout">Fields inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></h3> |
| <code><a href="AbstractCsvLayout.html#DEFAULT_CHARSET">DEFAULT_CHARSET</a>, <a href="AbstractCsvLayout.html#DEFAULT_FORMAT">DEFAULT_FORMAT</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Fields inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3> |
| <code><a href="AbstractStringLayout.html#DEFAULT_STRING_BUILDER_SIZE">DEFAULT_STRING_BUILDER_SIZE</a>, <a href="AbstractStringLayout.html#MAX_STRING_BUILDER_SIZE">MAX_STRING_BUILDER_SIZE</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Fields inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="AbstractLayout.html#configuration">configuration</a>, <a href="AbstractLayout.html#eventCount">eventCount</a>, <a href="AbstractLayout.html#footer">footer</a>, <a href="AbstractLayout.html#header">header</a>, <a href="AbstractLayout.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Layout">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../Layout.html#ELEMENT_TYPE">ELEMENT_TYPE</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat,java.lang.String,java.lang.String)" class="member-name-link">CsvParameterLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| org.apache.commons.csv.CSVFormat csvFormat, |
| <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> header, |
| <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> footer)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDefaultLayout()" class="member-name-link">createDefaultLayout</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createLayout(org.apache.commons.csv.CSVFormat)" class="member-name-link">createLayout</a><wbr>(org.apache.commons.csv.CSVFormat format)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createLayout(org.apache.logging.log4j.core.config.Configuration,java.lang.String,java.lang.Character,java.lang.Character,java.lang.Character,org.apache.commons.csv.QuoteMode,java.lang.String,java.lang.String,java.nio.charset.Charset,java.lang.String,java.lang.String)" class="member-name-link">createLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <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> format, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> delimiter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> escape, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> quote, |
| org.apache.commons.csv.QuoteMode quoteMode, |
| <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> nullString, |
| <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> recordSeparator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| <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> header, |
| <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> footer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSerializable(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">toSerializable</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the event as an Object that can be serialized.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractCsvLayout">Methods inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></h3> |
| <code><a href="AbstractCsvLayout.html#createFormat(java.lang.String,java.lang.Character,java.lang.Character,java.lang.Character,org.apache.commons.csv.QuoteMode,java.lang.String,java.lang.String)">createFormat</a>, <a href="AbstractCsvLayout.html#getContentType()">getContentType</a>, <a href="AbstractCsvLayout.html#getFormat()">getFormat</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Methods inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3> |
| <code><a href="AbstractStringLayout.html#getBytes(java.lang.String)">getBytes</a>, <a href="AbstractStringLayout.html#getCharset()">getCharset</a>, <a href="AbstractStringLayout.html#getFooter()">getFooter</a>, <a href="AbstractStringLayout.html#getFooterSerializer()">getFooterSerializer</a>, <a href="AbstractStringLayout.html#getHeader()">getHeader</a>, <a href="AbstractStringLayout.html#getHeaderSerializer()">getHeaderSerializer</a>, <a href="AbstractStringLayout.html#getStringBuilder()">getStringBuilder</a>, <a href="AbstractStringLayout.html#getStringBuilderEncoder()">getStringBuilderEncoder</a>, <a href="AbstractStringLayout.html#requiresLocation()">requiresLocation</a>, <a href="AbstractStringLayout.html#serializeToBytes(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,byte%5B%5D)">serializeToBytes</a>, <a href="AbstractStringLayout.html#serializeToString(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)">serializeToString</a>, <a href="AbstractStringLayout.html#toByteArray(org.apache.logging.log4j.core.LogEvent)">toByteArray</a>, <a href="AbstractStringLayout.html#trimToMaxSize(java.lang.StringBuilder)">trimToMaxSize</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Methods inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="AbstractLayout.html#encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a>, <a href="AbstractLayout.html#getConfiguration()">getConfiguration</a>, <a href="AbstractLayout.html#getContentFormat()">getContentFormat</a>, <a href="AbstractLayout.html#markEvent()">markEvent</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <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">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.Encoder">Methods inherited from interface org.apache.logging.log4j.core.layout.<a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></h3> |
| <code><a href="Encoder.html#encode(T,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.Layout">Methods inherited from interface org.apache.logging.log4j.core.<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../Layout.html#getContentFormat()">getContentFormat</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,org.apache.commons.csv.CSVFormat,java.lang.String,java.lang.String)"> |
| <h3>CsvParameterLayout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CsvParameterLayout</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| org.apache.commons.csv.CSVFormat csvFormat, |
| <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> header, |
| <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> footer)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createDefaultLayout()"> |
| <h3>createDefaultLayout</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></span> <span class="element-name">createDefaultLayout</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLayout(org.apache.commons.csv.CSVFormat)"> |
| <h3>createLayout</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></span> <span class="element-name">createLayout</span><wbr><span class="parameters">(org.apache.commons.csv.CSVFormat format)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLayout(org.apache.logging.log4j.core.config.Configuration,java.lang.String,java.lang.Character,java.lang.Character,java.lang.Character,org.apache.commons.csv.QuoteMode,java.lang.String,java.lang.String,java.nio.charset.Charset,java.lang.String,java.lang.String)"> |
| <h3>createLayout</h3> |
| <div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></span> <span class="element-name">createLayout</span><wbr><span class="parameters">(<a href="../config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../config/plugins/PluginAttribute.html#value()">value</a>="format",<a href="../config/plugins/PluginAttribute.html#defaultString()">defaultString</a>="Default") |
| <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> format, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("delimiter") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> delimiter, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("escape") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> escape, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("quote") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a> quote, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("quoteMode") |
| org.apache.commons.csv.QuoteMode quoteMode, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("nullString") |
| <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> nullString, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("recordSeparator") |
| <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> recordSeparator, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../config/plugins/PluginAttribute.html#value()">value</a>="charset",<a href="../config/plugins/PluginAttribute.html#defaultString()">defaultString</a>="UTF-8") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("header") |
| <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> header, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("footer") |
| <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> footer)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSerializable(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>toSerializable</h3> |
| <div class="member-signature"><span class="modifiers">public</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">toSerializable</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Layout.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">Layout</a></code></span></div> |
| <div class="block">Formats the event as an Object that can be serialized.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The Logging Event.</dd> |
| <dt>Returns:</dt> |
| <dd>The formatted event.</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> |
