blob: 9074b61fc37fe1df14927dda08644837a04ceb61 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>LocationAware (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="declaration: package: org.apache.logging.log4j.core.impl, interface: LocationAware">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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-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><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/LocationAware.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</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">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.impl</a></div>
<h1 title="Interface LocationAware" class="title">Interface LocationAware</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../appender/AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></code>, <code><a href="../layout/AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code>, <code><a href="../appender/db/AbstractDatabaseAppender.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseAppender</a></code>, <code><a href="../appender/AbstractFileAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractFileAppender</a></code>, <code><a href="../appender/AbstractOutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractOutputStreamAppender</a></code>, <code><a href="../layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code>, <code><a href="../appender/AbstractWriterAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractWriterAppender</a></code>, <code><a href="../appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a></code>, <code><a href="../async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a></code>, <code><a href="../async/AsyncLoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig.RootLogger</a></code>, <code><a href="../pattern/ClassNamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ClassNamePatternConverter</a></code>, <code><a href="../appender/ConsoleAppender.html" title="class in org.apache.logging.log4j.core.appender">ConsoleAppender</a></code>, <code><a href="../appender/CountingNoOpAppender.html" title="class in org.apache.logging.log4j.core.appender">CountingNoOpAppender</a></code>, <code><a href="../layout/CsvLogEventLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvLogEventLayout</a></code>, <code><a href="../layout/CsvParameterLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvParameterLayout</a></code>, <code><a href="../appender/FailoverAppender.html" title="class in org.apache.logging.log4j.core.appender">FailoverAppender</a></code>, <code><a href="../appender/FileAppender.html" title="class in org.apache.logging.log4j.core.appender">FileAppender</a></code>, <code><a href="../pattern/FullLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">FullLocationPatternConverter</a></code>, <code><a href="../layout/GelfLayout.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a></code>, <code><a href="../layout/HtmlLayout.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a></code>, <code><a href="../appender/HttpAppender.html" title="class in org.apache.logging.log4j.core.appender">HttpAppender</a></code>, <code><a href="../appender/db/jdbc/JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender</a></code>, <code><a href="../appender/mom/jeromq/JeroMqAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.jeromq">JeroMqAppender</a></code>, <code><a href="../appender/mom/JmsAppender.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender</a></code>, <code><a href="../layout/JsonLayout.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a></code>, <code><a href="../appender/mom/kafka/KafkaAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.kafka">KafkaAppender</a></code>, <code><a href="../layout/LevelPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">LevelPatternSelector</a></code>, <code><a href="../pattern/LineLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LineLocationPatternConverter</a></code>, <code><a href="../config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code>, <code><a href="../config/LoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></code>, <code><a href="../layout/MarkerPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">MarkerPatternSelector</a></code>, <code><a href="../appender/MemoryMappedFileAppender.html" title="class in org.apache.logging.log4j.core.appender">MemoryMappedFileAppender</a></code>, <code><a href="../pattern/MethodLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MethodLocationPatternConverter</a></code>, <code><a href="../appender/nosql/NoSqlAppender.html" title="class in org.apache.logging.log4j.core.appender.nosql">NoSqlAppender</a></code>, <code><a href="../appender/NullAppender.html" title="class in org.apache.logging.log4j.core.appender">NullAppender</a></code>, <code><a href="../appender/OutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamAppender</a></code>, <code><a href="../layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code>, <code><a href="../appender/RandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RandomAccessFileAppender</a></code>, <code><a href="../appender/rewrite/RewriteAppender.html" title="class in org.apache.logging.log4j.core.appender.rewrite">RewriteAppender</a></code>, <code><a href="../layout/Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code>, <code><a href="../appender/RollingFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingFileAppender</a></code>, <code><a href="../appender/RollingRandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingRandomAccessFileAppender</a></code>, <code><a href="../appender/routing/RoutingAppender.html" title="class in org.apache.logging.log4j.core.appender.routing">RoutingAppender</a></code>, <code><a href="../appender/ScriptAppenderSelector.html" title="class in org.apache.logging.log4j.core.appender">ScriptAppenderSelector</a></code>, <code><a href="../layout/ScriptPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">ScriptPatternSelector</a></code>, <code><a href="../appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></code>, <code><a href="../appender/SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></code>, <code><a href="../appender/SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></code>, <code><a href="../layout/SyslogLayout.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a></code>, <code><a href="../appender/WriterAppender.html" title="class in org.apache.logging.log4j.core.appender">WriterAppender</a></code>, <code><a href="../layout/XmlLayout.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a></code>, <code><a href="../layout/YamlLayout.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">LocationAware</span></div>
<div class="block">Classes that use location information should implement this interface.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#requiresLocation()" class="member-name-link">requiresLocation</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="requiresLocation()">
<h3>requiresLocation</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">requiresLocation</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</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>