blob: 5bc2e283d46c7b88e74fec718c81a7253479e4e8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Package org.apache.logging.log4j.core.layout (Apache Log4j Core 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="use: package: org.apache.logging.log4j.core.layout">
<meta name="generator" content="javadoc/PackageUseWriter">
<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="package-use-page">
<script type="text/javascript">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</li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Package org.apache.logging.log4j.core.layout" class="title">Uses of Package<br>org.apache.logging.log4j.core.layout</h1>
</div>
<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.logging.log4j.core.layout</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core">org.apache.logging.log4j.core</a></div>
<div class="col-last even-row-color">
<div class="block">Implementation of Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 Appenders.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.appender.db.jdbc">org.apache.logging.log4j.core.appender.db.jdbc</a></div>
<div class="col-last even-row-color">
<div class="block">The JDBC Appender supports writing log events to a relational database using standard JDBC connections.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.appender.rolling">org.apache.logging.log4j.core.appender.rolling</a></div>
<div class="col-last odd-row-color">
<div class="block">Rolling File Appender and support classes.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Layout support.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.net">org.apache.logging.log4j.core.net</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 network support.</div>
</div>
</div>
<section class="package-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j.core">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="../package-summary.html">org.apache.logging.log4j.core</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/Encoder.html#org.apache.logging.log4j.core">Encoder</a></div>
<div class="col-last even-row-color">
<div class="block">Objects implementing the <code>Encoder</code> interface know how to convert an object to some binary representation and
write the result to a <code>ByteBuffer</code>, ideally without creating temporary objects.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="../appender/package-summary.html">org.apache.logging.log4j.core.appender</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ByteBufferDestination.html#org.apache.logging.log4j.core.appender">ByteBufferDestination</a></div>
<div class="col-last even-row-color">
<div class="block">ByteBufferDestination is the destination that <a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout"><code>Encoder</code></a>s write binary data to.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/LoggerFields.html#org.apache.logging.log4j.core.appender">LoggerFields</a></div>
<div class="col-last odd-row-color">
<div class="block">A LoggerFields container.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender.db.jdbc">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="../appender/db/jdbc/package-summary.html">org.apache.logging.log4j.core.appender.db.jdbc</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/PatternLayout.html#org.apache.logging.log4j.core.appender.db.jdbc">PatternLayout</a></div>
<div class="col-last even-row-color">
<div class="block">A flexible layout configurable with pattern string.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender.rolling">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="../appender/rolling/package-summary.html">org.apache.logging.log4j.core.appender.rolling</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ByteBufferDestination.html#org.apache.logging.log4j.core.appender.rolling">ByteBufferDestination</a></div>
<div class="col-last even-row-color">
<div class="block">ByteBufferDestination is the destination that <a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout"><code>Encoder</code></a>s write binary data to.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.layout">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="package-summary.html">org.apache.logging.log4j.core.layout</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/AbstractCsvLayout.html#org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></div>
<div class="col-last even-row-color">
<div class="block">A superclass for Comma-Separated Value (CSV) layouts.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AbstractLayout.html#org.apache.logging.log4j.core.layout">AbstractLayout</a></div>
<div class="col-last odd-row-color">
<div class="block">Abstract base class for Layouts.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/AbstractLayout.Builder.html#org.apache.logging.log4j.core.layout">AbstractLayout.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">Subclasses can extend this abstract Builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AbstractStringLayout.html#org.apache.logging.log4j.core.layout">AbstractStringLayout</a></div>
<div class="col-last odd-row-color">
<div class="block">Abstract base class for Layouts that result in a String.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/AbstractStringLayout.Builder.html#org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/AbstractStringLayout.Serializer.html#org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/AbstractStringLayout.Serializer2.html#org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></div>
<div class="col-last even-row-color">
<div class="block">Variation of <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout"><code>AbstractStringLayout.Serializer</code></a> that avoids allocating temporary objects.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ByteBufferDestination.html#org.apache.logging.log4j.core.layout">ByteBufferDestination</a></div>
<div class="col-last odd-row-color">
<div class="block">ByteBufferDestination is the destination that <a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout"><code>Encoder</code></a>s write binary data to.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/CsvLogEventLayout.html#org.apache.logging.log4j.core.layout">CsvLogEventLayout</a></div>
<div class="col-last even-row-color">
<div class="block">A Comma-Separated Value (CSV) layout to log events.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/Encoder.html#org.apache.logging.log4j.core.layout">Encoder</a></div>
<div class="col-last odd-row-color">
<div class="block">Objects implementing the <code>Encoder</code> interface know how to convert an object to some binary representation and
write the result to a <code>ByteBuffer</code>, ideally without creating temporary objects.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/GelfLayout.html#org.apache.logging.log4j.core.layout">GelfLayout</a></div>
<div class="col-last even-row-color">
<div class="block">Lays out events in the Graylog Extended Log Format (GELF) 1.1.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/GelfLayout.Builder.html#org.apache.logging.log4j.core.layout">GelfLayout.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/GelfLayout.CompressionType.html#org.apache.logging.log4j.core.layout">GelfLayout.CompressionType</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/HtmlLayout.html#org.apache.logging.log4j.core.layout">HtmlLayout</a></div>
<div class="col-last odd-row-color">
<div class="block">Outputs events as rows in an HTML table on an HTML page.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/HtmlLayout.Builder.html#org.apache.logging.log4j.core.layout">HtmlLayout.Builder</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/HtmlLayout.FontSize.html#org.apache.logging.log4j.core.layout">HtmlLayout.FontSize</a></div>
<div class="col-last odd-row-color">
<div class="block">Possible font sizes</div>
</div>
<div class="col-first even-row-color"><a href="class-use/JsonLayout.html#org.apache.logging.log4j.core.layout">JsonLayout</a></div>
<div class="col-last even-row-color">
<div class="block">Note: The JsonLayout should be considered to be deprecated.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/JsonLayout.Builder.html#org.apache.logging.log4j.core.layout">JsonLayout.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/LevelPatternSelector.html#org.apache.logging.log4j.core.layout">LevelPatternSelector</a></div>
<div class="col-last even-row-color">
<div class="block">Selects the pattern to use based on the Level in the LogEvent.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/LevelPatternSelector.Builder.html#org.apache.logging.log4j.core.layout">LevelPatternSelector.Builder</a></div>
<div class="col-last odd-row-color">
<div class="block">Custom MarkerPatternSelector builder.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/LoggerFields.html#org.apache.logging.log4j.core.layout">LoggerFields</a></div>
<div class="col-last even-row-color">
<div class="block">A LoggerFields container.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MarkerPatternSelector.html#org.apache.logging.log4j.core.layout">MarkerPatternSelector</a></div>
<div class="col-last odd-row-color">
<div class="block">Selects the pattern to use based on the Marker in the LogEvent.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MarkerPatternSelector.Builder.html#org.apache.logging.log4j.core.layout">MarkerPatternSelector.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">Custom MarkerPatternSelector builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/PatternLayout.html#org.apache.logging.log4j.core.layout">PatternLayout</a></div>
<div class="col-last odd-row-color">
<div class="block">A flexible layout configurable with pattern string.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/PatternLayout.Builder.html#org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">Custom PatternLayout builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/PatternLayout.SerializerBuilder.html#org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/PatternMatch.html#org.apache.logging.log4j.core.layout">PatternMatch</a></div>
<div class="col-last even-row-color">
<div class="block">PatternMatch configuration item.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/PatternMatch.Builder.html#org.apache.logging.log4j.core.layout">PatternMatch.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/PatternSelector.html#org.apache.logging.log4j.core.layout">PatternSelector</a></div>
<div class="col-last even-row-color">
<div class="block">Allows different patterns to be used with the PatternLayout based on some selection criteria.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/Rfc5424Layout.html#org.apache.logging.log4j.core.layout">Rfc5424Layout</a></div>
<div class="col-last odd-row-color">
<div class="block">Formats a log event in accordance with RFC 5424.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/Rfc5424Layout.Rfc5424LayoutBuilder.html#org.apache.logging.log4j.core.layout">Rfc5424Layout.Rfc5424LayoutBuilder</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/ScriptPatternSelector.html#org.apache.logging.log4j.core.layout">ScriptPatternSelector</a></div>
<div class="col-last odd-row-color">
<div class="block">Selects the pattern to use based on the result of executing a Script.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ScriptPatternSelector.Builder.html#org.apache.logging.log4j.core.layout">ScriptPatternSelector.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">Custom ScriptPatternSelector builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/SerializedLayout.html#org.apache.logging.log4j.core.layout">SerializedLayout</a></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .</div>
</div>
</div>
<div class="col-first even-row-color"><a href="class-use/SyslogLayout.html#org.apache.logging.log4j.core.layout">SyslogLayout</a></div>
<div class="col-last even-row-color">
<div class="block">Formats a log event as a BSD Log record.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/SyslogLayout.Builder.html#org.apache.logging.log4j.core.layout">SyslogLayout.Builder</a></div>
<div class="col-last odd-row-color">
<div class="block">Builds a SyslogLayout.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/XmlLayout.html#org.apache.logging.log4j.core.layout">XmlLayout</a></div>
<div class="col-last even-row-color">
<div class="block">Appends a series of <code>event</code> elements as defined in the <a href="../../../../../../org/apache/logging/log4j/core/layout/log4j.dtd">log4j.dtd</a>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/XmlLayout.Builder.html#org.apache.logging.log4j.core.layout">XmlLayout.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/YamlLayout.html#org.apache.logging.log4j.core.layout">YamlLayout</a></div>
<div class="col-last even-row-color">
<div class="block">Appends a series of YAML events as strings serialized as bytes.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/YamlLayout.Builder.html#org.apache.logging.log4j.core.layout">YamlLayout.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.net">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.layout</a> used by <a href="../net/package-summary.html">org.apache.logging.log4j.core.net</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/AbstractStringLayout.Serializer.html#org.apache.logging.log4j.core.net">AbstractStringLayout.Serializer</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/ByteBufferDestination.html#org.apache.logging.log4j.core.net">ByteBufferDestination</a></div>
<div class="col-last odd-row-color">
<div class="block">ByteBufferDestination is the destination that <a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout"><code>Encoder</code></a>s write binary data to.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 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>