blob: ec1b6fd60ed0152ded6f366c48b147a26b4cbad3 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.logging.log4j.LogBuilder (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, interface: LogBuilder">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-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><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">Class</a></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 Interface org.apache.logging.log4j.LogBuilder" class="title">Uses of Interface<br>org.apache.logging.log4j.LogBuilder</h1>
</div>
<div class="caption"><span>Packages that use <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</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.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>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j">
<h2>Uses of <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a> in <a href="../package-summary.html">org.apache.logging.log4j</a></h2>
<div class="caption"><span>Fields in <a href="../package-summary.html">org.apache.logging.log4j</a> declared as <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">LogBuilder.</span><code><a href="../LogBuilder.html#NOOP" class="member-name-link">NOOP</a></code></div>
<div class="col-last even-row-color">
<div class="block">NOOP Logbuilder</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j</a> that return <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></span></div>
<div class="summary-table three-column-summary">
<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"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#always()" class="member-name-link">always</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a log event that will always be logged.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atDebug()" class="member-name-link">atDebug</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atError()" class="member-name-link">atError</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atFatal()" class="member-name-link">atFatal</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atInfo()" class="member-name-link">atInfo</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atLevel(org.apache.logging.log4j.Level)" class="member-name-link">atLevel</a><wbr>(<a href="../Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a log event.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atTrace()" class="member-name-link">atTrace</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Logger.</span><code><a href="../Logger.html#atWarn()" class="member-name-link">atWarn</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">LogBuilder.</span><code><a href="../LogBuilder.html#withLocation()" class="member-name-link">withLocation</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">An implementation will calculate the caller's stack frame and include it in the log event.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LogBuilder.</span><code><a href="../LogBuilder.html#withLocation(java.lang.StackTraceElement)" class="member-name-link">withLocation</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a>&nbsp;location)</code></div>
<div class="col-last odd-row-color">
<div class="block">Adds the specified stack trace element to the log event.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">LogBuilder.</span><code><a href="../LogBuilder.html#withMarker(org.apache.logging.log4j.Marker)" class="member-name-link">withMarker</a><wbr>(<a href="../Marker.html" title="interface in org.apache.logging.log4j">Marker</a>&nbsp;marker)</code></div>
<div class="col-last even-row-color">
<div class="block">Includes a Marker in the log event.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LogBuilder.</span><code><a href="../LogBuilder.html#withThrowable(java.lang.Throwable)" class="member-name-link">withThrowable</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;throwable)</code></div>
<div class="col-last odd-row-color">
<div class="block">Includes a Throwable in the log event.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.spi">
<h2>Uses of <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a> in <a href="../spi/package-summary.html">org.apache.logging.log4j.spi</a></h2>
<div class="caption"><span>Methods in <a href="../spi/package-summary.html">org.apache.logging.log4j.spi</a> that return <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#always()" class="member-name-link">always</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a log event that will always be logged.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atDebug()" class="member-name-link">atDebug</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a debug log event.</div>
</div>
<div class="col-first even-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atError()" class="member-name-link">atError</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct an error log event.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atFatal()" class="member-name-link">atFatal</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a fatal log event.</div>
</div>
<div class="col-first even-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atInfo()" class="member-name-link">atInfo</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct an informational log event.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atLevel(org.apache.logging.log4j.Level)" class="member-name-link">atLevel</a><wbr>(<a href="../Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a log event.</div>
</div>
<div class="col-first even-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atTrace()" class="member-name-link">atTrace</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a trace log event.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#atWarn()" class="member-name-link">atWarn</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a warning log event.</div>
</div>
<div class="col-first even-row-color"><code>protected <a href="../LogBuilder.html" title="interface in org.apache.logging.log4j">LogBuilder</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractLogger.</span><code><a href="../spi/AbstractLogger.html#getLogBuilder(org.apache.logging.log4j.Level)" class="member-name-link">getLogBuilder</a><wbr>(<a href="../Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a log builder that logs at the specified level.</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>