blob: 18bf63ab9458a38b65cacfbc2a8717f6b03b53c2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Package org.apache.logging.log4j.message (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="use: package: org.apache.logging.log4j.message">
<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.message" class="title">Uses of Package<br>org.apache.logging.log4j.message</h1>
</div>
<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.logging.log4j.message</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">org.apache.logging.log4j</a></div>
<div class="col-last even-row-color">
<div class="block">Public API for Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.message">org.apache.logging.log4j.message</a></div>
<div class="col-last odd-row-color">
<div class="block">Public Message Types used for Log4j 2.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.simple">org.apache.logging.log4j.simple</a></div>
<div class="col-last even-row-color">
<div class="block">Simple logging implementation.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.spi">org.apache.logging.log4j.spi</a></div>
<div class="col-last odd-row-color">
<div class="block">Internal interfaces and classes to be used by authors of logging implementations or for internal use by
API classes.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.status">org.apache.logging.log4j.status</a></div>
<div class="col-last even-row-color">
<div class="block">Status API for Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.util">org.apache.logging.log4j.util</a></div>
<div class="col-last odd-row-color">
<div class="block">Internal utility classes for the Log4j 2 API.</div>
</div>
</div>
<section class="package-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="../package-summary.html">org.apache.logging.log4j</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/EntryMessage.html#org.apache.logging.log4j">EntryMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Entry flow messages</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/FlowMessageFactory.html#org.apache.logging.log4j">FlowMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates flow messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/Message.html#org.apache.logging.log4j">Message</a></div>
<div class="col-last even-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/StructuredDataMessage.html#org.apache.logging.log4j">StructuredDataMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.message">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="package-summary.html">org.apache.logging.log4j.message</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/AbstractMessageFactory.html#org.apache.logging.log4j.message">AbstractMessageFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Provides an abstract superclass for <a href="MessageFactory2.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory2</code></a> implementations with default implementations (and for
<a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> by extension).</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsynchronouslyFormattable.html#org.apache.logging.log4j.message">AsynchronouslyFormattable</a></div>
<div class="col-last odd-row-color">
<div class="block">Annotation that signals to asynchronous logging components that messages of this type can safely be passed to
a background thread without calling <a href="Message.html#getFormattedMessage()"><code>Message.getFormattedMessage()</code></a> first.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/EntryMessage.html#org.apache.logging.log4j.message">EntryMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Entry flow messages</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ExitMessage.html#org.apache.logging.log4j.message">ExitMessage</a></div>
<div class="col-last odd-row-color">
<div class="block">Exit flow messages</div>
</div>
<div class="col-first even-row-color"><a href="class-use/FlowMessage.html#org.apache.logging.log4j.message">FlowMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Flow messages</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/FlowMessageFactory.html#org.apache.logging.log4j.message">FlowMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates flow messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/LoggerNameAwareMessage.html#org.apache.logging.log4j.message">LoggerNameAwareMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Message that is interested in the name of the Logger.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MapMessage.html#org.apache.logging.log4j.message">MapMessage</a></div>
<div class="col-last odd-row-color">
<div class="block">Represents a Message that consists of a Map.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MapMessage.MapFormat.html#org.apache.logging.log4j.message">MapMessage.MapFormat</a></div>
<div class="col-last even-row-color">
<div class="block">When set as the format specifier causes the Map to be formatted as XML.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/Message.html#org.apache.logging.log4j.message">Message</a></div>
<div class="col-last odd-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MessageCollectionMessage.html#org.apache.logging.log4j.message">MessageCollectionMessage</a></div>
<div class="col-last even-row-color">
<div class="block">A Message that is a collection of Messages.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j.message">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MessageFactory2.html#org.apache.logging.log4j.message">MessageFactory2</a></div>
<div class="col-last even-row-color">
<div class="block">Creates messages.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MultiformatMessage.html#org.apache.logging.log4j.message">MultiformatMessage</a></div>
<div class="col-last odd-row-color">
<div class="block">A Message that can render itself in more than one way.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ParameterConsumer.html#org.apache.logging.log4j.message">ParameterConsumer</a></div>
<div class="col-last even-row-color">
<div class="block">An operation that accepts two input arguments and returns no result.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ParameterizedMessageFactory.html#org.apache.logging.log4j.message">ParameterizedMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates <a href="FormattedMessage.html" title="class in org.apache.logging.log4j.message"><code>FormattedMessage</code></a> instances for <a href="MessageFactory2.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory2</code></a> methods (and <a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> by
extension.)</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ParameterizedNoReferenceMessageFactory.html#org.apache.logging.log4j.message">ParameterizedNoReferenceMessageFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Creates <a href="FormattedMessage.html" title="class in org.apache.logging.log4j.message"><code>FormattedMessage</code></a> instances for <a href="MessageFactory2.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory2</code></a> methods (and <a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> by
extension.)</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ParameterVisitable.html#org.apache.logging.log4j.message">ParameterVisitable</a></div>
<div class="col-last odd-row-color">
<div class="block">Allows message parameters to be iterated over without any allocation
or memory copies.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ReusableMessage.html#org.apache.logging.log4j.message">ReusableMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Messages implementing this interface are reused between logging calls.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ReusableMessageFactory.html#org.apache.logging.log4j.message">ReusableMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Implementation of the <a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> interface that avoids allocating temporary objects where possible.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/SimpleMessageFactory.html#org.apache.logging.log4j.message">SimpleMessageFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Creates <a href="FormattedMessage.html" title="class in org.apache.logging.log4j.message"><code>FormattedMessage</code></a> instances for <a href="MessageFactory2.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory2</code></a> methods (and <a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> by
extension.)</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/StringFormatterMessageFactory.html#org.apache.logging.log4j.message">StringFormatterMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates <a href="FormattedMessage.html" title="class in org.apache.logging.log4j.message"><code>FormattedMessage</code></a> instances for <a href="MessageFactory2.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory2</code></a> methods (and <a href="MessageFactory.html" title="interface in org.apache.logging.log4j.message"><code>MessageFactory</code></a> by
extension.)</div>
</div>
<div class="col-first even-row-color"><a href="class-use/StringMapMessage.html#org.apache.logging.log4j.message">StringMapMessage</a></div>
<div class="col-last even-row-color">
<div class="block">A <a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message"><code>StringMapMessage</code></a> typed to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>-only values.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/StructuredDataId.html#org.apache.logging.log4j.message">StructuredDataId</a></div>
<div class="col-last odd-row-color">
<div class="block">The StructuredData identifier.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/StructuredDataMessage.html#org.apache.logging.log4j.message">StructuredDataMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/StructuredDataMessage.Format.html#org.apache.logging.log4j.message">StructuredDataMessage.Format</a></div>
<div class="col-last odd-row-color">
<div class="block">Supported formats.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ThreadInformation.html#org.apache.logging.log4j.message">ThreadInformation</a></div>
<div class="col-last even-row-color">
<div class="block">Interface used to print basic or extended thread information.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.simple">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="../simple/package-summary.html">org.apache.logging.log4j.simple</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/Message.html#org.apache.logging.log4j.simple">Message</a></div>
<div class="col-last even-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j.simple">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.spi">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="../spi/package-summary.html">org.apache.logging.log4j.spi</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/EntryMessage.html#org.apache.logging.log4j.spi">EntryMessage</a></div>
<div class="col-last even-row-color">
<div class="block">Entry flow messages</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/FlowMessageFactory.html#org.apache.logging.log4j.spi">FlowMessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates flow messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/Message.html#org.apache.logging.log4j.spi">Message</a></div>
<div class="col-last even-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j.spi">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MessageFactory2.html#org.apache.logging.log4j.spi">MessageFactory2</a></div>
<div class="col-last even-row-color">
<div class="block">Creates messages.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.status">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="../status/package-summary.html">org.apache.logging.log4j.status</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/Message.html#org.apache.logging.log4j.status">Message</a></div>
<div class="col-last even-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j.status">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.util">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.message</a> used by <a href="../util/package-summary.html">org.apache.logging.log4j.util</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/Message.html#org.apache.logging.log4j.util">Message</a></div>
<div class="col-last even-row-color">
<div class="block">An interface for various Message implementations that can be logged.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/MessageFactory.html#org.apache.logging.log4j.util">MessageFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates messages.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MultiformatMessage.html#org.apache.logging.log4j.util">MultiformatMessage</a></div>
<div class="col-last even-row-color">
<div class="block">A Message that can render itself in more than one way.</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>