content/releases/2.6.2/javadocs/org/apache/storm/validation/ConfigValidationUtils.html - storm-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>ConfigValidationUtils (Storm 2.6.2 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.storm.validation, class: ConfigValidationUtils">
 <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/ConfigValidationUtils.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><a href="#nested-class-summary">Nested</a>&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="sub-nav-list">
 <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>
 <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.storm.validation</a></div>
 <h1 title="Class ConfigValidationUtils" class="title">Class ConfigValidationUtils</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.storm.validation.ConfigValidationUtils</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ConfigValidationUtils</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</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">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="ConfigValidationUtils.FieldValidator.html" class="type-name-link" title="interface in org.apache.storm.validation">ConfigValidationUtils.FieldValidator</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Declares methods for validating configuration values.</div>
 </div>
 <div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="ConfigValidationUtils.NestableFieldValidator.html" class="type-name-link" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Declares a method for validating configuration values that is nestable.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ConfigValidationUtils</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</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-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-tab1 method-summary-table-tab4"><code>static <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fv(java.lang.Class,boolean)" class="member-name-link">fv</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;cls,
  boolean&nbsp;notNull)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a new NestableFieldValidator for a given class.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listFv(java.lang.Class,boolean)" class="member-name-link">listFv</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;cls,
  boolean&nbsp;notNull)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a new NestableFieldValidator for a List of the given Class.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listFv(org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,boolean)" class="member-name-link">listFv</a><wbr>(<a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;validator,
  boolean&nbsp;notNull)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a new NestableFieldValidator for a List where each item is validated by validator.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#mapFv(java.lang.Class,java.lang.Class,boolean)" class="member-name-link">mapFv</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;val,
  boolean&nbsp;notNull)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a new NestableFieldValidator for a Map of key to val.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#mapFv(org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,boolean)" class="member-name-link">mapFv</a><wbr>(<a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;key,
  <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;val,
  boolean&nbsp;notNull)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a new NestableFieldValidator for a Map.</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/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>ConfigValidationUtils</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ConfigValidationUtils</span>()</div>
 </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="fv(java.lang.Class,boolean)">
 <h3>fv</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></span>&nbsp;<span class="element-name">fv</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;cls,
  boolean&nbsp;notNull)</span></div>
 <div class="block">Returns a new NestableFieldValidator for a given class.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>cls</code> - the Class the field should be a type of</dd>
 <dd><code>notNull</code> - whether or not a value of null is valid</dd>
 <dt>Returns:</dt>
 <dd>a NestableFieldValidator for that class</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listFv(java.lang.Class,boolean)">
 <h3>listFv</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></span>&nbsp;<span class="element-name">listFv</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;cls,
  boolean&nbsp;notNull)</span></div>
 <div class="block">Returns a new NestableFieldValidator for a List of the given Class.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>cls</code> - the Class of elements composing the list</dd>
 <dd><code>notNull</code> - whether or not a value of null is valid</dd>
 <dt>Returns:</dt>
 <dd>a NestableFieldValidator for a list of the given class</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listFv(org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,boolean)">
 <h3>listFv</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></span>&nbsp;<span class="element-name">listFv</span><wbr><span class="parameters">(<a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;validator,
  boolean&nbsp;notNull)</span></div>
 <div class="block">Returns a new NestableFieldValidator for a List where each item is validated by validator.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>validator</code> - used to validate each item in the list</dd>
 <dd><code>notNull</code> - whether or not a value of null is valid</dd>
 <dt>Returns:</dt>
 <dd>a NestableFieldValidator for a list with each item validated by a different validator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="mapFv(java.lang.Class,java.lang.Class,boolean)">
 <h3>mapFv</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></span>&nbsp;<span class="element-name">mapFv</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&nbsp;val,
  boolean&nbsp;notNull)</span></div>
 <div class="block">Returns a new NestableFieldValidator for a Map of key to val.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>key</code> - the Class of keys in the map</dd>
 <dd><code>val</code> - the Class of values in the map</dd>
 <dd><code>notNull</code> - whether or not a value of null is valid</dd>
 <dt>Returns:</dt>
 <dd>a NestableFieldValidator for a Map of key to val</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="mapFv(org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,org.apache.storm.validation.ConfigValidationUtils.NestableFieldValidator,boolean)">
 <h3>mapFv</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></span>&nbsp;<span class="element-name">mapFv</span><wbr><span class="parameters">(<a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;key,
  <a href="ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a>&nbsp;val,
  boolean&nbsp;notNull)</span></div>
 <div class="block">Returns a new NestableFieldValidator for a Map.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>key</code> - a validator for the keys in the map</dd>
 <dd><code>val</code> - a validator for the values in the map</dd>
 <dd><code>notNull</code> - whether or not a value of null is valid</dd>
 <dt>Returns:</dt>
 <dd>a NestableFieldValidator for a Map</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>