blob: 071200153f4381e6029c4e97441f257540e7f046 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Level (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, class: Level">
<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/Level.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><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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</a></div>
<h1 title="Class Level" class="title">Class Level</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.logging.log4j.Level</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Level</span>
<span class="extends-implements">extends <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>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&gt;, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
<div class="block">Levels used for identifying the severity of an event. Levels are organized from most specific to least:
<p>
<table>
<caption>Level names with description</caption>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><a href="#OFF"><code>OFF</code></a></td>
<td>No events will be logged.</td>
</tr>
<tr>
<td><a href="#FATAL"><code>FATAL</code></a></td>
<td>A fatal event that will prevent the application from continuing.</td>
</tr>
<tr>
<td><a href="#ERROR"><code>ERROR</code></a></td>
<td>An error in the application, possibly recoverable.</td>
</tr>
<tr>
<td><a href="#WARN"><code>WARN</code></a></td>
<td>An event that might possible lead to an error.</td>
</tr>
<tr>
<td><a href="#INFO"><code>INFO</code></a></td>
<td>An event for informational purposes.</td>
</tr>
<tr>
<td><a href="#DEBUG"><code>DEBUG</code></a></td>
<td>A general debugging event.</td>
</tr>
<tr>
<td><a href="#TRACE"><code>TRACE</code></a></td>
<td>A fine-grained debug message, typically capturing the flow through the application.</td>
</tr>
<tr>
<td><a href="#ALL"><code>ALL</code></a></td>
<td>All events should be logged.</td>
</tr>
</table>
</p>
<p>
Typically, configuring a level in a filter or on a logger will cause logging events of that level and those that are
more specific to pass through the filter. A special level, <a href="#ALL"><code>ALL</code></a>, is guaranteed to capture all levels when
used in logging configurations.
</p></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../serialized-form.html#org.apache.logging.log4j.Level">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color"><code><a href="#ALL" class="member-name-link">ALL</a></code></div>
<div class="col-last even-row-color">
<div class="block">All events should be logged.</div>
</div>
<div class="col-first odd-row-color"><code>static final <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></code></div>
<div class="col-second odd-row-color"><code><a href="#CATEGORY" class="member-name-link">CATEGORY</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Category to be used by custom levels.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color"><code><a href="#DEBUG" class="member-name-link">DEBUG</a></code></div>
<div class="col-last even-row-color">
<div class="block">A general debugging event.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color"><code><a href="#ERROR" class="member-name-link">ERROR</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An error in the application, possibly recoverable.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color"><code><a href="#FATAL" class="member-name-link">FATAL</a></code></div>
<div class="col-last even-row-color">
<div class="block">A fatal event that will prevent the application from continuing.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color"><code><a href="#INFO" class="member-name-link">INFO</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An event for informational purposes.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color"><code><a href="#OFF" class="member-name-link">OFF</a></code></div>
<div class="col-last even-row-color">
<div class="block">No events will be logged.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color"><code><a href="#TRACE" class="member-name-link">TRACE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">A fine-grained debug message, typically capturing the flow through the application.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color"><code><a href="#WARN" class="member-name-link">WARN</a></code></div>
<div class="col-last even-row-color">
<div class="block">An event that might possible lead to an error.</div>
</div>
</div>
</section>
</li>
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compareTo(org.apache.logging.log4j.Level)" class="member-name-link">compareTo</a><wbr>(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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>&nbsp;other)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#forName(java.lang.String,int)" class="member-name-link">forName</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,
int&nbsp;intValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Retrieves an existing Level or creates on if it didn't previously exist.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDeclaringClass()" class="member-name-link">getDeclaringClass</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLevel(java.lang.String)" class="member-name-link">getLevel</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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the Level associated with the name or null if the Level cannot be found.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="spi/StandardLevel.html" title="enum in org.apache.logging.log4j.spi">StandardLevel</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStandardLevel()" class="member-name-link">getStandardLevel</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the standard Level values as an enum.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intLevel()" class="member-name-link">intLevel</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the integral value of this Level.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInRange(org.apache.logging.log4j.Level,org.apache.logging.log4j.Level)" class="member-name-link">isInRange</a><wbr>(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;minLevel,
<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;maxLevel)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this level against the levels passed as arguments and returns true if this level is in between the given
levels.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isLessSpecificThan(org.apache.logging.log4j.Level)" class="member-name-link">isLessSpecificThan</a><wbr>(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this level against the level passed as an argument and returns true if this level is the same or is less
specific.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMoreSpecificThan(org.apache.logging.log4j.Level)" class="member-name-link">isMoreSpecificThan</a><wbr>(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this level against the level passed as an argument and returns true if this level is the same or is more
specific.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#name()" class="member-name-link">name</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the symbolic name of this Level.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toLevel(java.lang.String)" class="member-name-link">toLevel</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;level)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Converts the string passed as argument to a level.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toLevel(java.lang.String,org.apache.logging.log4j.Level)" class="member-name-link">toLevel</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,
<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;defaultLevel)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Converts the string passed as argument to a level.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;T&gt;&gt;<br>T</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.Class,java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;enumType,
<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 method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns the enum constant of the specified enum type with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the Level associated with the name.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Level.html" title="class in org.apache.logging.log4j">Level</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return an array of all the Levels that have been registered.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="OFF">
<h3>OFF</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">OFF</span></div>
<div class="block">No events will be logged.</div>
</section>
</li>
<li>
<section class="detail" id="FATAL">
<h3>FATAL</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">FATAL</span></div>
<div class="block">A fatal event that will prevent the application from continuing.</div>
</section>
</li>
<li>
<section class="detail" id="ERROR">
<h3>ERROR</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">ERROR</span></div>
<div class="block">An error in the application, possibly recoverable.</div>
</section>
</li>
<li>
<section class="detail" id="WARN">
<h3>WARN</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">WARN</span></div>
<div class="block">An event that might possible lead to an error.</div>
</section>
</li>
<li>
<section class="detail" id="INFO">
<h3>INFO</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">INFO</span></div>
<div class="block">An event for informational purposes.</div>
</section>
</li>
<li>
<section class="detail" id="DEBUG">
<h3>DEBUG</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">DEBUG</span></div>
<div class="block">A general debugging event.</div>
</section>
</li>
<li>
<section class="detail" id="TRACE">
<h3>TRACE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">TRACE</span></div>
<div class="block">A fine-grained debug message, typically capturing the flow through the application.</div>
</section>
</li>
<li>
<section class="detail" id="ALL">
<h3>ALL</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">ALL</span></div>
<div class="block">All events should be logged.</div>
</section>
</li>
<li>
<section class="detail" id="CATEGORY">
<h3>CATEGORY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">CATEGORY</span></div>
<div class="block">Category to be used by custom levels.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.1</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.logging.log4j.Level.CATEGORY">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="intLevel()">
<h3>intLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">intLevel</span>()</div>
<div class="block">Gets the integral value of this Level.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of this Level.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStandardLevel()">
<h3>getStandardLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="spi/StandardLevel.html" title="enum in org.apache.logging.log4j.spi">StandardLevel</a></span>&nbsp;<span class="element-name">getStandardLevel</span>()</div>
<div class="block">Gets the standard Level values as an enum.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an enum of the standard Levels.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isInRange(org.apache.logging.log4j.Level,org.apache.logging.log4j.Level)">
<h3>isInRange</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isInRange</span><wbr><span class="parameters">(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;minLevel,
<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;maxLevel)</span></div>
<div class="block">Compares this level against the levels passed as arguments and returns true if this level is in between the given
levels.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>minLevel</code> - The minimum level to test.</dd>
<dd><code>maxLevel</code> - The maximum level to test.</dd>
<dt>Returns:</dt>
<dd>True true if this level is in between the given levels</dd>
<dt>Since:</dt>
<dd>2.4</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isLessSpecificThan(org.apache.logging.log4j.Level)">
<h3>isLessSpecificThan</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isLessSpecificThan</span><wbr><span class="parameters">(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</span></div>
<div class="block">Compares this level against the level passed as an argument and returns true if this level is the same or is less
specific.
<p>
Concretely, <a href="#ALL"><code>ALL</code></a> is less specific than <a href="#TRACE"><code>TRACE</code></a>, which is less specific than <a href="#DEBUG"><code>DEBUG</code></a>, which
is less specific than <a href="#INFO"><code>INFO</code></a>, which is less specific than <a href="#WARN"><code>WARN</code></a>, which is less specific than
<a href="#ERROR"><code>ERROR</code></a>, which is less specific than <a href="#FATAL"><code>FATAL</code></a>, and finally <a href="#OFF"><code>OFF</code></a>, which is the most specific
standard level.
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>level</code> - The level to test.</dd>
<dt>Returns:</dt>
<dd>True if this level Level is less specific or the same as the given Level.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isMoreSpecificThan(org.apache.logging.log4j.Level)">
<h3>isMoreSpecificThan</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isMoreSpecificThan</span><wbr><span class="parameters">(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;level)</span></div>
<div class="block">Compares this level against the level passed as an argument and returns true if this level is the same or is more
specific.
<p>
Concretely, <a href="#FATAL"><code>FATAL</code></a> is more specific than <a href="#ERROR"><code>ERROR</code></a>, which is more specific than <a href="#WARN"><code>WARN</code></a>,
etc., until <a href="#TRACE"><code>TRACE</code></a>, and finally <a href="#ALL"><code>ALL</code></a>, which is the least specific standard level.
The most specific level is <a href="#OFF"><code>OFF</code></a>.
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>level</code> - The level to test.</dd>
<dt>Returns:</dt>
<dd>True if this level Level is more specific or the same as the given Level.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">clone</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html" title="class or interface in java.lang" class="external-link">CloneNotSupportedException</a></span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a></code>&nbsp;in class&nbsp;<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></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html" title="class or interface in java.lang" class="external-link">CloneNotSupportedException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="compareTo(org.apache.logging.log4j.Level)">
<h3>compareTo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">compareTo</span><wbr><span class="parameters">(<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;other)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html#compareTo-T-" title="class or interface in java.lang" class="external-link">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<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>&nbsp;other)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDeclaringClass()">
<h3>getDeclaringClass</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&gt;</span>&nbsp;<span class="element-name">getDeclaringClass</span>()</div>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="name()">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">name</span>()</div>
<div class="block">Gets the symbolic name of this Level. Equivalent to calling <a href="#toString()"><code>toString()</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the name of this Level.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">toString</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="forName(java.lang.String,int)">
<h3>forName</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">forName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
int&nbsp;intValue)</span></div>
<div class="block">Retrieves an existing Level or creates on if it didn't previously exist.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the level.</dd>
<dd><code>intValue</code> - The integer value for the Level. If the level was previously created this value is ignored.</dd>
<dt>Returns:</dt>
<dd>The Level.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the name is null or intValue is less than zero.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLevel(java.lang.String)">
<h3>getLevel</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">getLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Return the Level associated with the name or null if the Level cannot be found.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the Level.</dd>
<dt>Returns:</dt>
<dd>The Level or null.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the name is null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toLevel(java.lang.String)">
<h3>toLevel</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">toLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;level)</span></div>
<div class="block">Converts the string passed as argument to a level. If the conversion fails, then this method returns
<a href="#DEBUG"><code>DEBUG</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>level</code> - The name of the desired Level.</dd>
<dt>Returns:</dt>
<dd>The Level associated with the String.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toLevel(java.lang.String,org.apache.logging.log4j.Level)">
<h3>toLevel</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">toLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="Level.html" title="class in org.apache.logging.log4j">Level</a>&nbsp;defaultLevel)</span></div>
<div class="block">Converts the string passed as argument to a level. If the conversion fails, then this method returns the value of
<code>defaultLevel</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the desired Level.</dd>
<dd><code>defaultLevel</code> - The Level to use if the String is invalid.</dd>
<dt>Returns:</dt>
<dd>The Level associated with the String.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="values()">
<h3>values</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
<div class="block">Return an array of all the Levels that have been registered.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>An array of Levels.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueOf(java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Level.html" title="class in org.apache.logging.log4j">Level</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Return the Level associated with the name.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the Level to return.</dd>
<dt>Returns:</dt>
<dd>The Level.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the Level name is <code>null</code>.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Level name is not registered.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueOf(java.lang.Class,java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;T&gt;&gt;</span>&nbsp;<span class="return-type">T</span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;enumType,
<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)</span></div>
<div class="block">Returns the enum constant of the specified enum type with the specified name. The name must match exactly an
identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</div>
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - The enum type whose constant is to be returned</dd>
<dt>Parameters:</dt>
<dd><code>enumType</code> - the <code>Class</code> object of the enum type from which to return a constant</dd>
<dd><code>name</code> - the name of the constant to return</dd>
<dt>Returns:</dt>
<dd>the enum constant of the specified enum type with the specified name</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the specified enum type has no constant with the specified name, or
the specified class object does not represent an enum type</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if <code>enumType</code> or <code>name</code> are <code>null</code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang" class="external-link"><code>Enum.valueOf(Class, String)</code></a></li>
</ul>
</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-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>