| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Message (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, interface: Message"> |
| <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/Message.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>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface Message" class="title">Interface Message</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="EntryMessage.html" title="interface in org.apache.logging.log4j.message">EntryMessage</a></code>, <code><a href="ExitMessage.html" title="interface in org.apache.logging.log4j.message">ExitMessage</a></code>, <code><a href="FlowMessage.html" title="interface in org.apache.logging.log4j.message">FlowMessage</a></code>, <code><a href="MessageCollectionMessage.html" title="interface in org.apache.logging.log4j.message">MessageCollectionMessage</a><T></code>, <code><a href="MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code>, <code><a href="../util/MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a></code>, <code><a href="ReusableMessage.html" title="interface in org.apache.logging.log4j.message">ReusableMessage</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="FormattedMessage.html" title="class in org.apache.logging.log4j.message">FormattedMessage</a></code>, <code><a href="LocalizedMessage.html" title="class in org.apache.logging.log4j.message">LocalizedMessage</a></code>, <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></code>, <code><a href="MessageFormatMessage.html" title="class in org.apache.logging.log4j.message">MessageFormatMessage</a></code>, <code><a href="ObjectArrayMessage.html" title="class in org.apache.logging.log4j.message">ObjectArrayMessage</a></code>, <code><a href="ObjectMessage.html" title="class in org.apache.logging.log4j.message">ObjectMessage</a></code>, <code><a href="ParameterizedMessage.html" title="class in org.apache.logging.log4j.message">ParameterizedMessage</a></code>, <code><a href="ReusableObjectMessage.html" title="class in org.apache.logging.log4j.message">ReusableObjectMessage</a></code>, <code><a href="ReusableParameterizedMessage.html" title="class in org.apache.logging.log4j.message">ReusableParameterizedMessage</a></code>, <code><a href="ReusableSimpleMessage.html" title="class in org.apache.logging.log4j.message">ReusableSimpleMessage</a></code>, <code><a href="SimpleMessage.html" title="class in org.apache.logging.log4j.message">SimpleMessage</a></code>, <code><a href="StringFormattedMessage.html" title="class in org.apache.logging.log4j.message">StringFormattedMessage</a></code>, <code><a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</a></code>, <code><a href="StructuredDataCollectionMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataCollectionMessage</a></code>, <code><a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a></code>, <code><a href="ThreadDumpMessage.html" title="class in org.apache.logging.log4j.message">ThreadDumpMessage</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Message</span><span class="extends-implements"> |
| extends <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></span></div> |
| <div class="block">An interface for various Message implementations that can be logged. Messages can act as wrappers |
| around Objects so that user can have control over converting Objects to Strings when necessary without |
| requiring complicated formatters and as a way to manipulate the message based on information available |
| at runtime such as the locale of the system. |
| <p> |
| Custom Message implementations should consider implementing the <a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util"><code>StringBuilderFormattable</code></a> |
| interface for more efficient processing. Garbage-free Layouts will call |
| <a href="../util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)"><code>formatTo(StringBuilder)</code></a> instead of |
| <a href="#getFormattedMessage()"><code>getFormattedMessage()</code></a> if the Message implements StringBuilderFormattable. |
| </p> |
| <p> |
| Note: Message objects should not be considered to be thread safe nor should they be assumed to be |
| safely reusable even on the same thread. The logging system may provide information to the Message |
| objects and the Messages might be queued for asynchronous delivery. Thus, any modifications to a |
| Message object by an application should by avoided after the Message has been passed as a parameter on |
| a Logger method. |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util"><code>StringBuilderFormattable</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><code><a href="#getParameters()" class="member-name-link">getParameters</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets parameter values, if any.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getThrowable()" class="member-name-link">getThrowable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the throwable, if any.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getFormattedMessage()"> |
| <h3>getFormattedMessage</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFormattedMessage</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>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="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">Gets the format portion of the Message.</div> |
| <dl class="notes"> |
| <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="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">Gets parameter values, if any.</div> |
| <dl class="notes"> |
| <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="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">Gets the throwable, if any.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the throwable or null.</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> |