| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MarkerManager.Log4jMarker (Apache Log4j API 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j, class: MarkerManager, class: Log4jMarker"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/MarkerManager.Log4jMarker.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j</a></div> |
| <h1 title="Class MarkerManager.Log4jMarker" class="title">Class MarkerManager.Log4jMarker</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.logging.log4j.MarkerManager.Log4jMarker</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code>, <code><a href="util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="MarkerManager.html" title="class in org.apache.logging.log4j">MarkerManager</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">MarkerManager.Log4jMarker</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>, <a href="util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></span></div> |
| <div class="block"><em>Consider this class private, it is only public to satisfy Jackson for XML and JSON IO.</em> |
| <p> |
| The actual Marker implementation. |
| </p> |
| <p> |
| <em>Internal note: We could make this class package private instead of public if the class |
| <code>org.apache.logging.log4j.core.jackson.MarkerMixIn</code> |
| is moved to this package and would of course stay in its current module.</em> |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.logging.log4j.MarkerManager.Log4jMarker">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">Log4jMarker</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new Marker.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addParents(org.apache.logging.log4j.Marker...)" class="member-name-link">addParents</a><wbr>(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>... parentMarkers)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a Marker as a parent to this Marker.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if the given marker has the same name as this marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(java.lang.StringBuilder)" class="member-name-link">formatTo</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of this Marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParents()" class="member-name-link">getParents</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list of parents of this Marker.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a hash code value based on the name of this marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasParents()" class="member-name-link">hasParents</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates whether this Marker has references to any other Markers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInstanceOf(java.lang.String)" class="member-name-link">isInstanceOf</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> markerName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks whether this Marker is an instance of the specified Marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInstanceOf(org.apache.logging.log4j.Marker)" class="member-name-link">isInstanceOf</a><wbr>(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a> marker)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks whether this Marker is an instance of the specified Marker.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(org.apache.logging.log4j.Marker)" class="member-name-link">remove</a><wbr>(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a> parent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes the specified Marker as a parent of this Marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setParents(org.apache.logging.log4j.Marker...)" class="member-name-link">setParents</a><wbr>(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>... markers)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces the set of parent Markers with the provided Markers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String)"> |
| <h3>Log4jMarker</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Log4jMarker</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Constructs a new Marker.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the Marker.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the argument is <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addParents(org.apache.logging.log4j.Marker...)"> |
| <h3>addParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></span> <span class="element-name">addParents</span><wbr><span class="parameters">(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>... parentMarkers)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#addParents(org.apache.logging.log4j.Marker...)">Marker</a></code></span></div> |
| <div class="block">Adds a Marker as a parent to this Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#addParents(org.apache.logging.log4j.Marker...)">addParents</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>parentMarkers</code> - The parent markers to add.</dd> |
| <dt>Returns:</dt> |
| <dd>The current Marker object, thus allowing multiple adds to be concatenated.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(org.apache.logging.log4j.Marker)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">remove</span><wbr><span class="parameters">(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a> parent)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#remove(org.apache.logging.log4j.Marker)">Marker</a></code></span></div> |
| <div class="block">Removes the specified Marker as a parent of this Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#remove(org.apache.logging.log4j.Marker)">remove</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>parent</code> - The marker to remove.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the marker was removed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParents(org.apache.logging.log4j.Marker...)"> |
| <h3>setParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></span> <span class="element-name">setParents</span><wbr><span class="parameters">(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>... markers)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#setParents(org.apache.logging.log4j.Marker...)">Marker</a></code></span></div> |
| <div class="block">Replaces the set of parent Markers with the provided Markers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#setParents(org.apache.logging.log4j.Marker...)">setParents</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>markers</code> - The new set of parent Markers or <code>null</code> to clear the parents.</dd> |
| <dt>Returns:</dt> |
| <dd>The current Marker object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#getName()">Marker</a></code></span></div> |
| <div class="block">Returns the name of this Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#getName()">getName</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The name of the Marker.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParents()"> |
| <h3>getParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a>[]</span> <span class="element-name">getParents</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#getParents()">Marker</a></code></span></div> |
| <div class="block">Returns a list of parents of this Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#getParents()">getParents</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The parent Markers or <code>null</code> if this Marker has no parents.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasParents()"> |
| <h3>hasParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasParents</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#hasParents()">Marker</a></code></span></div> |
| <div class="block">Indicates whether this Marker has references to any other Markers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#hasParents()">hasParents</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the Marker has parent Markers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInstanceOf(org.apache.logging.log4j.Marker)"> |
| <h3>isInstanceOf</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isInstanceOf</span><wbr><span class="parameters">(<a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a> marker)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#isInstanceOf(org.apache.logging.log4j.Marker)">Marker</a></code></span></div> |
| <div class="block">Checks whether this Marker is an instance of the specified Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#isInstanceOf(org.apache.logging.log4j.Marker)">isInstanceOf</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>marker</code> - The Marker to check.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this Marker or one of its ancestors is the specified Marker, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInstanceOf(java.lang.String)"> |
| <h3>isInstanceOf</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isInstanceOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> markerName)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#isInstanceOf(java.lang.String)">Marker</a></code></span></div> |
| <div class="block">Checks whether this Marker is an instance of the specified Marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#isInstanceOf(java.lang.String)">isInstanceOf</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>markerName</code> - The name of the Marker.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this Marker or one of its ancestors matches the specified name, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#equals(java.lang.Object)">Marker</a></code></span></div> |
| <div class="block">Returns true if the given marker has the same name as this marker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>o</code> - the reference object with which to compare.</dd> |
| <dt>Returns:</dt> |
| <dd>true if the given marker has the same name as this marker.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Marker.html#hashCode()">Marker</a></code></span></div> |
| <div class="block">Returns a hash code value based on the name of this marker. Markers are equal if they have the same name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Marker.html#hashCode()">hashCode</a></code> in interface <code><a href="Marker.html" title="interface in org.apache.logging.log4j">Marker</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the computed hash code</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(java.lang.StringBuilder)"> |
| <h3>formatTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">formatTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">StringBuilderFormattable</a></code></span></div> |
| <div class="block">Writes a text representation of this object into the specified <code>StringBuilder</code>, ideally without allocating |
| temporary objects.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)">formatTo</a></code> in interface <code><a href="util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sb</code> - the StringBuilder to write into</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |