| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReusableSimpleMessage (Apache Log4j API 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.message, class: ReusableSimpleMessage"> |
| <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/ReusableSimpleMessage.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>Nested | </li> |
| <li>Field | </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.message</a></div> |
| <h1 title="Class ReusableSimpleMessage" class="title">Class ReusableSimpleMessage</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">org.apache.logging.log4j.message.ReusableSimpleMessage</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code>, <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code>, <code><a href="ParameterVisitable.html" title="interface in org.apache.logging.log4j.message">ParameterVisitable</a></code>, <code><a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a></code>, <code><a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReusableSimpleMessage</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>, <a href="ParameterVisitable.html" title="interface in org.apache.logging.log4j.message">ParameterVisitable</a></span></div> |
| <div class="block">Mutable Message wrapper around a String message.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.logging.log4j.message.ReusableSimpleMessage">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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()" class="member-name-link">ReusableSimpleMessage</a>()</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-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-tab2 method-summary-table-tab4"><code>char</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#charAt(int)" class="member-name-link">charAt</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><S> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)" class="member-name-link">forEachParameter</a><wbr>(<a href="ParameterConsumer.html" title="interface in org.apache.logging.log4j.message">ParameterConsumer</a><S> action, |
| S state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Performs the given action for each parameter until all values |
| have been processed or the action throws an exception.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(java.lang.StringBuilder)" class="member-name-link">formatTo</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buffer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| </div> |
| <div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFormat()" class="member-name-link">getFormat</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the format portion of the Message.</div> |
| </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="#getFormattedMessage()" class="member-name-link">getFormattedMessage</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the Message formatted as a String.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>short</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameterCount()" class="member-name-link">getParameterCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This message does not have any parameters so this method always returns zero.</div> |
| </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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameters()" class="member-name-link">getParameters</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets parameter values, if any.</div> |
| </div> |
| <div class="col-first even-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/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThrowable()" class="member-name-link">getThrowable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the throwable, if any.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#length()" class="member-name-link">length</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#memento()" class="member-name-link">memento</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an immutable snapshot of the current internal state of this reusable message.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(java.lang.CharSequence)" class="member-name-link">set</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> charSequence)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(java.lang.String)" class="member-name-link">set</a><wbr>(<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> message)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 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/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subSequence(int,int)" class="member-name-link">subSequence</a><wbr>(int start, |
| int end)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#swapParameters(java.lang.Object%5B%5D)" class="member-name-link">swapParameters</a><wbr>(<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>[] emptyReplacement)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This message does not have any parameters, so this method returns the specified array.</div> |
| </div> |
| </div> |
| </div> |
| </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-java.lang.CharSequence">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#chars--" title="class or interface in java.lang" class="external-link">chars</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#codePoints--" title="class or interface in java.lang" class="external-link">codePoints</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#toString--" title="class or interface in java.lang" class="external-link">toString</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>()"> |
| <h3>ReusableSimpleMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReusableSimpleMessage</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="set(java.lang.String)"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set</span><wbr><span class="parameters">(<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> message)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(java.lang.CharSequence)"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> charSequence)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFormattedMessage()"> |
| <h3>getFormattedMessage</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">getFormattedMessage</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Message.html#getFormattedMessage()">Message</a></code></span></div> |
| <div class="block">Gets the Message formatted as a String. Each Message implementation determines the |
| appropriate way to format the data encapsulated in the Message. Messages that provide |
| more than one way of formatting the Message will implement MultiformatMessage. |
| <p> |
| When configured to log asynchronously, this method is called before the Message is queued, unless this |
| message implements <a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message"><code>ReusableMessage</code></a> or is annotated with <a href="AsynchronouslyFormattable.html" title="annotation in org.apache.logging.log4j.message"><code>AsynchronouslyFormattable</code></a>. |
| This gives the Message implementation class a chance to create a formatted message String with the current value |
| of any mutable objects. |
| The intention is that the Message implementation caches this formatted message and returns it on subsequent |
| calls. (See <a href="https://issues.apache.org/jira/browse/LOG4J2-763">LOG4J2-763</a>.) |
| </p> |
| <p> |
| When logging synchronously, this method will not be called for Messages that implement the |
| <a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util"><code>StringBuilderFormattable</code></a> interface: instead, the |
| <a href="../util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)"><code>formatTo(StringBuilder)</code></a> method will be called so the |
| Message can format its contents without creating intermediate String objects. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Message.html#getFormattedMessage()">getFormattedMessage</a></code> in interface <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The message String.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFormat()"> |
| <h3>getFormat</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">getFormat</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Message.html#getFormat()">Message</a></code></span></div> |
| <div class="block">Gets the format portion of the Message.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Message.html#getFormat()">getFormat</a></code> in interface <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The message format. Some implementations, such as ParameterizedMessage, will use this as |
| the message "pattern". Other Messages may simply return an empty String. |
| TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. |
| (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and |
| StructuredDataMessage it is not. It is up to the Message implementer to determine what this |
| method will return. A Formatter is inappropriate as this is very specific to the Message |
| implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParameters()"> |
| <h3>getParameters</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</span> <span class="element-name">getParameters</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Message.html#getParameters()">Message</a></code></span></div> |
| <div class="block">Gets parameter values, if any.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Message.html#getParameters()">getParameters</a></code> in interface <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>An array of parameter values or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThrowable()"> |
| <h3>getThrowable</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/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span> <span class="element-name">getThrowable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Message.html#getThrowable()">Message</a></code></span></div> |
| <div class="block">Gets the throwable, if any.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Message.html#getThrowable()">getThrowable</a></code> in interface <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the throwable or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(java.lang.StringBuilder)"> |
| <h3>formatTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">formatTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buffer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">StringBuilderFormattable</a></code></span></div> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">formatTo</a></code> in interface <code><a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the StringBuilder to write into</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="swapParameters(java.lang.Object[])"> |
| <h3>swapParameters</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</span> <span class="element-name">swapParameters</span><wbr><span class="parameters">(<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>[] emptyReplacement)</span></div> |
| <div class="block">This message does not have any parameters, so this method returns the specified array.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReusableMessage.html#swapParameters(java.lang.Object%5B%5D)">swapParameters</a></code> in interface <code><a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>emptyReplacement</code> - the parameter array to return</dd> |
| <dt>Returns:</dt> |
| <dd>the specified array</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="ReusableMessage.html#getParameterCount()"><code>ReusableMessage.getParameterCount()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParameterCount()"> |
| <h3>getParameterCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">short</span> <span class="element-name">getParameterCount</span>()</div> |
| <div class="block">This message does not have any parameters so this method always returns zero.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReusableMessage.html#getParameterCount()">getParameterCount</a></code> in interface <code><a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>0 (zero)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)"> |
| <h3 id="forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,java.lang.Object)">forEachParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><S></span> <span class="return-type">void</span> <span class="element-name">forEachParameter</span><wbr><span class="parameters">(<a href="ParameterConsumer.html" title="interface in org.apache.logging.log4j.message">ParameterConsumer</a><S> action, |
| S state)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ParameterVisitable.html#forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)">ParameterVisitable</a></code></span></div> |
| <div class="block">Performs the given action for each parameter until all values |
| have been processed or the action throws an exception. |
| <p> |
| The second parameter lets callers pass in a stateful object to be modified with the key-value pairs, |
| so the TriConsumer implementation itself can be stateless and potentially reusable. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ParameterVisitable.html#forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)">forEachParameter</a></code> in interface <code><a href="ParameterVisitable.html" title="interface in org.apache.logging.log4j.message">ParameterVisitable</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>S</code> - type of the third parameter</dd> |
| <dt>Parameters:</dt> |
| <dd><code>action</code> - The action to be performed for each key-value pair in this collection</dd> |
| <dd><code>state</code> - the object to be passed as the third parameter to each invocation on the |
| specified ParameterConsumer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memento()"> |
| <h3>memento</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></span> <span class="element-name">memento</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReusableMessage.html#memento()">ReusableMessage</a></code></span></div> |
| <div class="block">Returns an immutable snapshot of the current internal state of this reusable message. The returned snapshot |
| will not be affected by subsequent modifications of this reusable message.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReusableMessage.html#memento()">memento</a></code> in interface <code><a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an immutable snapshot of this message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="length()"> |
| <h3>length</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">length</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#length--" title="class or interface in java.lang" class="external-link">length</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="charAt(int)"> |
| <h3>charAt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">charAt</span><wbr><span class="parameters">(int index)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#charAt-int-" title="class or interface in java.lang" class="external-link">charAt</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="subSequence(int,int)"> |
| <h3>subSequence</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/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></span> <span class="element-name">subSequence</span><wbr><span class="parameters">(int start, |
| int end)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#subSequence-int-int-" title="class or interface in java.lang" class="external-link">subSequence</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| </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> |