Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-api / org / apache / logging / log4j / util / package-summary.html
blob: 8cf9e82cff715d751affd23555435754e51bc2de [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.util (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.util">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.logging.log4j.util" class="title">Package org.apache.logging.log4j.util</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.22.0")
</span>package <span class="element-name">org.apache.logging.log4j.util</span></div>
<section class="package-description" id="package-description">
<div class="block">Internal utility classes for the Log4j 2 API. Note that the use of any classes in this package is not supported.
There are no guarantees for binary or logical compatibility in this package.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</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="../package-summary.html">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="../message/package-summary.html">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="../simple/package-summary.html">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="../spi/package-summary.html">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="../status/package-summary.html">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>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Types</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Activator.html" title="class in org.apache.logging.log4j.util">Activator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em>
OSGi bundle activator.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Base64Util.html" title="class in org.apache.logging.log4j.util">Base64Util</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Base64 encodes Strings.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="BiConsumer.html" title="interface in org.apache.logging.log4j.util">BiConsumer</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">An operation that accepts two input arguments and returns no result.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Cast.html" title="class in org.apache.logging.log4j.util">Cast</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Chars.html" title="class in org.apache.logging.log4j.util">Chars</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Constants.html" title="class in org.apache.logging.log4j.util">Constants</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Log4j API Constants.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="EnglishEnums.html" title="class in org.apache.logging.log4j.util">EnglishEnums</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EnvironmentPropertySource.html" title="class in org.apache.logging.log4j.util">EnvironmentPropertySource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PropertySource implementation that uses environment variables as a source.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FilteredObjectInputStream.html" title="class in org.apache.logging.log4j.util">FilteredObjectInputStream</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/ObjectInputStream.html" title="class or interface in java.io" class="external-link"><code>ObjectInputStream</code></a> to only allow some built-in Log4j classes and caller-specified classes to be
deserialized.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IndexedReadOnlyStringMap.html" title="interface in org.apache.logging.log4j.util">IndexedReadOnlyStringMap</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">An extension of <code>ReadOnlyStringMap</code> that imposes a total ordering on its keys.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IndexedStringMap.html" title="interface in org.apache.logging.log4j.util">IndexedStringMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">An extension of <code>StringMap</code> that imposes a total ordering on its keys.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="InternalApi.html" title="annotation in org.apache.logging.log4j.util">InternalApi</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Indicates that the annotated element is considered an internal API to Log4j and should not be used by external
code.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="InternalException.html" title="class in org.apache.logging.log4j.util">InternalException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Exception thrown when an error occurs while accessing internal resources.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LambdaUtil.html" title="class in org.apache.logging.log4j.util">LambdaUtil</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Utility class for lambda support.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Provides a lazily-initialized value from a <code>Supplier&lt;T&gt;</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LazyBoolean.html" title="class in org.apache.logging.log4j.util">LazyBoolean</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LoaderUtil.html" title="class in org.apache.logging.log4j.util">LoaderUtil</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em> Utility class for ClassLoaders.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="MessageSupplier.html" title="interface in org.apache.logging.log4j.util">MessageSupplier</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Classes implementing this interface know how to supply <a href="../message/Message.html" title="interface in org.apache.logging.log4j.message"><code>Message</code></a>s.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A Message that can render itself in more than one way.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OsgiServiceLocator.html" title="class in org.apache.logging.log4j.util">OsgiServiceLocator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PerformanceSensitive.html" title="annotation in org.apache.logging.log4j.util">PerformanceSensitive</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Indicates that a particular annotated construct was written with certain performance constraints in mind that
should be considered when modifying or testing.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ProcessIdUtil.html" title="class in org.apache.logging.log4j.util">ProcessIdUtil</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Provides the PID of the current JVM.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">PropertiesPropertySource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PropertySource backed by a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link"><code>Properties</code></a> instance.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PropertiesUtil.html" title="class in org.apache.logging.log4j.util">PropertiesUtil</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em></div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PropertyFilePropertySource.html" title="class in org.apache.logging.log4j.util">PropertyFilePropertySource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PropertySource backed by a properties file.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A source for global configuration properties.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PropertySource.Comparator.html" title="class in org.apache.logging.log4j.util">PropertySource.Comparator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Comparator for ordering PropertySource instances by priority.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PropertySource.Util.html" title="class in org.apache.logging.log4j.util">PropertySource.Util</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Utility methods useful for PropertySource implementations.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ProviderActivator.html" title="class in org.apache.logging.log4j.util">ProviderActivator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility class to register Log4j2 providers in an OSGI environment.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ProviderUtil.html" title="class in org.apache.logging.log4j.util">ProviderUtil</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em> Utility class for Log4j <a href="../spi/Provider.html" title="class in org.apache.logging.log4j.spi"><code>Provider</code></a>s.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ReadOnlyStringMap.html" title="interface in org.apache.logging.log4j.util">ReadOnlyStringMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A read-only collection of String keys mapped to values of arbitrary type.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ServiceLoaderUtil.html" title="class in org.apache.logging.log4j.util">ServiceLoaderUtil</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This class should be considered internal.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SortedArrayStringMap.html" title="class in org.apache.logging.log4j.util">SortedArrayStringMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em>
Array-based implementation of the <code>ReadOnlyStringMap</code> interface.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StackLocator.html" title="class in org.apache.logging.log4j.util">StackLocator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em> Provides various methods to determine the caller class.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StackLocatorUtil.html" title="class in org.apache.logging.log4j.util">StackLocatorUtil</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em> Provides various methods to determine the caller class.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Objects that implement this interface can be converted to text, ideally without allocating temporary objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StringBuilders.html" title="class in org.apache.logging.log4j.util">StringBuilders</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StringMap.html" title="interface in org.apache.logging.log4j.util">StringMap</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Exposes methods to add and remove key-value pairs to and from <code>ReadOnlyStringMap</code>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Strings.html" title="class in org.apache.logging.log4j.util">Strings</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">Deprecated.</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SystemPropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">SystemPropertiesPropertySource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PropertySource backed by the current system properties.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Timer.html" title="class in org.apache.logging.log4j.util">Timer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Primarily used in unit tests, but can be used to track elapsed time for a request or portion of any other operation
so long as all the timer methods are called on the same thread in which it was started.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="Timer.Status.html" title="enum in org.apache.logging.log4j.util">Timer.Status</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TriConsumer.html" title="interface in org.apache.logging.log4j.util">TriConsumer</a>&lt;K,<wbr>V,<wbr>S&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">An operation that accepts three input arguments and returns no result.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Unbox.html" title="class in org.apache.logging.log4j.util">Unbox</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility for preventing primitive parameter values from being auto-boxed.</div>
</div>
</div>
</div>
</div>
</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>