| <!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 Sun Feb 26 18:46:01 MST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Log4j1XmlLayout (Apache Log4j 1.x Compatibility API 2.8.1 API)</title> |
| <meta name="date" content="2017-02-26"> |
| <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="Log4j1XmlLayout (Apache Log4j 1.x Compatibility API 2.8.1 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/Log4j1XmlLayout.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/layout/Log4j1XmlLayout.html" target="_top">Frames</a></li> |
| <li><a href="Log4j1XmlLayout.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_classes_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested</a> | </li> |
| <li><a href="#fields_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.log4j.layout</div> |
| <h2 title="Class Log4j1XmlLayout" class="title">Class Log4j1XmlLayout</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://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.core.layout.AbstractLayout<<a href="http://docs.oracle.com/javase/7/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.core.layout.AbstractStringLayout</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.log4j.layout.Log4j1XmlLayout</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.logging.log4j.core.Layout<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>, org.apache.logging.log4j.core.layout.Encoder<org.apache.logging.log4j.core.LogEvent>, org.apache.logging.log4j.core.StringLayout</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Plugin(name="Log4j1XmlLayout", |
| category="Core", |
| elementType="layout", |
| printObject=true) |
| public final class <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.41">Log4j1XmlLayout</a> |
| extends org.apache.logging.log4j.core.layout.AbstractStringLayout</pre> |
| <div class="block">Port of XMLLayout in Log4j 1.x. Provided for compatibility with existing Log4j 1 configurations. |
| |
| Originally developed by Ceki Gülcü, Mathias Bogaert.</div> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout</h3> |
| <code>org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder<B extends org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder<B>>, org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer, org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer2</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout</h3> |
| <code>DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractLayout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout</h3> |
| <code>configuration, eventCount, footer, header, LOGGER</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.logging.log4j.core.Layout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.logging.log4j.core.Layout</h3> |
| <code>ELEMENT_TYPE</code></li> |
| </ul> |
| </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"> </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>static <a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html" title="class in org.apache.log4j.layout">Log4j1XmlLayout</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html#createLayout(boolean,%20boolean)">createLayout</a></strong>(boolean locationInfo, |
| boolean properties)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html#encode(org.apache.logging.log4j.core.LogEvent,%20org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a></strong>(org.apache.logging.log4j.core.LogEvent event, |
| org.apache.logging.log4j.core.layout.ByteBufferDestination destination)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html#isLocationInfo()">isLocationInfo</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html#isProperties()">isProperties</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://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/log4j/layout/Log4j1XmlLayout.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">toSerializable</a></strong>(org.apache.logging.log4j.core.LogEvent event)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout</h3> |
| <code>getBytes, getCharset, getContentType, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, serializeToBytes, serializeToString, toByteArray, trimToMaxSize</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractLayout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout</h3> |
| <code>getConfiguration, getContentFormat, markEvent, writeTo</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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://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="http://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="http://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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.logging.log4j.core.Layout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.logging.log4j.core.Layout</h3> |
| <code>getContentFormat</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createLayout(boolean, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createLayout</h4> |
| <pre>@PluginFactory |
| public static <a href="../../../../org/apache/log4j/layout/Log4j1XmlLayout.html" title="class in org.apache.log4j.layout">Log4j1XmlLayout</a> <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.47">createLayout</a>(@PluginAttribute(value="locationInfo") |
| boolean locationInfo, |
| @PluginAttribute(value="properties") |
| boolean properties)</pre> |
| </li> |
| </ul> |
| <a name="isLocationInfo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocationInfo</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.62">isLocationInfo</a>()</pre> |
| </li> |
| </ul> |
| <a name="isProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProperties</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.66">isProperties</a>()</pre> |
| </li> |
| </ul> |
| <a name="encode(org.apache.logging.log4j.core.LogEvent, org.apache.logging.log4j.core.layout.ByteBufferDestination)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.71">encode</a>(org.apache.logging.log4j.core.LogEvent event, |
| org.apache.logging.log4j.core.layout.ByteBufferDestination destination)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>encode</code> in interface <code>org.apache.logging.log4j.core.layout.Encoder<org.apache.logging.log4j.core.LogEvent></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>encode</code> in class <code>org.apache.logging.log4j.core.layout.AbstractLayout<<a href="http://docs.oracle.com/javase/7/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="toSerializable(org.apache.logging.log4j.core.LogEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toSerializable</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/log4j/layout/Log4j1XmlLayout.html#line.78">toSerializable</a>(org.apache.logging.log4j.core.LogEvent event)</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><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/Log4j1XmlLayout.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/layout/Log4j1XmlLayout.html" target="_top">Frames</a></li> |
| <li><a href="Log4j1XmlLayout.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_classes_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested</a> | </li> |
| <li><a href="#fields_inherited_from_class_org.apache.logging.log4j.core.layout.AbstractStringLayout">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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-2017 <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> |
