| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Lazy (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, interface: Lazy"> |
| <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/Lazy.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.logging.log4j.util</a></div> |
| <h1 title="Interface Lazy" class="title">Interface Lazy<T></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - type of value</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Lazy<T></span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T></span></div> |
| <div class="block">Provides a lazily-initialized value from a <code>Supplier<T></code>.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab5"><code>default <a href="Lazy.html" title="type parameter in Lazy">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#get()" class="member-name-link">get</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 the value held by this lazy.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isInitialized()" class="member-name-link">isInitialized</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Indicates whether this lazy value has been initialized.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <T> <a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#lazy(java.util.function.Supplier)" class="member-name-link">lazy</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Creates a strict lazy value using the provided Supplier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <R> <a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><R></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#map(java.util.function.Function)" class="member-name-link">map</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><? super <a href="Lazy.html" title="type parameter in Lazy">T</a>,<wbr>? extends R> function)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Creates a new lazy value derived from this lazy value using the provided value mapping function.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <T> <a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#pure(java.util.function.Supplier)" class="member-name-link">pure</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Creates a pure lazy value using the provided Supplier to initialize the value.</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="#set(T)" class="member-name-link">set</a><wbr>(<a href="Lazy.html" title="type parameter in Lazy">T</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets this lazy value to the provided value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Lazy.html" title="type parameter in Lazy">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#value()" class="member-name-link">value</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the value held by this lazy.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <T> <a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#value(T)" class="member-name-link">value</a><wbr>(T value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Creates a lazy value using the provided constant value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <T> <a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#weak(T)" class="member-name-link">weak</a><wbr>(T value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Creates a lazy value using a weak reference to the provided value.</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="value()"> |
| <h3>value</h3> |
| <div class="member-signature"><span class="return-type"><a href="Lazy.html" title="type parameter in Lazy">T</a></span> <span class="element-name">value</span>()</div> |
| <div class="block">Returns the value held by this lazy. This may cause the value to initialize if it hasn't been already.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get()"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Lazy.html" title="type parameter in Lazy">T</a></span> <span class="element-name">get</span>()</div> |
| <div class="block">Returns the value held by this lazy. This may cause the value to initialize if it hasn't been already.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html#get--" title="class or interface in java.util.function" class="external-link">get</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Lazy.html" title="type parameter in Lazy">T</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="map(java.util.function.Function)"> |
| <h3>map</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="type-parameters"><R></span> <span class="return-type"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><R></span> <span class="element-name">map</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><? super <a href="Lazy.html" title="type parameter in Lazy">T</a>,<wbr>? extends R> function)</span></div> |
| <div class="block">Creates a new lazy value derived from this lazy value using the provided value mapping function.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInitialized()"> |
| <h3>isInitialized</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isInitialized</span>()</div> |
| <div class="block">Indicates whether this lazy value has been initialized.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(T)"> |
| <h3 id="set(java.lang.Object)">set</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">set</span><wbr><span class="parameters">(<a href="Lazy.html" title="type parameter in Lazy">T</a> newValue)</span></div> |
| <div class="block">Sets this lazy value to the provided value.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this type of lazy value cannot be updated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lazy(java.util.function.Supplier)"> |
| <h3>lazy</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></span> <span class="element-name">lazy</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</span></div> |
| <div class="block">Creates a strict lazy value using the provided Supplier. The supplier is guaranteed to only be invoked by at |
| most one thread, and all threads will see the same published value when this returns.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="value(T)"> |
| <h3 id="value(java.lang.Object)">value</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></span> <span class="element-name">value</span><wbr><span class="parameters">(T value)</span></div> |
| <div class="block">Creates a lazy value using the provided constant value.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="weak(T)"> |
| <h3 id="weak(java.lang.Object)">weak</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></span> <span class="element-name">weak</span><wbr><span class="parameters">(T value)</span></div> |
| <div class="block">Creates a lazy value using a weak reference to the provided value.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="pure(java.util.function.Supplier)"> |
| <h3>pure</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Lazy.html" title="interface in org.apache.logging.log4j.util">Lazy</a><T></span> <span class="element-name">pure</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</span></div> |
| <div class="block">Creates a pure lazy value using the provided Supplier to initialize the value. The supplier may be invoked more |
| than once, and the return value should be a purely computed value as the result may be a different instance |
| each time. This is useful for building cache tables and other pure computations.</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> |
