blob: e67db8c96dab8ac489577cb2092646525a9d819f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>PropertyEnvironment (Apache Log4j API 3.0.0-beta1 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, interface: PropertyEnvironment">
<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/PropertyEnvironment.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.util</a></div>
<h1 title="Interface PropertyEnvironment" class="title">Interface PropertyEnvironment</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="PropertiesUtil.html" title="class in org.apache.logging.log4j.util">PropertiesUtil</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PropertyEnvironment</span></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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addPropertySource(org.apache.logging.log4j.util.PropertySource)" class="member-name-link">addPropertySource</a><wbr>(<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a>&nbsp;propertySource)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Allows a PropertySource to be added after PropertiesUtil has been created.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(java.lang.String)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(java.lang.String%5B%5D,java.lang.String,org.apache.logging.log4j.util.Supplier)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;&nbsp;supplier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(java.lang.String,boolean)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
boolean&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(java.lang.String,boolean,boolean)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
boolean&nbsp;defaultValueIfAbsent,
boolean&nbsp;defaultValueIfPresent)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(org.apache.logging.log4j.util.PropertyKey)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(org.apache.logging.log4j.util.PropertyKey,boolean)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
boolean&nbsp;defaultValue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBooleanProperty(org.apache.logging.log4j.util.PropertyKey,boolean,boolean)" class="member-name-link">getBooleanProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
boolean&nbsp;defaultValueIfAbsent,
boolean&nbsp;defaultValueIfPresent)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a boolean value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCharsetProperty(java.lang.String)" class="member-name-link">getCharsetProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a Charset value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCharsetProperty(java.lang.String,java.nio.charset.Charset)" class="member-name-link">getCharsetProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a Charset value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCharsetProperty(org.apache.logging.log4j.util.PropertyKey)" class="member-name-link">getCharsetProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a Charset value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCharsetProperty(org.apache.logging.log4j.util.PropertyKey,java.nio.charset.Charset)" class="member-name-link">getCharsetProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a Charset value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDurationProperty(java.lang.String%5B%5D,java.lang.String,org.apache.logging.log4j.util.Supplier)" class="member-name-link">getDurationProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&gt;&nbsp;supplier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDurationProperty(java.lang.String,java.time.Duration)" class="member-name-link">getDurationProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a Duration where the String is of the format nnn[unit] where nnn represents an integer value
and unit represents a time unit.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDurationProperty(org.apache.logging.log4j.util.PropertyKey,java.time.Duration)" class="member-name-link">getDurationProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;defaultValue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a Duration where the String is of the format nnn[unit] where nnn represents an integer value
and unit represents a time unit.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getIntegerProperty(java.lang.String%5B%5D,java.lang.String,org.apache.logging.log4j.util.Supplier)" class="member-name-link">getIntegerProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;supplier)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getIntegerProperty(java.lang.String,int)" class="member-name-link">getIntegerProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
int&nbsp;defaultValue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as an integer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getIntegerProperty(org.apache.logging.log4j.util.PropertyKey,int)" class="member-name-link">getIntegerProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
int&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as an integer.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getLongProperty(java.lang.String%5B%5D,java.lang.String,org.apache.logging.log4j.util.Supplier)" class="member-name-link">getLongProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>&gt;&nbsp;supplier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getLongProperty(java.lang.String,long)" class="member-name-link">getLongProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
long&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a long.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getLongProperty(org.apache.logging.log4j.util.PropertyKey,long)" class="member-name-link">getLongProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
long&nbsp;defaultValue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a long.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStringProperty(java.lang.String)" class="member-name-link">getStringProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the named property as a String.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getStringProperty(java.lang.String%5B%5D,java.lang.String,org.apache.logging.log4j.util.Supplier)" class="member-name-link">getStringProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;supplier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getStringProperty(java.lang.String,java.lang.String)" class="member-name-link">getStringProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a String.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getStringProperty(org.apache.logging.log4j.util.PropertyKey)" class="member-name-link">getStringProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a String.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getStringProperty(org.apache.logging.log4j.util.PropertyKey,java.lang.String)" class="member-name-link">getStringProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the named property as a String.</div>
</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="#hasProperty(java.lang.String)" class="member-name-link">hasProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns <code>true</code> if the specified property is defined, regardless of its value (it may not have a value).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#hasProperty(org.apache.logging.log4j.util.PropertyKey)" class="member-name-link">hasProperty</a><wbr>(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns <code>true</code> if the specified property is defined, regardless of its value (it may not have a value).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isOsWindows()" class="member-name-link">isOsWindows</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns true if system properties tell us we are running on Windows.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removePropertySource(org.apache.logging.log4j.util.PropertySource)" class="member-name-link">removePropertySource</a><wbr>(<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a>&nbsp;propertySource)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Allows a PropertySource that was added to be removed.</div>
</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="addPropertySource(org.apache.logging.log4j.util.PropertySource)">
<h3>addPropertySource</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addPropertySource</span><wbr><span class="parameters">(<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a>&nbsp;propertySource)</span></div>
<div class="block">Allows a PropertySource to be added after PropertiesUtil has been created.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>propertySource</code> - the PropertySource to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removePropertySource(org.apache.logging.log4j.util.PropertySource)">
<h3>removePropertySource</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">removePropertySource</span><wbr><span class="parameters">(<a href="PropertySource.html" title="interface in org.apache.logging.log4j.util">PropertySource</a>&nbsp;propertySource)</span></div>
<div class="block">Allows a PropertySource that was added to be removed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>propertySource</code> - the PropertySource to remove.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasProperty(java.lang.String)">
<h3>hasProperty</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">hasProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns <code>true</code> if the specified property is defined, regardless of its value (it may not have a value).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to verify</dd>
<dt>Returns:</dt>
<dd><code>true</code> if the specified property is defined, regardless of its value</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasProperty(org.apache.logging.log4j.util.PropertyKey)">
<h3>hasProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</span></div>
<div class="block">Returns <code>true</code> if the specified property is defined, regardless of its value (it may not have a value).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to verify</dd>
<dt>Returns:</dt>
<dd><code>true</code> if the specified property is defined, regardless of its value</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(java.lang.String)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Gets the named property as a boolean value. If the property matches the string <code>"true"</code> (case-insensitive),
then it is returned as the boolean value <code>true</code>. Any other non-<code>null</code> text in the property is
considered <code>false</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>false</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(java.lang.String,boolean)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
boolean&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a boolean value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(org.apache.logging.log4j.util.PropertyKey)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</span></div>
<div class="block">Gets the named property as a boolean value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(org.apache.logging.log4j.util.PropertyKey,boolean)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
boolean&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a boolean value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(java.lang.String,boolean,boolean)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
boolean&nbsp;defaultValueIfAbsent,
boolean&nbsp;defaultValueIfPresent)</span></div>
<div class="block">Gets the named property as a boolean value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValueIfAbsent</code> - the default value to use if the property is undefined</dd>
<dd><code>defaultValueIfPresent</code> - the default value to use if the property is defined but not assigned</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(org.apache.logging.log4j.util.PropertyKey,boolean,boolean)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
boolean&nbsp;defaultValueIfAbsent,
boolean&nbsp;defaultValueIfPresent)</span></div>
<div class="block">Gets the named property as a boolean value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValueIfAbsent</code> - the default value to use if the property is undefined</dd>
<dd><code>defaultValueIfPresent</code> - the default value to use if the property is defined but not assigned</dd>
<dt>Returns:</dt>
<dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBooleanProperty(java.lang.String[],java.lang.String,org.apache.logging.log4j.util.Supplier)">
<h3>getBooleanProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">getBooleanProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;&nbsp;supplier)</span></div>
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefixes</code> - The array of prefixes.</dd>
<dd><code>key</code> - The key to locate.</dd>
<dd><code>supplier</code> - The method to call to derive the default value. If the value is null, null will be returned
if no property is found.</dd>
<dt>Returns:</dt>
<dd>The value or null if it is not found.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCharsetProperty(java.lang.String)">
<h3>getCharsetProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span>&nbsp;<span class="element-name">getCharsetProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Gets the named property as a Charset value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dt>Returns:</dt>
<dd>the Charset value of the property or <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html#defaultCharset()" title="class or interface in java.nio.charset" class="external-link"><code>Charset.defaultCharset()</code></a> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCharsetProperty(org.apache.logging.log4j.util.PropertyKey)">
<h3>getCharsetProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span>&nbsp;<span class="element-name">getCharsetProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</span></div>
<div class="block">Gets the named property as a Charset value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dt>Returns:</dt>
<dd>the Charset value of the property or <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html#defaultCharset()" title="class or interface in java.nio.charset" class="external-link"><code>Charset.defaultCharset()</code></a> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCharsetProperty(org.apache.logging.log4j.util.PropertyKey,java.nio.charset.Charset)">
<h3>getCharsetProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span>&nbsp;<span class="element-name">getCharsetProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a Charset value.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the Charset value of the property or <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html#defaultCharset()" title="class or interface in java.nio.charset" class="external-link"><code>Charset.defaultCharset()</code></a> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCharsetProperty(java.lang.String,java.nio.charset.Charset)">
<h3>getCharsetProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span>&nbsp;<span class="element-name">getCharsetProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a Charset value. If we cannot find the named Charset, see if it is mapped in
file <code>Log4j-charsets.properties</code> on the class path.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the Charset value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIntegerProperty(java.lang.String,int)">
<h3>getIntegerProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getIntegerProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
int&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as an integer.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the parsed integer value of the property or <code>defaultValue</code> if it was undefined or could not be
parsed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIntegerProperty(org.apache.logging.log4j.util.PropertyKey,int)">
<h3>getIntegerProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getIntegerProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
int&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as an integer.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the parsed integer value of the property or <code>defaultValue</code> if it was undefined or could not be
parsed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIntegerProperty(java.lang.String[],java.lang.String,org.apache.logging.log4j.util.Supplier)">
<h3>getIntegerProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span>&nbsp;<span class="element-name">getIntegerProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;supplier)</span></div>
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefixes</code> - The array of prefixes.</dd>
<dd><code>key</code> - The key to locate.</dd>
<dd><code>supplier</code> - The method to call to derive the default value. If the value is null, null will be returned
if no property is found.</dd>
<dt>Returns:</dt>
<dd>The value or null if it is not found.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLongProperty(org.apache.logging.log4j.util.PropertyKey,long)">
<h3>getLongProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getLongProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
long&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a long.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the parsed long value of the property or <code>defaultValue</code> if it was undefined or could not be parsed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLongProperty(java.lang.String,long)">
<h3>getLongProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getLongProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
long&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a long.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the parsed long value of the property or <code>defaultValue</code> if it was undefined or could not be parsed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLongProperty(java.lang.String[],java.lang.String,org.apache.logging.log4j.util.Supplier)">
<h3>getLongProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a></span>&nbsp;<span class="element-name">getLongProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>&gt;&nbsp;supplier)</span></div>
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefixes</code> - The array of prefixes.</dd>
<dd><code>key</code> - The key to locate.</dd>
<dd><code>supplier</code> - The method to call to derive the default value. If the value is null, null will be returned
if no property is found.</dd>
<dt>Returns:</dt>
<dd>The value or null if it is not found.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDurationProperty(org.apache.logging.log4j.util.PropertyKey,java.time.Duration)">
<h3>getDurationProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></span>&nbsp;<span class="element-name">getDurationProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;defaultValue)</span></div>
<div class="block">Retrieves a Duration where the String is of the format nnn[unit] where nnn represents an integer value
and unit represents a time unit.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - The key for the property.</dd>
<dd><code>defaultValue</code> - The default value.</dd>
<dt>Returns:</dt>
<dd>The value of the String as a Duration or the default value, which may be null.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDurationProperty(java.lang.String,java.time.Duration)">
<h3>getDurationProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></span>&nbsp;<span class="element-name">getDurationProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;defaultValue)</span></div>
<div class="block">Retrieves a Duration where the String is of the format nnn[unit] where nnn represents an integer value
and unit represents a time unit.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The property name.</dd>
<dd><code>defaultValue</code> - The default value.</dd>
<dt>Returns:</dt>
<dd>The value of the String as a Duration or the default value, which may be null.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDurationProperty(java.lang.String[],java.lang.String,org.apache.logging.log4j.util.Supplier)">
<h3>getDurationProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></span>&nbsp;<span class="element-name">getDurationProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&gt;&nbsp;supplier)</span></div>
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefixes</code> - The array of prefixes.</dd>
<dd><code>key</code> - The key to locate.</dd>
<dd><code>supplier</code> - The method to call to derive the default value. If the value is null, null will be returned
if no property is found.</dd>
<dt>Returns:</dt>
<dd>The value or null if it is not found.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStringProperty(java.lang.String[],java.lang.String,org.apache.logging.log4j.util.Supplier)">
<h3>getStringProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStringProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;prefixes,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="Supplier.html" title="interface in org.apache.logging.log4j.util">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;supplier)</span></div>
<div class="block">Retrieves a property that may be prefixed by more than one string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefixes</code> - The array of prefixes.</dd>
<dd><code>key</code> - The key to locate.</dd>
<dd><code>supplier</code> - The method to call to derive the default value. If the value is null, null will be returned
if no property is found.</dd>
<dt>Returns:</dt>
<dd>The value or null if it is not found.</dd>
<dt>Since:</dt>
<dd>2.13.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStringProperty(org.apache.logging.log4j.util.PropertyKey)">
<h3>getStringProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStringProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key)</span></div>
<div class="block">Gets the named property as a String.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dt>Returns:</dt>
<dd>the String value of the property or <code>null</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStringProperty(java.lang.String)">
<h3>getStringProperty</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStringProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Gets the named property as a String.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dt>Returns:</dt>
<dd>the String value of the property or <code>null</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStringProperty(org.apache.logging.log4j.util.PropertyKey,java.lang.String)">
<h3>getStringProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStringProperty</span><wbr><span class="parameters">(<a href="PropertyKey.html" title="interface in org.apache.logging.log4j.util">PropertyKey</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a String.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the key of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the String value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStringProperty(java.lang.String,java.lang.String)">
<h3>getStringProperty</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStringProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;defaultValue)</span></div>
<div class="block">Gets the named property as a String.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to look up</dd>
<dd><code>defaultValue</code> - the default value to use if the property is undefined</dd>
<dt>Returns:</dt>
<dd>the String value of the property or <code>defaultValue</code> if undefined.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isOsWindows()">
<h3>isOsWindows</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isOsWindows</span>()</div>
<div class="block">Returns true if system properties tell us we are running on Windows.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if system properties tell us we are running on Windows.</dd>
</dl>
</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-2023 <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>