| <!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>OptionManager (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="OptionManager (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OptionManager.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/OptionList.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/server/options/OptionMetaData.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/server/options/OptionManager.html" target="_top">Frames</a></li> |
| <li><a href="OptionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface OptionManager" class="title">Interface OptionManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><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><<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/server/options/BaseOptionManager.html" title="class in org.apache.drill.exec.server.options">BaseOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/FallbackOptionManager.html" title="class in org.apache.drill.exec.server.options">FallbackOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/FragmentOptionManager.html" title="class in org.apache.drill.exec.server.options">FragmentOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/InMemoryOptionManager.html" title="class in org.apache.drill.exec.server.options">InMemoryOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/QueryOptionManager.html" title="class in org.apache.drill.exec.server.options">QueryOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/SessionOptionManager.html" title="class in org.apache.drill.exec.server.options">SessionOptionManager</a>, <a href="../../../../../../org/apache/drill/exec/server/options/SystemOptionManager.html" title="class in org.apache.drill.exec.server.options">SystemOptionManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OptionManager</span> |
| extends <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</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><<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options">OptionValue</a>></pre> |
| <div class="block">Manager for Drill <a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.html" title="class in org.apache.drill.exec.server.options"><code>options</code></a>. Implementations must be case-insensitive to the name of an option. |
| |
| The options governed by an <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a> fall into various categories. These categories are described below. |
| |
| <ul> |
| <li> |
| <b>Local:</b> Local options are options who have a value stored in this <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>. Whether an option is <b>Local</b> to an <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a> or not should |
| be irrelevant to the user. |
| </li> |
| <li> |
| <b>Public:</b> Public options are options that are visible to end users in all the standard tables and rest endpoints. |
| </li> |
| <li> |
| <b>Internal:</b> Internal options are options that are only visible to end users if they check special tables and rest endpoints that are not documented. These options |
| are not intended to be modified by users and should only be modified by support during debugging. Internal options are also not gauranteed to be consistent accross |
| patch, minor, or major releases. |
| </li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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/OptionManager.html#deleteAllLocalOptions--">deleteAllLocalOptions</a></span>()</code> |
| <div class="block">Deletes all options.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.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> name)</code> |
| <div class="block">Deletes the option.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>@NotNull <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/OptionManager.html#getInternalOptionList--">getInternalOptionList</a></span>()</code> |
| <div class="block">Returns all the internal options contained in this option manager.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>@NotNull <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/OptionManager.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> name)</code> |
| <div class="block">Get the option definition corresponding to the given option name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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/OptionManager.html#getOptionList--">getOptionList</a></span>()</code> |
| <div class="block">Gets the list of options managed this manager.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>@NotNull <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/OptionManager.html#getPublicOptionList--">getPublicOptionList</a></span>()</code> |
| <div class="block">Returns all the public options contained in this option manager.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-org.apache.drill.exec.server.options.OptionValue.Kind-java.lang.String-java.lang.String-">setLocalOption</a></span>(<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.Kind.html" title="enum in org.apache.drill.exec.server.options">OptionValue.Kind</a> kind, |
| <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> name, |
| <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> value)</code> |
| <div class="block">Sets an option of the specified <a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.Kind.html" title="enum in org.apache.drill.exec.server.options"><code>OptionValue.Kind</code></a> on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-java.lang.String-boolean-">setLocalOption</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> name, |
| boolean value)</code> |
| <div class="block">Sets a boolean option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-java.lang.String-double-">setLocalOption</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> name, |
| double value)</code> |
| <div class="block">Sets a double option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-java.lang.String-long-">setLocalOption</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> name, |
| long value)</code> |
| <div class="block">Sets a long option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-java.lang.String-java.lang.Object-">setLocalOption</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> name, |
| <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> value)</code> |
| <div class="block">Sets an option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html#setLocalOption-java.lang.String-java.lang.String-">setLocalOption</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> name, |
| <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> value)</code> |
| <div class="block">Sets a String option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.server.options.OptionSet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.server.options.<a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html" title="interface in org.apache.drill.exec.server.options">OptionSet</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getBoolean-java.lang.String-">getBoolean</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getDefault-java.lang.String-">getDefault</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getDouble-java.lang.String-">getDouble</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getInt-java.lang.String-">getInt</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getLong-java.lang.String-">getLong</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-java.lang.String-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.BooleanValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.DoubleValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.LongValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getOption-org.apache.drill.exec.server.options.TypeValidators.StringValidator-">getOption</a>, <a href="../../../../../../org/apache/drill/exec/server/options/OptionSet.html#getString-java.lang.String-">getString</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 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#iterator--" title="class or interface in java.lang">iterator</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setLocalOption-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<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> name, |
| boolean value)</pre> |
| <div class="block">Sets a boolean option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalOption-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<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> name, |
| long value)</pre> |
| <div class="block">Sets a long option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalOption-java.lang.String-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<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> name, |
| double value)</pre> |
| <div class="block">Sets a double option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalOption-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<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> name, |
| <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> value)</pre> |
| <div class="block">Sets a String option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalOption-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<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> name, |
| <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> value)</pre> |
| <div class="block">Sets an option on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalOption-org.apache.drill.exec.server.options.OptionValue.Kind-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalOption</h4> |
| <pre>void setLocalOption(<a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.Kind.html" title="enum in org.apache.drill.exec.server.options">OptionValue.Kind</a> kind, |
| <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> name, |
| <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> value)</pre> |
| <div class="block">Sets an option of the specified <a href="../../../../../../org/apache/drill/exec/server/options/OptionValue.Kind.html" title="enum in org.apache.drill.exec.server.options"><code>OptionValue.Kind</code></a> on the <a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options"><code>OptionManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>kind</code> - The kind of the option.</dd> |
| <dd><code>name</code> - The name of the option.</dd> |
| <dd><code>value</code> - The value of the option.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteLocalOption-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteLocalOption</h4> |
| <pre>void 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> name)</pre> |
| <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>SystemOptionManager.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="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - option name</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> - message to describe error with value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAllLocalOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAllLocalOptions</h4> |
| <pre>void deleteAllLocalOptions()</pre> |
| <div class="block">Deletes all options. |
| |
| If no options are set, calling this method should be no-op.</div> |
| <dl> |
| <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> - message to describe error with value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOptionDefinition-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptionDefinition</h4> |
| <pre>@NotNull |
| @NotNull <a href="../../../../../../org/apache/drill/exec/server/options/OptionDefinition.html" title="class in org.apache.drill.exec.server.options">OptionDefinition</a> 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> name)</pre> |
| <div class="block">Get the option definition corresponding to the given option name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the option to retrieve a validator for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The option validator corresponding to the given option name.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>UserException</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><a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a> getOptionList()</pre> |
| <div class="block">Gets the list of options managed this manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInternalOptionList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInternalOptionList</h4> |
| <pre>@NotNull |
| @NotNull <a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a> getInternalOptionList()</pre> |
| <div class="block">Returns all the internal options contained in this option manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>All the internal options contained in this option manager.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPublicOptionList--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPublicOptionList</h4> |
| <pre>@NotNull |
| @NotNull <a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a> getPublicOptionList()</pre> |
| <div class="block">Returns all the public options contained in this option manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>All the public options contained in this option manager.</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/OptionManager.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/OptionList.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/server/options/OptionMetaData.html" title="class in org.apache.drill.exec.server.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/server/options/OptionManager.html" target="_top">Frames</a></li> |
| <li><a href="OptionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
