Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / server / options / SystemOptionManager.html
blob: 9bfb36d9d432434b56d3b1cf135b89edf9b9e458 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SystemOptionManager (Drill : 1.20.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SystemOptionManager (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SystemOptionManager.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/server/options/SessionOptionManager.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/server/options/TypeValidators.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/server/options/SystemOptionManager.html" target="_top">Frames</a></li>
<li><a href="SystemOptionManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.server.options</div>
<h2 title="Class SystemOptionManager" class="title">Class SystemOptionManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">org.apache.drill.exec.server.options.BaseOptionManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.server.options.SystemOptionManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&gt;, <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SystemOptionManager</span>
extends <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">BaseOptionManager</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block"><p>
<a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a> that holds options within
<a href="../../../../../../org/apache/drill/exec/server/DrillbitContext.html" title="class in org.apache.drill.exec.server"><code>DrillbitContext</code></a>. Only one instance of
this class exists per drillbit. Options set at the system level affect the
entire system and persist between restarts.
</p>
<p>
All the system options are externalized into conf file. While adding a new
system option a validator should be added and the default value for the
option should be set in the conf files(example : drill-module.conf) under the
namespace drill.exec.options.
</p>
<p>
The SystemOptionManager loads all the validators and the default values for
the options are fetched from the config. The validators are populated with
the default values fetched from the config. If the option is not set in the
conf files config option is missing exception will be thrown.
</p>
<p>
If the option is set using ALTER, the value that is set will be returned.
Else the default value that is loaded into validator from the config will be
returned.
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#SystemOptionManager-org.apache.drill.common.config.DrillConfig-">SystemOptionManager</a></span>(<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig)</code>
<div class="block">Test-only, in-memory version of the system option manager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#SystemOptionManager-org.apache.drill.common.config.LogicalPlanPersistence-org.apache.drill.exec.store.sys.PersistentStoreProvider-org.apache.drill.common.config.DrillConfig-">SystemOptionManager</a></span>(<a href="../../../../../../org/apache/drill/common/config/LogicalPlanPersistence.html" title="class in org.apache.drill.common.config">LogicalPlanPersistence</a>&nbsp;lpPersistence,
<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html" title="interface in org.apache.drill.exec.store.sys">PersistentStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#SystemOptionManager-org.apache.drill.common.config.LogicalPlanPersistence-org.apache.drill.exec.store.sys.PersistentStoreProvider-org.apache.drill.common.config.DrillConfig-org.apache.drill.common.map.CaseInsensitiveMap-">SystemOptionManager</a></span>(<a href="../../../../../../org/apache/drill/common/config/LogicalPlanPersistence.html" title="class in org.apache.drill.common.config">LogicalPlanPersistence</a>&nbsp;lpPersistence,
<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html" title="interface in org.apache.drill.exec.store.sys">PersistentStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig,
<a href="../../../../../../org/apache/drill/common/map/CaseInsensitiveMap.html" title="class in org.apache.drill.common.map">CaseInsensitiveMap</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a>&gt;&nbsp;definitions)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/drill/common/map/CaseInsensitiveMap.html" title="class in org.apache.drill.common.map">CaseInsensitiveMap</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#createDefaultOptionDefinitions--">createDefaultOptionDefinitions</a></span>()</code>
<div class="block">Creates the <code>OptionDefinitions</code> to be registered with the <a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html" title="class in org.apache.drill.exec.server.options"><code>SystemOptionManager</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#deleteAllLocalOptions--">deleteAllLocalOptions</a></span>()</code>
<div class="block">Deletes all options.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#deleteLocalOption-java.lang.String-">deleteLocalOption</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Deletes the option.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#getDefault-java.lang.String-">getDefault</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;optionName)</code>
<div class="block">Gets the default value for the specified option.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#getOption-java.lang.String-">getOption</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets the option value for the given option name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#getOptionDefinition-java.lang.String-">getOptionDefinition</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets the <a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options"><code>OptionDefinition</code></a> associated with the name.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#getOptionList--">getOptionList</a></span>()</code>
<div class="block">Gets the list of options managed this manager.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.OptionScope.html" title="enum in org.apache.drill.exec.server.options">OptionValue.OptionScope</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#getScope--">getScope</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html" title="class in org.apache.drill.exec.server.options">SystemOptionManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#init--">init</a></span>()</code>
<div class="block">Initializes this option manager.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#iterator--">iterator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#setLocalOptionHelper-org.apache.drill.exec.server.options.OptionValue-">setLocalOptionHelper</a></span>(<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.server.options.BaseOptionManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.server.options.<a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">BaseOptionManager</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getBoolean-java.lang.String-">getBoolean</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getDouble-java.lang.String-">getDouble</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getInt-java.lang.String-">getInt</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getInternalOptionList--">getInternalOptionList</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getLong-java.lang.String-">getLong</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getOption-org.apache.drill.exec.server.options.TypeValidators.BooleanValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getOption-org.apache.drill.exec.server.options.TypeValidators.DoubleValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getOption-org.apache.drill.exec.server.options.TypeValidators.LongValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getOption-org.apache.drill.exec.server.options.TypeValidators.StringValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getPublicOptionList--">getPublicOptionList</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getString-java.lang.String-">getString</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-org.apache.drill.exec.server.options.OptionValue.Kind-java.lang.String-java.lang.String-">setLocalOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-java.lang.String-boolean-">setLocalOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-java.lang.String-double-">setLocalOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-java.lang.String-long-">setLocalOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-java.lang.String-java.lang.Object-">setLocalOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOption-java.lang.String-java.lang.String-">setLocalOption</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SystemOptionManager-org.apache.drill.common.config.LogicalPlanPersistence-org.apache.drill.exec.store.sys.PersistentStoreProvider-org.apache.drill.common.config.DrillConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SystemOptionManager</h4>
<pre>public&nbsp;SystemOptionManager(<a href="../../../../../../org/apache/drill/common/config/LogicalPlanPersistence.html" title="class in org.apache.drill.common.config">LogicalPlanPersistence</a>&nbsp;lpPersistence,
<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html" title="interface in org.apache.drill.exec.store.sys">PersistentStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig)</pre>
</li>
</ul>
<a name="SystemOptionManager-org.apache.drill.common.config.LogicalPlanPersistence-org.apache.drill.exec.store.sys.PersistentStoreProvider-org.apache.drill.common.config.DrillConfig-org.apache.drill.common.map.CaseInsensitiveMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SystemOptionManager</h4>
<pre>public&nbsp;SystemOptionManager(<a href="../../../../../../org/apache/drill/common/config/LogicalPlanPersistence.html" title="class in org.apache.drill.common.config">LogicalPlanPersistence</a>&nbsp;lpPersistence,
<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html" title="interface in org.apache.drill.exec.store.sys">PersistentStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig,
<a href="../../../../../../org/apache/drill/common/map/CaseInsensitiveMap.html" title="class in org.apache.drill.common.map">CaseInsensitiveMap</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a>&gt;&nbsp;definitions)</pre>
</li>
</ul>
<a name="SystemOptionManager-org.apache.drill.common.config.DrillConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SystemOptionManager</h4>
<pre>public&nbsp;SystemOptionManager(<a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;bootConfig)</pre>
<div class="block">Test-only, in-memory version of the system option manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bootConfig</code> - Drill config</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createDefaultOptionDefinitions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDefaultOptionDefinitions</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/drill/common/map/CaseInsensitiveMap.html" title="class in org.apache.drill.common.map">CaseInsensitiveMap</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a>&gt;&nbsp;createDefaultOptionDefinitions()</pre>
<div class="block">Creates the <code>OptionDefinitions</code> to be registered with the <a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html" title="class in org.apache.drill.exec.server.options"><code>SystemOptionManager</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A map</dd>
</dl>
</li>
</ul>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html" title="class in org.apache.drill.exec.server.options">SystemOptionManager</a>&nbsp;init()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Initializes this option manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this option manager</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if unable to initialize option manager</dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&gt;&nbsp;iterator()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getOption-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOption</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&nbsp;getOption(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-java.lang.String-">OptionSet</a></code></span></div>
<div class="block">Gets the option value for the given option name.
This interface also provides convenient methods to get typed option values:
<a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.BooleanValidator-"><code>OptionSet.getOption(TypeValidators.BooleanValidator validator)</code></a>,
<a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.DoubleValidator-"><code>OptionSet.getOption(TypeValidators.DoubleValidator validator)</code></a>,
<a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.LongValidator-"><code>OptionSet.getOption(TypeValidators.LongValidator validator)</code></a>, and
<a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.StringValidator-"><code>OptionSet.getOption(TypeValidators.StringValidator validator)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-java.lang.String-">getOption</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - option name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the option value, null if the option does not exist</dd>
</dl>
</li>
</ul>
<a name="getDefault-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&nbsp;getDefault(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;optionName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getDefault-java.lang.String-">OptionSet</a></code></span></div>
<div class="block">Gets the default value for the specified option.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getDefault-java.lang.String-">getDefault</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>optionName</code> - The option to retrieve the default value for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The default value for the option.</dd>
</dl>
</li>
</ul>
<a name="setLocalOptionHelper-org.apache.drill.exec.server.options.OptionValue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalOptionHelper</h4>
<pre>protected&nbsp;void&nbsp;setLocalOptionHelper(<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#setLocalOptionHelper-org.apache.drill.exec.server.options.OptionValue-">setLocalOptionHelper</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">BaseOptionManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getScope--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScope</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.OptionScope.html" title="enum in org.apache.drill.exec.server.options">OptionValue.OptionScope</a>&nbsp;getScope()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html#getScope--">getScope</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">BaseOptionManager</a></code></dd>
</dl>
</li>
</ul>
<a name="deleteLocalOption-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteLocalOption</h4>
<pre>public&nbsp;void&nbsp;deleteLocalOption(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#deleteLocalOption-java.lang.String-">OptionManager</a></code></span></div>
<div class="block">Deletes the option.
If the option name is valid (exists in the set of validators produced by <a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html#createDefaultOptionDefinitions--"><code>createDefaultOptionDefinitions()</code></a>),
but the option was not set within this manager, calling this method should be a no-op.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#deleteLocalOption-java.lang.String-">deleteLocalOption</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - option name</dd>
</dl>
</li>
</ul>
<a name="deleteAllLocalOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAllLocalOptions</h4>
<pre>public&nbsp;void&nbsp;deleteAllLocalOptions()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#deleteAllLocalOptions--">OptionManager</a></code></span></div>
<div class="block">Deletes all options.
If no options are set, calling this method should be no-op.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#deleteAllLocalOptions--">deleteAllLocalOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getOptionDefinition-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptionDefinition</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a>&nbsp;getOptionDefinition(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets the <a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options"><code>OptionDefinition</code></a> associated with the name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#getOptionDefinition-java.lang.String-">getOptionDefinition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the option</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the associated option definition</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/UserException.html" title="class in org.apache.drill.common.exceptions">UserException</a></code> - - if the definition is not found</dd>
</dl>
</li>
</ul>
<a name="getOptionList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptionList</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a>&nbsp;getOptionList()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#getOptionList--">OptionManager</a></code></span></div>
<div class="block">Gets the list of options managed this manager.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#getOptionList--">getOptionList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of options</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SystemOptionManager.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/server/options/SessionOptionManager.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/server/options/TypeValidators.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/server/options/SystemOptionManager.html" target="_top">Frames</a></li>
<li><a href="SystemOptionManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>