blob: c784837826ed12b538dc41b4dd8e74172f026535 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.logging.log4j.core.config.plugins.util.PluginType (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="use: package: org.apache.logging.log4j.core.config.plugins.util, class: PluginType">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Class org.apache.logging.log4j.core.config.plugins.util.PluginType" class="title">Uses of Class<br>org.apache.logging.log4j.core.config.plugins.util.PluginType</h1>
</div>
<div class="caption"><span>Packages that use <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.config">org.apache.logging.log4j.core.config</a></div>
<div class="col-last even-row-color">
<div class="block">Configuration of Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.config.plugins.util">org.apache.logging.log4j.core.config.plugins.util</a></div>
<div class="col-last odd-row-color">
<div class="block">Utility and manager classes for Log4j 2 plugins.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j.core.config">
<h2>Uses of <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a> in <a href="../../../package-summary.html">org.apache.logging.log4j.core.config</a></h2>
<div class="caption"><span>Methods in <a href="../../../package-summary.html">org.apache.logging.log4j.core.config</a> that return <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Node.</span><code><a href="../../../Node.html#getType()" class="member-name-link">getType</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../../../package-summary.html">org.apache.logging.log4j.core.config</a> with parameters of type <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractConfiguration.</span><code><a href="../../../AbstractConfiguration.html#createPluginObject(org.apache.logging.log4j.core.config.plugins.util.PluginType,org.apache.logging.log4j.core.config.Node)" class="member-name-link">createPluginObject</a><wbr>(<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&nbsp;type,
<a href="../../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&nbsp;node)</code></div>
<div class="col-last even-row-color">
<div class="block">This method is used by Arbiters to create specific children.</div>
</div>
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractConfiguration.</span><code><a href="../../../AbstractConfiguration.html#processSelect(org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.config.plugins.util.PluginType)" class="member-name-link">processSelect</a><wbr>(<a href="../../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&nbsp;selectNode,
<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&nbsp;type)</code></div>
<div class="col-last odd-row-color">
<div class="block">Handle Select nodes.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../../../package-summary.html">org.apache.logging.log4j.core.config</a> with parameters of type <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../Node.html#%3Cinit%3E(org.apache.logging.log4j.core.config.Node,java.lang.String,org.apache.logging.log4j.core.config.plugins.util.PluginType)" class="member-name-link">Node</a><wbr>(<a href="../../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&nbsp;parent,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&nbsp;type)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new instance of <code>Node</code> and initializes it
with a name and the corresponding XML element.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.config.plugins.util">
<h2>Uses of <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a> in <a href="../package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a> that return <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PluginManager.</span><code><a href="../PluginManager.html#getPluginType(java.lang.String)" class="member-name-link">getPluginType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns the type of a specified plugin.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a> that return types with arguments of type <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<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"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PluginUtil.</span><code><a href="../PluginUtil.html#collectPluginsByCategory(java.lang.String)" class="member-name-link">collectPluginsByCategory</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;category)</code></div>
<div class="col-last even-row-color">
<div class="block">Shortcut for collecting plugins matching with the given <code>category</code>.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PluginUtil.</span><code><a href="../PluginUtil.html#collectPluginsByCategoryAndPackage(java.lang.String,java.util.List)" class="member-name-link">collectPluginsByCategoryAndPackage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;category,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;&nbsp;packages)</code></div>
<div class="col-last odd-row-color">
<div class="block">Short for collecting plugins matching with the given <code>category</code> in provided <code>packages</code>.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PluginManager.</span><code><a href="../PluginManager.html#getPlugins()" class="member-name-link">getPlugins</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns all the matching plugins.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;&gt;&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PluginRegistry.</span><code><a href="../PluginRegistry.html#getPluginsByCategoryByBundleId()" class="member-name-link">getPluginsByCategoryByBundleId</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PluginRegistry.</span><code><a href="../PluginRegistry.html#loadFromBundle(long,java.lang.ClassLoader)" class="member-name-link">loadFromBundle</a><wbr>(long&nbsp;bundleId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PluginRegistry.</span><code><a href="../PluginRegistry.html#loadFromMainClassLoader()" class="member-name-link">loadFromMainClassLoader</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<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>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&gt;&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PluginRegistry.</span><code><a href="../PluginRegistry.html#loadFromPackage(java.lang.String)" class="member-name-link">loadFromPackage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pkg)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a> with parameters of type <a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../PluginBuilder.html#%3Cinit%3E(org.apache.logging.log4j.core.config.plugins.util.PluginType)" class="member-name-link">PluginBuilder</a><wbr>(<a href="../PluginType.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginType</a>&lt;?&gt;&nbsp;pluginType)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a PluginBuilder for a given PluginType.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>