| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Tue Feb 25 21:00:10 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StructuredDataMessage (Apache Log4j API 2.13.1 API)</title> |
| <meta name="date" content="2020-02-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StructuredDataMessage (Apache Log4j API 2.13.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/message/StructuredDataMessage.html" target="_top">Frames</a></li> |
| <li><a href="StructuredDataMessage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.message</div> |
| <h2 title="Class StructuredDataMessage" class="title">Class StructuredDataMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">org.apache.logging.log4j.message.MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.message.StructuredDataMessage</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/logging/log4j/message/Message.html" title="interface in org.apache.logging.log4j.message">Message</a>, <a href="../../../../../org/apache/logging/log4j/message/MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a>, <a href="../../../../../org/apache/logging/log4j/util/MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a>, <a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/logging/log4j/message/AsynchronouslyFormattable.html" title="annotation in org.apache.logging.log4j.message">@AsynchronouslyFormattable</a> |
| public class <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.37">StructuredDataMessage</a> |
| extends <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></pre> |
| <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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a>, |
| <a href="../../../../../serialized-form.html#org.apache.logging.log4j.message.StructuredDataMessage">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a></span></code> |
| <div class="block">Supported formats.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.logging.log4j.message.MapMessage"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.logging.log4j.message.<a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h3> |
| <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.MapFormat.html" title="enum in org.apache.logging.log4j.message">MapMessage.MapFormat</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage--">StructuredDataMessage</a></span>()</code> |
| <div class="block">Basic constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-">StructuredDataMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, and type (max 32 characters).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-int-">StructuredDataMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| int maxLength)</code> |
| <div class="block">Creates a StructuredDataMessage using an ID (user specified max characters), message, and type (user specified |
| maximum number of characters).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-java.util.Map-">StructuredDataMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data)</code> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-java.util.Map-int-">StructuredDataMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data, |
| int maxLength)</code> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-">StructuredDataMessage</a></span>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-int-">StructuredDataMessage</a></span>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| int maxLength)</code> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-java.util.Map-">StructuredDataMessage</a></span>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data)</code> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-java.util.Map-int-">StructuredDataMessage</a></span>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data, |
| int maxLength)</code> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map |
| of structured data to include.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#asString--">asString</a></span>()</code> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#asString-java.lang.String-">asString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</code> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#asString-org.apache.logging.log4j.message.StructuredDataMessage.Format-org.apache.logging.log4j.message.StructuredDataId-">asString</a></span>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId)</code> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#asString-org.apache.logging.log4j.message.StructuredDataMessage.Format-org.apache.logging.log4j.message.StructuredDataId-java.lang.StringBuilder-">asString</a></span>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> sb)</code> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#formatTo-java.lang.String:A-java.lang.StringBuilder-">formatTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] formats, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buffer)</code> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#formatTo-java.lang.StringBuilder-">formatTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buffer)</code> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getFormat--">getFormat</a></span>()</code> |
| <div class="block">Returns the message.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getFormats--">getFormats</a></span>()</code> |
| <div class="block">Returns the supported formats.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getFormattedMessage--">getFormattedMessage</a></span>()</code> |
| <div class="block">Formats the message and return it.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getFormattedMessage-java.lang.String:A-">getFormattedMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] formats)</code> |
| <div class="block">Formats the message according the the specified format.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns this message id.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#getType--">getType</a></span>()</code> |
| <div class="block">Returns this message type.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#newInstance-java.util.Map-">newInstance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</code> |
| <div class="block">Constructs a new instance based on an existing Map.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#setId-java.lang.String-">setId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code> |
| <div class="block">Sets the id from a String.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#setId-org.apache.logging.log4j.message.StructuredDataId-">setId</a></span>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id)</code> |
| <div class="block">Sets the id.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#setMessageFormat-java.lang.String-">setMessageFormat</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#setType-java.lang.String-">setType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-boolean-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| boolean value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-byte-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| byte value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-char-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| char value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-double-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| double value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-float-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| float value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-int-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| int value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-long-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| long value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-java.lang.Object-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-short-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| short value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validate-java.lang.String-java.lang.String-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Default implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html#validateKey-java.lang.String-">validateKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.message.MapMessage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.message.<a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h3> |
| <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#appendMap-java.lang.StringBuilder-">appendMap</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asJava-java.lang.StringBuilder-">asJava</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asJavaUnquoted-java.lang.StringBuilder-">asJavaUnquoted</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asJson-java.lang.StringBuilder-">asJson</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asXml-java.lang.StringBuilder-">asXml</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#clear--">clear</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#containsKey-java.lang.String-">containsKey</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#forEach-org.apache.logging.log4j.util.BiConsumer-">forEach</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#forEach-org.apache.logging.log4j.util.TriConsumer-S-">forEach</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#get-java.lang.String-">get</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getData--">getData</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getIndexedReadOnlyStringMap--">getIndexedReadOnlyStringMap</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getParameters--">getParameters</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getThrowable--">getThrowable</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#put-java.lang.String-java.lang.String-">put</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#putAll-java.util.Map-">putAll</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#remove-java.lang.String-">remove</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#toKey-java.lang.String-">toKey</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-boolean-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-byte-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-char-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-double-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-float-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-int-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-long-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-java.lang.Object-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-short-">with</a>, <a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#with-java.lang.String-java.lang.String-">with</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.67">StructuredDataMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| <div class="block">Creates a StructuredDataMessage using an ID (max 32 characters), message, and type (max 32 characters).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.80">StructuredDataMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| int maxLength)</pre> |
| <div class="block">Creates a StructuredDataMessage using an ID (user specified max characters), message, and type (user specified |
| maximum number of characters).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.95">StructuredDataMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-java.lang.String-java.lang.String-java.lang.String-java.util.Map-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.110">StructuredDataMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data, |
| int maxLength)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.125">StructuredDataMessage</a>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| <dd><code>msg</code> - The message.</dd> |
| <dd><code>type</code> - The message type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.137">StructuredDataMessage</a>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| int maxLength)</pre> |
| <div class="block">Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.152">StructuredDataMessage</a>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage-org.apache.logging.log4j.message.StructuredDataId-java.lang.String-java.lang.String-java.util.Map-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.167">StructuredDataMessage</a>(<a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> data, |
| int maxLength)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StructuredDataMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StructuredDataMessage</h4> |
| <pre>protected <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.193">StructuredDataMessage</a>()</pre> |
| <div class="block">Basic constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFormats--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormats</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.202">getFormats</a>()</pre> |
| <div class="block">Returns the supported formats.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MultiformatMessage.html#getFormats--">getFormats</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/message/MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getFormats--">getFormats</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An array of the supported format names.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.215">getId</a>()</pre> |
| <div class="block">Returns this message id.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the StructuredDataId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.223">setId</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre> |
| <div class="block">Sets the id from a String. This ID can be at most 32 characters long.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - The String id.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setId-org.apache.logging.log4j.message.StructuredDataId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.231">setId</a>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> id)</pre> |
| <div class="block">Sets the id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - The StructuredDataId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.239">getType</a>()</pre> |
| <div class="block">Returns this message type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.243">setType</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| </li> |
| </ul> |
| <a name="formatTo-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>formatTo</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.251">formatTo</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/logging/log4j/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo-java.lang.StringBuilder-">formatTo</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#formatTo-java.lang.StringBuilder-">formatTo</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the StringBuilder to write into</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="formatTo-java.lang.String:A-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>formatTo</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.256">formatTo</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] formats, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/logging/log4j/util/MultiFormatStringBuilderFormattable.html#formatTo-java.lang.String:A-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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/util/MultiFormatStringBuilderFormattable.html#formatTo-java.lang.String:A-java.lang.StringBuilder-">formatTo</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/util/MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#formatTo-java.lang.String:A-java.lang.StringBuilder-">formatTo</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="getFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormat</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.265">getFormat</a>()</pre> |
| <div class="block">Returns the message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/Message.html#getFormat--">getFormat</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/message/Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getFormat--">getFormat</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMessageFormat-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageFormat</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.269">setMessageFormat</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</pre> |
| </li> |
| </ul> |
| <a name="asString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.279">asString</a>()</pre> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asString--">asString</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.291">asString</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</pre> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#asString-java.lang.String-">asString</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>format</code> - The format identifier. Ignored in this implementation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asString-org.apache.logging.log4j.message.StructuredDataMessage.Format-org.apache.logging.log4j.message.StructuredDataId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asString</h4> |
| <pre>public final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.308">asString</a>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a> structuredDataId)</pre> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>The formatted String.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asString-org.apache.logging.log4j.message.StructuredDataMessage.Format-org.apache.logging.log4j.message.StructuredDataId-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asString</h4> |
| <pre>public final void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.323">asString</a>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message">StructuredDataMessage.Format</a> format, |
| <a href="../../../../../org/apache/logging/log4j/message/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> sb)</pre> |
| <div class="block">Formats the structured data as described in RFC 5424.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="getFormattedMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormattedMessage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.371">getFormattedMessage</a>()</pre> |
| <div class="block">Formats the message and return it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/Message.html#getFormattedMessage--">getFormattedMessage</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/message/Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getFormattedMessage--">getFormattedMessage</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFormattedMessage-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormattedMessage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.385">getFormattedMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] formats)</pre> |
| <div class="block">Formats the message according the the specified format.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MultiformatMessage.html#getFormattedMessage-java.lang.String:A-">getFormattedMessage</a></code> in interface <code><a href="../../../../../org/apache/logging/log4j/message/MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#getFormattedMessage-java.lang.String:A-">getFormattedMessage</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.405">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#toString--">toString</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public <a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a> <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.411">newInstance</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#newInstance-java.util.Map-">newInstance</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - The Map.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new MapMessage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.416">equals</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#equals-java.lang.Object-">equals</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.443">hashCode</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#hashCode--">hashCode</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.452">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| boolean value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-boolean-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-boolean-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-byte-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.460">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| byte value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-byte-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-byte-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.468">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| char value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-char-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-char-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.476">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| double value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-double-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-double-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.484">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| float value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-float-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-float-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.492">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| int value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-int-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-int-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.500">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| long value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-long-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-long-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.508">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-java.lang.Object-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-java.lang.Object-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.516">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| short value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-short-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-short-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.9</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.521">validate</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-java.lang.String-">MapMessage</a></code></span></div> |
| <div class="block">Default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html#validate-java.lang.String-java.lang.String-">validate</a></code> in class <code><a href="../../../../../org/apache/logging/log4j/message/MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a><<a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message">StructuredDataMessage</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateKey-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validateKey</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataMessage.html#line.525">validateKey</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.Format.html" title="enum in org.apache.logging.log4j.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/message/StructuredDataMessage.html" target="_top">Frames</a></li> |
| <li><a href="StructuredDataMessage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
