Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.11.0 / log4j-api / apidocs / org / apache / logging / log4j / message / StructuredDataId.html
blob: c7d0f98c0d61237c721a25fa7e17538c7d202b7f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Sat Mar 17 16:07:26 MST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StructuredDataId (Apache Log4j API 2.11.0 API)</title>
<meta name="date" content="2018-03-17">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StructuredDataId (Apache Log4j API 2.11.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/StructuredDataId.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/StructuredDataCollectionMessage.html" title="class in org.apache.logging.log4j.message"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/logging/log4j/message/StructuredDataId.html" target="_top">Frames</a></li>
<li><a href="StructuredDataId.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.message</div>
<h2 title="Class StructuredDataId" class="title">Class StructuredDataId</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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>org.apache.logging.log4j.message.StructuredDataId</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/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</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>public class <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.27">StructuredDataId</a>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></pre>
<div class="block">The StructuredData identifier.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.logging.log4j.message.StructuredDataId">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#META">META</a></strong></code>
<div class="block">RFC 5424 Meta.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#ORIGIN">ORIGIN</a></strong></code>
<div class="block">RFC 5424 Origin.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#RESERVED">RESERVED</a></strong></code>
<div class="block">Reserved enterprise number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#TIME_QUALITY">TIME_QUALITY</a></strong></code>
<div class="block">RFC 5424 Time Quality.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String)">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Creates a StructuredDataId based on the name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String,%20int)">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;maxLength)</code>
<div class="block">Creates a StructuredDataId based on the name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String,%20int,%20java.lang.String[],%20java.lang.String[])">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;enterpriseNumber,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional)</code>
<div class="block">A Constructor that helps conformance to RFC 5424.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String,%20int,%20java.lang.String[],%20java.lang.String[],%20int)">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;enterpriseNumber,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional,
int&nbsp;maxLength)</code>
<div class="block">A Constructor that helps conformance to RFC 5424.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String,%20java.lang.String[],%20java.lang.String[])">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#StructuredDataId(java.lang.String,%20java.lang.String[],%20java.lang.String[],%20int)">StructuredDataId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional,
int&nbsp;maxLength)</code>
<div class="block">A Constructor that helps conformance to RFC 5424.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#formatTo(java.lang.StringBuilder)">formatTo</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;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 class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#getEnterpriseNumber()">getEnterpriseNumber</a></strong>()</code>
<div class="block">Returns the enterprise number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the StructuredDataId name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#getOptional()">getOptional</a></strong>()</code>
<div class="block">Returns a list of optional keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#getRequired()">getRequired</a></strong>()</code>
<div class="block">Returns a list of required keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#isReserved()">isReserved</a></strong>()</code>
<div class="block">Indicates if the id is reserved.</div>
</td>
</tr>
<tr class="altColor">
<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><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#makeId(java.lang.String,%20int)">makeId</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultId,
int&nbsp;anEnterpriseNumber)</code>
<div class="block">Creates an id based on the current id.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#makeId(org.apache.logging.log4j.message.StructuredDataId)">makeId</a></strong>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a>&nbsp;id)</code>
<div class="block">Creates an id using another id to supply default values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TIME_QUALITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TIME_QUALITY</h4>
<pre>public static final&nbsp;<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/StructuredDataId.html#line.32">TIME_QUALITY</a></pre>
<div class="block">RFC 5424 Time Quality.</div>
</li>
</ul>
<a name="ORIGIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ORIGIN</h4>
<pre>public static final&nbsp;<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/StructuredDataId.html#line.38">ORIGIN</a></pre>
<div class="block">RFC 5424 Origin.</div>
</li>
</ul>
<a name="META">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>META</h4>
<pre>public static final&nbsp;<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/StructuredDataId.html#line.44">META</a></pre>
<div class="block">RFC 5424 Meta.</div>
</li>
</ul>
<a name="RESERVED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RESERVED</h4>
<pre>public static final&nbsp;int <a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.50">RESERVED</a></pre>
<div class="block">Reserved enterprise number.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.logging.log4j.message.StructuredDataId.RESERVED">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StructuredDataId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.66">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Creates a StructuredDataId based on the name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The Structured Data Element name (maximum length is 32)</dd><dt><span class="strong">Since:</span></dt>
<dd>2.9</dd></dl>
</li>
</ul>
<a name="StructuredDataId(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.76">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;maxLength)</pre>
<div class="block">Creates a StructuredDataId based on the name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The Structured Data Element name.</dd><dd><code>maxLength</code> - The maximum length of the name.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.9</dd></dl>
</li>
</ul>
<a name="StructuredDataId(java.lang.String, java.lang.String[], java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.86">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd><dd><code>required</code> - </dd><dd><code>optional</code> - </dd></dl>
</li>
</ul>
<a name="StructuredDataId(java.lang.String, java.lang.String[], java.lang.String[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.98">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional,
int&nbsp;maxLength)</pre>
<div class="block">A Constructor that helps conformance to RFC 5424.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name portion of the id.</dd><dd><code>required</code> - The list of keys that are required for this id.</dd><dd><code>optional</code> - The list of keys that are optional for this id.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.9</dd></dl>
</li>
</ul>
<a name="StructuredDataId(java.lang.String, int, java.lang.String[], java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.128">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;enterpriseNumber,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional)</pre>
<div class="block">A Constructor that helps conformance to RFC 5424.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name portion of the id.</dd><dd><code>enterpriseNumber</code> - The enterprise number.</dd><dd><code>required</code> - The list of keys that are required for this id.</dd><dd><code>optional</code> - The list of keys that are optional for this id.</dd></dl>
</li>
</ul>
<a name="StructuredDataId(java.lang.String, int, java.lang.String[], java.lang.String[], int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StructuredDataId</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.143">StructuredDataId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;enterpriseNumber,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;required,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;optional,
int&nbsp;maxLength)</pre>
<div class="block">A Constructor that helps conformance to RFC 5424.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name portion of the id.</dd><dd><code>enterpriseNumber</code> - The enterprise number.</dd><dd><code>required</code> - The list of keys that are required for this id.</dd><dd><code>optional</code> - The list of keys that are optional for this id.</dd><dd><code>maxLength</code> - The maximum length of the StructuredData Id key.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.9</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="makeId(org.apache.logging.log4j.message.StructuredDataId)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a>&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.170">makeId</a>(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a>&nbsp;id)</pre>
<div class="block">Creates an id using another id to supply default values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The original StructuredDataId.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new StructuredDataId.</dd></dl>
</li>
</ul>
<a name="makeId(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html" title="class in org.apache.logging.log4j.message">StructuredDataId</a>&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.184">makeId</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultId,
int&nbsp;anEnterpriseNumber)</pre>
<div class="block">Creates an id based on the current id.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultId</code> - The default id to use if this StructuredDataId doesn't have a name.</dd><dd><code>anEnterpriseNumber</code> - The enterprise number.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a StructuredDataId.</dd></dl>
</li>
</ul>
<a name="getRequired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequired</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.209">getRequired</a>()</pre>
<div class="block">Returns a list of required keys.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a List of required keys or null if none have been provided.</dd></dl>
</li>
</ul>
<a name="getOptional()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptional</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.218">getOptional</a>()</pre>
<div class="block">Returns a list of optional keys.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a List of optional keys or null if none have been provided.</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.227">getName</a>()</pre>
<div class="block">Returns the StructuredDataId name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the StructuredDataId name.</dd></dl>
</li>
</ul>
<a name="getEnterpriseNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnterpriseNumber</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.236">getEnterpriseNumber</a>()</pre>
<div class="block">Returns the enterprise number.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the enterprise number.</dd></dl>
</li>
</ul>
<a name="isReserved()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReserved</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.245">isReserved</a>()</pre>
<div class="block">Indicates if the id is reserved.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the id uses the reserved enterprise number, false otherwise.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.250">toString</a>()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="formatTo(java.lang.StringBuilder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>formatTo</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/logging/log4j/message/StructuredDataId.html#line.257">formatTo</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buffer)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">StringBuilderFormattable</a></code></strong></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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">formatTo</a></code>&nbsp;in interface&nbsp;<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="strong">Parameters:</span></dt><dd><code>buffer</code> - the StringBuilder to write into</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/StructuredDataId.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/StructuredDataCollectionMessage.html" title="class in org.apache.logging.log4j.message"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/logging/log4j/message/StructuredDataMessage.html" title="class in org.apache.logging.log4j.message"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/logging/log4j/message/StructuredDataId.html" target="_top">Frames</a></li>
<li><a href="StructuredDataId.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2018 <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>