| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TypeConverter (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.config.plugins.convert, interface: TypeConverter"> |
| <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/TypeConverter.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.core.config.plugins.convert</a></div> |
| <h1 title="Interface TypeConverter" class="title">Interface TypeConverter<T></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Converts Strings into the given type <code>T</code>.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="EnumConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">EnumConverter</a></code>, <code><a href="TypeConverters.BigDecimalConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.BigDecimalConverter</a></code>, <code><a href="TypeConverters.BigIntegerConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.BigIntegerConverter</a></code>, <code><a href="TypeConverters.BooleanConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.BooleanConverter</a></code>, <code><a href="TypeConverters.ByteArrayConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.ByteArrayConverter</a></code>, <code><a href="TypeConverters.ByteConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.ByteConverter</a></code>, <code><a href="TypeConverters.CharacterConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.CharacterConverter</a></code>, <code><a href="TypeConverters.CharArrayConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.CharArrayConverter</a></code>, <code><a href="TypeConverters.CharsetConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.CharsetConverter</a></code>, <code><a href="TypeConverters.ClassConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.ClassConverter</a></code>, <code><a href="TypeConverters.CronExpressionConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.CronExpressionConverter</a></code>, <code><a href="TypeConverters.DoubleConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.DoubleConverter</a></code>, <code><a href="TypeConverters.DurationConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.DurationConverter</a></code>, <code><a href="TypeConverters.FileConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.FileConverter</a></code>, <code><a href="TypeConverters.FloatConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.FloatConverter</a></code>, <code><a href="TypeConverters.InetAddressConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.InetAddressConverter</a></code>, <code><a href="TypeConverters.IntegerConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.IntegerConverter</a></code>, <code><a href="TypeConverters.LevelConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.LevelConverter</a></code>, <code><a href="TypeConverters.LongConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.LongConverter</a></code>, <code><a href="TypeConverters.PathConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.PathConverter</a></code>, <code><a href="TypeConverters.PatternConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.PatternConverter</a></code>, <code><a href="TypeConverters.SecurityProviderConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.SecurityProviderConverter</a></code>, <code><a href="TypeConverters.ShortConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.ShortConverter</a></code>, <code><a href="TypeConverters.StringConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.StringConverter</a></code>, <code><a href="TypeConverters.UriConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.UriConverter</a></code>, <code><a href="TypeConverters.UrlConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.UrlConverter</a></code>, <code><a href="TypeConverters.UuidConverter.html" title="class in org.apache.logging.log4j.core.config.plugins.convert">TypeConverters.UuidConverter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TypeConverter<T></span></div> |
| <div class="block">Interface for doing automatic String conversion to a specific type.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.1 Moved to the <code>convert</code> package.</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TypeConverter.html" title="type parameter in TypeConverter">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="#convert(java.lang.String)" class="member-name-link">convert</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> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts a String to a given type.</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="convert(java.lang.String)"> |
| <h3>convert</h3> |
| <div class="member-signature"><span class="return-type"><a href="TypeConverter.html" title="type parameter in TypeConverter">T</a></span> <span class="element-name">convert</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> s)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Converts a String to a given type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>s</code> - the String to convert. Cannot be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the converted object.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - thrown when a conversion error occurs</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 © 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> |
