2.x/javadoc/log4j-api/org/apache/logging/log4j/util/PropertyFilePropertySource.html - logging-log4j-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>PropertyFilePropertySource (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, class: PropertyFilePropertySource">
 <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 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/PropertyFilePropertySource.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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li>Method</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.util</a></div>
 <h1 title="Class PropertyFilePropertySource" class="title">Class PropertyFilePropertySource</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance"><a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">org.apache.logging.log4j.util.PropertiesPropertySource</a>
 <div class="inheritance">org.apache.logging.log4j.util.PropertyFilePropertySource</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PropertyFilePropertySource</span>
 <span class="extends-implements">extends <a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">PropertiesPropertySource</a></span></div>
 <div class="block">PropertySource backed by a properties file. Follows the same conventions as <a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util"><code>PropertiesPropertySource</code></a>.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>2.10.0</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="inherited-list">
 <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.util.PropertySource">Nested classes/interfaces inherited from interface&nbsp;org.apache.logging.log4j.util.<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a></h2>
 <code><a href="PropertySource.Comparator.html" title="class in org.apache.logging.log4j.util">PropertySource.Comparator</a>, <a href="PropertySource.Util.html" title="class in org.apache.logging.log4j.util">PropertySource.Util</a></code></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">PropertyFilePropertySource</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName)</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">PropertyFilePropertySource</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;useTccl)</code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.logging.log4j.util.PropertiesPropertySource">Methods inherited from class&nbsp;org.apache.logging.log4j.util.<a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">PropertiesPropertySource</a></h3>
 <code><a href="PropertiesPropertySource.html#containsProperty(java.lang.String)">containsProperty</a>, <a href="PropertiesPropertySource.html#forEach(org.apache.logging.log4j.util.BiConsumer)">forEach</a>, <a href="PropertiesPropertySource.html#getNormalForm(java.lang.Iterable)">getNormalForm</a>, <a href="PropertiesPropertySource.html#getPriority()">getPriority</a>, <a href="PropertiesPropertySource.html#getProperty(java.lang.String)">getProperty</a>, <a href="PropertiesPropertySource.html#getPropertyNames()">getPropertyNames</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String)">
 <h3>PropertyFilePropertySource</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PropertyFilePropertySource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,boolean)">
 <h3>PropertyFilePropertySource</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PropertyFilePropertySource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;useTccl)</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>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>PropertyFilePropertySource (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, class: PropertyFilePropertySource">
	<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 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/PropertyFilePropertySource.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: </li>
	<li><a href="#nested-class-summary">Nested</a> \| </li>
	<li>Field \| </li>
	<li><a href="#constructor-summary">Constr</a> \| </li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor-detail">Constr</a> \| </li>
	<li>Method</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> <a href="package-summary.html">org.apache.logging.log4j.util</a></div>
	<h1 title="Class PropertyFilePropertySource" class="title">Class PropertyFilePropertySource</h1>
	</div>
	<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
	<div class="inheritance"><a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">org.apache.logging.log4j.util.PropertiesPropertySource</a>
	<div class="inheritance">org.apache.logging.log4j.util.PropertyFilePropertySource</div>
	</div>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>All Implemented Interfaces:</dt>
	<dd><code><a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a></code></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PropertyFilePropertySource</span>
	<span class="extends-implements">extends <a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">PropertiesPropertySource</a></span></div>
	<div class="block">PropertySource backed by a properties file. Follows the same conventions as <a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util"><code>PropertiesPropertySource</code></a>.</div>
	<dl class="notes">
	<dt>Since:</dt>
	<dd>2.10.0</dd>
	</dl>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- ======== NESTED CLASS SUMMARY ======== -->
	<li>
	<section class="nested-class-summary" id="nested-class-summary">
	<h2>Nested Class Summary</h2>
	<div class="inherited-list">
	<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.util.PropertySource">Nested classes/interfaces inherited from interface org.apache.logging.log4j.util.<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a></h2>
	<code><a href="PropertySource.Comparator.html" title="class in org.apache.logging.log4j.util">PropertySource.Comparator</a>, <a href="PropertySource.Util.html" title="class in org.apache.logging.log4j.util">PropertySource.Util</a></code></div>
	</section>
	</li>
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<li>
	<section class="constructor-summary" id="constructor-summary">
	<h2>Constructor Summary</h2>
	<div class="caption"><span>Constructors</span></div>
	<div class="summary-table two-column-summary">
	<div class="table-header col-first">Constructor</div>
	<div class="table-header col-last">Description</div>
	<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">PropertyFilePropertySource</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName)</code></div>
	<div class="col-last even-row-color"> </div>
	<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,boolean)" class="member-name-link">PropertyFilePropertySource</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName,
	boolean useTccl)</code></div>
	<div class="col-last odd-row-color"> </div>
	</div>
	</section>
	</li>
	<!-- ========== METHOD SUMMARY =========== -->
	<li>
	<section class="method-summary" id="method-summary">
	<h2>Method Summary</h2>
	<div class="inherited-list">
	<h3 id="methods-inherited-from-class-org.apache.logging.log4j.util.PropertiesPropertySource">Methods inherited from class org.apache.logging.log4j.util.<a href="PropertiesPropertySource.html" title="class in org.apache.logging.log4j.util">PropertiesPropertySource</a></h3>
	<code><a href="PropertiesPropertySource.html#containsProperty(java.lang.String)">containsProperty</a>, <a href="PropertiesPropertySource.html#forEach(org.apache.logging.log4j.util.BiConsumer)">forEach</a>, <a href="PropertiesPropertySource.html#getNormalForm(java.lang.Iterable)">getNormalForm</a>, <a href="PropertiesPropertySource.html#getPriority()">getPriority</a>, <a href="PropertiesPropertySource.html#getProperty(java.lang.String)">getProperty</a>, <a href="PropertiesPropertySource.html#getPropertyNames()">getPropertyNames</a></code></div>
	<div class="inherited-list">
	<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
	</section>
	</li>
	</ul>
	</section>
	<section class="details">
	<ul class="details-list">
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<li>
	<section class="constructor-details" id="constructor-detail">
	<h2>Constructor Details</h2>
	<ul class="member-list">
	<li>
	<section class="detail" id="<init>(java.lang.String)">
	<h3>PropertyFilePropertySource</h3>
	<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PropertyFilePropertySource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName)</span></div>
	</section>
	</li>
	<li>
	<section class="detail" id="<init>(java.lang.String,boolean)">
	<h3>PropertyFilePropertySource</h3>
	<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PropertyFilePropertySource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fileName,
	boolean useTccl)</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 © 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>