Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / org / apache / logging / log4j / core / pattern / LogEventPatternConverter.html
blob: 5ef56a32f884d2ebb6f0ca9f8666b66d5680aae7 [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 Tue Feb 25 21:03:12 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LogEventPatternConverter (Apache Log4j Core 2.13.1 API)</title>
<meta name="date" content="2020-02-25">
<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="LogEventPatternConverter (Apache Log4j Core 2.13.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/LogEventPatternConverter.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/pattern/LiteralPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/pattern/LoggerFqcnPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html" target="_top">Frames</a></li>
<li><a href="LogEventPatternConverter.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.pattern.AbstractPatternConverter">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.logging.log4j.core.pattern</div>
<h2 title="Class LogEventPatternConverter" class="title">Class LogEventPatternConverter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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/logging/log4j/core/pattern/AbstractPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">org.apache.logging.log4j.core.pattern.AbstractPatternConverter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.logging.log4j.core.pattern.LogEventPatternConverter</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/logging/log4j/core/pattern/PatternConverter.html" title="interface in org.apache.logging.log4j.core.pattern">PatternConverter</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractStyleNameConverter.html" title="class in org.apache.logging.log4j.core.pattern">AbstractStyleNameConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/DatePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">DatePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/EncodingPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">EncodingPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/EndOfBatchPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">EndOfBatchPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/EqualsBaseReplacementConverter.html" title="class in org.apache.logging.log4j.core.pattern">EqualsBaseReplacementConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/FileLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">FileLocationPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/FullLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">FullLocationPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/HighlightConverter.html" title="class in org.apache.logging.log4j.core.pattern">HighlightConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/LevelPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LevelPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/LineLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LineLocationPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/LineSeparatorPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LineSeparatorPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/LiteralPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LiteralPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/LoggerFqcnPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LoggerFqcnPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MapPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MapPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MarkerPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MarkerPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MarkerSimpleNamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MarkerSimpleNamePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MaxLengthConverter.html" title="class in org.apache.logging.log4j.core.pattern">MaxLengthConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MdcPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MdcPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MessagePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MessagePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/MethodLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MethodLocationPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/NamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">NamePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/NanoTimePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">NanoTimePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/NdcPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">NdcPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/ProcessIdPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ProcessIdPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/RegexReplacementConverter.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacementConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/RelativeTimePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">RelativeTimePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/SequenceNumberPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">SequenceNumberPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/StyleConverter.html" title="class in org.apache.logging.log4j.core.pattern">StyleConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/ThreadIdPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThreadIdPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/ThreadNamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThreadNamePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/ThreadPriorityPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThreadPriorityPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThrowablePatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/UuidPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">UuidPatternConverter</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/VariablesNotEmptyReplacementConverter.html" title="class in org.apache.logging.log4j.core.pattern">VariablesNotEmptyReplacementConverter</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.25">LogEventPatternConverter</a>
extends <a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">AbstractPatternConverter</a></pre>
<div class="block">LoggingEventPatternConverter is a base class for pattern converters
that can format information from instances of LoggingEvent.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.pattern.AbstractPatternConverter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.logging.log4j.core.pattern.<a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">AbstractPatternConverter</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html#LOGGER">LOGGER</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.pattern.PatternConverter">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.logging.log4j.core.pattern.<a href="../../../../../../org/apache/logging/log4j/core/pattern/PatternConverter.html" title="interface in org.apache.logging.log4j.core.pattern">PatternConverter</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/pattern/PatternConverter.html#CATEGORY">CATEGORY</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">&nbsp;</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/logging/log4j/core/pattern/LogEventPatternConverter.html#LogEventPatternConverter-java.lang.String-java.lang.String-">LogEventPatternConverter</a></span>(<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;name,
<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;style)</code>
<div class="block">Constructs an instance of LoggingEventPatternConverter.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#format-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-">format</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;toAppendTo)</code>
<div class="block">Formats an event into a string buffer.</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/logging/log4j/core/pattern/LogEventPatternConverter.html#format-java.lang.Object-java.lang.StringBuilder-">format</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;output)</code>
<div class="block">Formats an object into a string buffer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#handlesThrowable--">handlesThrowable</a></span>()</code>
<div class="block">Normally pattern converters are not meant to handle Exceptions although few pattern converters might.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#isVariable--">isVariable</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.pattern.AbstractPatternConverter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.logging.log4j.core.pattern.<a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">AbstractPatternConverter</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html#getName--">getName</a>, <a href="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html#getStyleClass-java.lang.Object-">getStyleClass</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LogEventPatternConverter-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LogEventPatternConverter</h4>
<pre>protected&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.33">LogEventPatternConverter</a>(<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;name,
<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;style)</pre>
<div class="block">Constructs an instance of LoggingEventPatternConverter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of converter.</dd>
<dd><code>style</code> - CSS style for output.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="format-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public abstract&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.43">format</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;toAppendTo)</pre>
<div class="block">Formats an event into a string buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - event to format, may not be null.</dd>
<dd><code>toAppendTo</code> - string buffer to which the formatted event will be appended. May not be null.</dd>
</dl>
</li>
</ul>
<a name="format-java.lang.Object-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.49">format</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;output)</pre>
<div class="block">Formats an object into a string buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - event to format, may not be null.</dd>
<dd><code>output</code> - string buffer to which the formatted event will be appended. May not be null.</dd>
</dl>
</li>
</ul>
<a name="handlesThrowable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handlesThrowable</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.64">handlesThrowable</a>()</pre>
<div class="block">Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
<p>
By examining the return values for this method, the containing layout will determine whether it handles
throwables or not.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this PatternConverter handles throwables</dd>
</dl>
</li>
</ul>
<a name="isVariable--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isVariable</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html#line.68">isVariable</a>()</pre>
</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/LogEventPatternConverter.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/pattern/LiteralPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/pattern/LoggerFqcnPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html" target="_top">Frames</a></li>
<li><a href="LogEventPatternConverter.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.pattern.AbstractPatternConverter">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#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>