| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StructuredDataMessage (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: StructuredDataMessage"> |
| <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/StructuredDataMessage.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>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 StructuredDataMessage" class="title">Class StructuredDataMessage</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="MapMessage.html" title="class in org.apache.logging.log4j.message">org.apache.logging.log4j.message.MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>> |
| <div class="inheritance">org.apache.logging.log4j.message.StructuredDataMessage</div> |
| </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="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></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="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="AsynchronouslyFormattable.html" title="annotation in org.apache.logging.log4j.message">@AsynchronouslyFormattable</a> |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">StructuredDataMessage</span> |
| <span class="extends-implements">extends <a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></span></div> |
| <div class="block">Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message. |
| <p> |
| Thread-safety note: the contents of this message can be modified after construction. |
| When using asynchronous loggers and appenders it is not recommended to modify this message after the message is |
| logged, because it is undefined whether the logged message string will contain the old values or the modified |
| values. |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.logging.log4j.message.StructuredDataMessage">Serialized Form</a></li> |
| </ul> |
| </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="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="StructuredDataMessage.Format.html" class="type-name-link" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Supported formats.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.message.MapMessage">Nested classes/interfaces inherited from class org.apache.logging.log4j.message.<a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h2> |
| <code><a href="MapMessage.MapFormat.html" title="enum in org.apache.logging.log4j.message">MapMessage.MapFormat</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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">StructuredDataMessage</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Basic constructor.</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, and type (max 32 characters).</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,int)" class="member-name-link">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| int maxLength)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a StructuredDataMessage using an ID (user specified max characters), message, and type (user specified |
| maximum number of characters).</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.util.Map)" class="member-name-link">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, type (max 32 characters), and an |
| initial map of structured data to include.</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.util.Map,int)" class="member-name-link">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data, |
| int maxLength)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a StructuredDataMessage using an (user specified max characters), message, and type (user specified |
| maximum number of characters, and an initial map of structured data to include.</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String)" class="member-name-link">StructuredDataMessage</a><wbr>(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,int)" class="member-name-link">StructuredDataMessage</a><wbr>(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| int maxLength)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,java.util.Map)" class="member-name-link">StructuredDataMessage</a><wbr>(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,java.util.Map,int)" class="member-name-link">StructuredDataMessage</a><wbr>(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data, |
| int maxLength)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| </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><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="#asString()" class="member-name-link">asString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the structured data as described in RFC 5424.</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="#asString(java.lang.String)" class="member-name-link">asString</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> format)</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 structured data as described in RFC 5424.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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="#asString(org.apache.logging.log4j.message.StructuredDataMessage.Format,org.apache.logging.log4j.message.StructuredDataId)" class="member-name-link">asString</a><wbr>(<a href="StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#asString(org.apache.logging.log4j.message.StructuredDataMessage.Format,org.apache.logging.log4j.message.StructuredDataId,java.lang.StringBuilder)" class="member-name-link">asString</a><wbr>(<a href="StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId, |
| <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> sb)</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 structured data as described in RFC 5424.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</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> o)</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="#formatTo(java.lang.String%5B%5D,java.lang.StringBuilder)" class="member-name-link">formatTo</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>[] formats, |
| <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>void</code></div> |
| <div class="col-second even-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 even-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 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="#getFormat()" class="member-name-link">getFormat</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the message.</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="#getFormats()" class="member-name-link">getFormats</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 the supported formats.</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">Formats the message and return it.</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="#getFormattedMessage(java.lang.String%5B%5D)" class="member-name-link">getFormattedMessage</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>[] formats)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the message according to the specified format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns this message id.</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="#getType()" class="member-name-link">getType</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 this message type.</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="#hashCode()" class="member-name-link">hashCode</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="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newInstance(java.util.Map)" class="member-name-link">newInstance</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> map)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constructs a new instance based on an existing Map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setId(java.lang.String)" class="member-name-link">setId</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> id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the id from a String.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setId(org.apache.logging.log4j.message.StructuredDataId)" class="member-name-link">setId</a><wbr>(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMessageFormat(java.lang.String)" class="member-name-link">setMessageFormat</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> msg)</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setType(java.lang.String)" class="member-name-link">setType</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> type)</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/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="#toString()" class="member-name-link">toString</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,boolean)" class="member-name-link">validate</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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,byte)" class="member-name-link">validate</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> key, |
| byte value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,char)" class="member-name-link">validate</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> key, |
| char value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,double)" class="member-name-link">validate</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> key, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,float)" class="member-name-link">validate</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> key, |
| float value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,int)" class="member-name-link">validate</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> key, |
| int value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,long)" class="member-name-link">validate</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> key, |
| long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,short)" class="member-name-link">validate</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> key, |
| short value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,java.lang.Object)" class="member-name-link">validate</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> key, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.lang.String,java.lang.String)" class="member-name-link">validate</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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Default implementation does nothing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateKey(java.lang.String)" class="member-name-link">validateKey</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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.message.MapMessage">Methods inherited from class org.apache.logging.log4j.message.<a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h3> |
| <code><a href="MapMessage.html#appendMap(java.lang.StringBuilder)">appendMap</a>, <a href="MapMessage.html#asJava(java.lang.StringBuilder)">asJava</a>, <a href="MapMessage.html#asJavaUnquoted(java.lang.StringBuilder)">asJavaUnquoted</a>, <a href="MapMessage.html#asJson(java.lang.StringBuilder)">asJson</a>, <a href="MapMessage.html#asXml(java.lang.StringBuilder)">asXml</a>, <a href="MapMessage.html#clear()">clear</a>, <a href="MapMessage.html#containsKey(java.lang.String)">containsKey</a>, <a href="MapMessage.html#forEach(org.apache.logging.log4j.util.BiConsumer)">forEach</a>, <a href="MapMessage.html#forEach(org.apache.logging.log4j.util.TriConsumer,S)">forEach</a>, <a href="MapMessage.html#get(java.lang.String)">get</a>, <a href="MapMessage.html#getData()">getData</a>, <a href="MapMessage.html#getIndexedReadOnlyStringMap()">getIndexedReadOnlyStringMap</a>, <a href="MapMessage.html#getParameters()">getParameters</a>, <a href="MapMessage.html#getThrowable()">getThrowable</a>, <a href="MapMessage.html#put(java.lang.String,java.lang.String)">put</a>, <a href="MapMessage.html#putAll(java.util.Map)">putAll</a>, <a href="MapMessage.html#remove(java.lang.String)">remove</a>, <a href="MapMessage.html#toKey(java.lang.String)">toKey</a>, <a href="MapMessage.html#with(java.lang.String,boolean)">with</a>, <a href="MapMessage.html#with(java.lang.String,byte)">with</a>, <a href="MapMessage.html#with(java.lang.String,char)">with</a>, <a href="MapMessage.html#with(java.lang.String,double)">with</a>, <a href="MapMessage.html#with(java.lang.String,float)">with</a>, <a href="MapMessage.html#with(java.lang.String,int)">with</a>, <a href="MapMessage.html#with(java.lang.String,long)">with</a>, <a href="MapMessage.html#with(java.lang.String,short)">with</a>, <a href="MapMessage.html#with(java.lang.String,java.lang.Object)">with</a>, <a href="MapMessage.html#with(java.lang.String,java.lang.String)">with</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#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#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#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> |
| </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>(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type)</span></div> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, and type (max 32 characters).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The String id.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String,int)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| int maxLength)</span></div> |
| <div class="block">Creates a StructuredDataMessage using an ID (user specified max characters), message, and type (user specified |
| maximum number of characters).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The String id.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>maxLength</code> - The maximum length of keys;</dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String,java.util.Map)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data)</span></div> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, type (max 32 characters), and an |
| initial map of structured data to include.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The String id.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>data</code> - The StructuredData map.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String,java.util.Map,int)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</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> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data, |
| int maxLength)</span></div> |
| <div class="block">Creates a StructuredDataMessage using an (user specified max characters), message, and type (user specified |
| maximum number of characters, and an initial map of structured data to include.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The String id.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>data</code> - The StructuredData map.</dd> |
| <dd><code>maxLength</code> - The maximum length of keys;</dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</span><wbr><span class="parameters">(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type)</span></div> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,int)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</span><wbr><span class="parameters">(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| int maxLength)</span></div> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>maxLength</code> - The maximum length of keys;</dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,java.util.Map)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</span><wbr><span class="parameters">(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data)</span></div> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>data</code> - The StructuredData map.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.message.StructuredDataId,java.lang.String,java.lang.String,java.util.Map,int)"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StructuredDataMessage</span><wbr><span class="parameters">(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id, |
| <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> msg, |
| <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> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> data, |
| int maxLength)</span></div> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| <dd><code>data</code> - The StructuredData map.</dd> |
| <dd><code>maxLength</code> - The maximum length of keys;</dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>StructuredDataMessage</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">StructuredDataMessage</span>()</div> |
| <div class="block">Basic constructor.</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="getFormats()"> |
| <h3>getFormats</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">getFormats</span>()</div> |
| <div class="block">Returns the supported formats.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="MultiformatMessage.html#getFormats()">getFormats</a></code> in interface <code><a href="MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#getFormats()">getFormats</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Returns:</dt> |
| <dd>An array of the supported format names.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getId()"> |
| <h3>getId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a></span> <span class="element-name">getId</span>()</div> |
| <div class="block">Returns this message id.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the StructuredDataId.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setId(java.lang.String)"> |
| <h3>setId</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setId</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> id)</span></div> |
| <div class="block">Sets the id from a String. This ID can be at most 32 characters long.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The String id.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setId(org.apache.logging.log4j.message.StructuredDataId)"> |
| <h3>setId</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setId</span><wbr><span class="parameters">(<a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id)</span></div> |
| <div class="block">Sets the id.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType()"> |
| <h3>getType</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">getType</span>()</div> |
| <div class="block">Returns this message type.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setType(java.lang.String)"> |
| <h3>setType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setType</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> type)</span></div> |
| </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>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#formatTo(java.lang.StringBuilder)">formatTo</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the StringBuilder to write into</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(java.lang.String[],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/String.html" title="class or interface in java.lang" class="external-link">String</a>[] formats, |
| <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/MultiFormatStringBuilderFormattable.html#formatTo(java.lang.String%5B%5D,java.lang.StringBuilder)">MultiFormatStringBuilderFormattable</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/MultiFormatStringBuilderFormattable.html#formatTo(java.lang.String%5B%5D,java.lang.StringBuilder)">formatTo</a></code> in interface <code><a href="../util/MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#formatTo(java.lang.String%5B%5D,java.lang.StringBuilder)">formatTo</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>formats</code> - An array of Strings that provide extra information about how to format the message. |
| Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose.</dd> |
| <dd><code>buffer</code> - the StringBuilder to write into</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">Returns 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>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#getFormat()">getFormat</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMessageFormat(java.lang.String)"> |
| <h3>setMessageFormat</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setMessageFormat</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> msg)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asString()"> |
| <h3>asString</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">asString</span>()</div> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#asString()">asString</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Returns:</dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asString(java.lang.String)"> |
| <h3>asString</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">asString</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> format)</span></div> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#asString(java.lang.String)">asString</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>format</code> - The format identifier. Ignored in this implementation.</dd> |
| <dt>Returns:</dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asString(org.apache.logging.log4j.message.StructuredDataMessage.Format,org.apache.logging.log4j.message.StructuredDataId)"> |
| <h3>asString</h3> |
| <div class="member-signature"><span class="modifiers">public final</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">asString</span><wbr><span class="parameters">(<a href="StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId)</span></div> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>format</code> - "full" will include the type and message. null will return only the STRUCTURED-DATA as |
| described in RFC 5424</dd> |
| <dd><code>structuredDataId</code> - The SD-ID as described in RFC 5424. If null the value in the StructuredData |
| will be used.</dd> |
| <dt>Returns:</dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asString(org.apache.logging.log4j.message.StructuredDataMessage.Format,org.apache.logging.log4j.message.StructuredDataId,java.lang.StringBuilder)"> |
| <h3>asString</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">asString</span><wbr><span class="parameters">(<a href="StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId, |
| <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> sb)</span></div> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>format</code> - "full" will include the type and message. null will return only the STRUCTURED-DATA as |
| described in RFC 5424</dd> |
| <dd><code>structuredDataId</code> - The SD-ID as described in RFC 5424. If null the value in the StructuredData |
| will be used.</dd> |
| <dd><code>sb</code> - The StringBuilder to append the formatted message to.</dd> |
| </dl> |
| </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">Formats the message and return it.</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>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#getFormattedMessage()">getFormattedMessage</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the formatted message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFormattedMessage(java.lang.String[])"> |
| <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><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>[] formats)</span></div> |
| <div class="block">Formats the message according to the specified format.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="MultiformatMessage.html#getFormattedMessage(java.lang.String%5B%5D)">getFormattedMessage</a></code> in interface <code><a href="MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#getFormattedMessage(java.lang.String%5B%5D)">getFormattedMessage</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>formats</code> - An array of Strings that provide extra information about how to format the message. |
| StructuredDataMessage accepts only a format of "FULL" which will cause the event type to be |
| prepended and the event message to be appended. Specifying any other value will cause only the |
| StructuredData to be included. The default is "FULL".</dd> |
| <dt>Returns:</dt> |
| <dd>the formatted message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#toString()">toString</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newInstance(java.util.Map)"> |
| <h3>newInstance</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a></span> <span class="element-name">newInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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>> map)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#newInstance(java.util.Map)">MapMessage</a></code></span></div> |
| <div class="block">Constructs a new instance based on an existing Map.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#newInstance(java.util.Map)">newInstance</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>map</code> - The Map.</dd> |
| <dt>Returns:</dt> |
| <dd>A new MapMessage</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</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> o)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#hashCode()">hashCode</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,boolean)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| boolean value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,boolean)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,boolean)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,byte)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| byte value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,byte)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,byte)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,char)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| char value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,char)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,char)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,double)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| double value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,double)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,double)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,float)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| float value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,float)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,float)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,int)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| int value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,int)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,int)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,long)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| long value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,long)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,long)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,java.lang.Object)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| <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> value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,java.lang.Object)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,java.lang.Object)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,short)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| short value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,short)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,short)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| <dt>Since:</dt> |
| <dd>2.9</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.lang.String,java.lang.String)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validate</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> key, |
| <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> value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="MapMessage.html#validate(java.lang.String,java.lang.String)">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapMessage.html#validate(java.lang.String,java.lang.String)">validate</a></code> in class <code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</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>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateKey(java.lang.String)"> |
| <h3>validateKey</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validateKey</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> key)</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> |
