Google Git
Sign in
apache / storm-site / bb9f386abc2f384a6942d6849547a842f1080fad / . / releases / 1.1.2 / javadocs / org / apache / storm / validation / package-summary.html
blob: a6e91ab9144f404d977764075814cd566082349a [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>org.apache.storm.validation (Storm 1.1.2 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="org.apache.storm.validation (Storm 1.1.2 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/storm/utils/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/windowing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/validation/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.storm.validation</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationUtils.FieldValidator.html" title="interface in org.apache.storm.validation">ConfigValidationUtils.FieldValidator</a></td>
<td class="colLast">
<div class="block">Declares methods for validating configuration values.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.html" title="class in org.apache.storm.validation">ConfigValidation</a></td>
<td class="colLast">
<div class="block">Provides functionality for validating configuration fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.BooleanValidator.html" title="class in org.apache.storm.validation">ConfigValidation.BooleanValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.ClusterMetricRegistryValidator.html" title="class in org.apache.storm.validation">ConfigValidation.ClusterMetricRegistryValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.DoubleValidator.html" title="class in org.apache.storm.validation">ConfigValidation.DoubleValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.ImpersonationAclUserEntryValidator.html" title="class in org.apache.storm.validation">ConfigValidation.ImpersonationAclUserEntryValidator</a></td>
<td class="colLast">
<div class="block">Validates an entry for ImpersonationAclUser</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.ImplementsClassValidator.html" title="class in org.apache.storm.validation">ConfigValidation.ImplementsClassValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.IntegerValidator.html" title="class in org.apache.storm.validation">ConfigValidation.IntegerValidator</a></td>
<td class="colLast">
<div class="block">Validates a Integer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.KryoRegValidator.html" title="class in org.apache.storm.validation">ConfigValidation.KryoRegValidator</a></td>
<td class="colLast">
<div class="block">Validates Kryo Registration</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.ListEntryCustomValidator.html" title="class in org.apache.storm.validation">ConfigValidation.ListEntryCustomValidator</a></td>
<td class="colLast">
<div class="block">Validates each entry in a list against a list of custom Validators Each validator in the list of validators must inherit or be an instance of Validator class</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.ListEntryTypeValidator.html" title="class in org.apache.storm.validation">ConfigValidation.ListEntryTypeValidator</a></td>
<td class="colLast">
<div class="block">Validates each entry in a list</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.MapEntryCustomValidator.html" title="class in org.apache.storm.validation">ConfigValidation.MapEntryCustomValidator</a></td>
<td class="colLast">
<div class="block">validates each key and each value against the respective arrays of validators</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.MapEntryTypeValidator.html" title="class in org.apache.storm.validation">ConfigValidation.MapEntryTypeValidator</a></td>
<td class="colLast">
<div class="block">validates each key and value in a map of a certain type</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.MapOfStringToMapOfStringToObjectValidator.html" title="class in org.apache.storm.validation">ConfigValidation.MapOfStringToMapOfStringToObjectValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.MetricRegistryValidator.html" title="class in org.apache.storm.validation">ConfigValidation.MetricRegistryValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.NoDuplicateInListValidator.html" title="class in org.apache.storm.validation">ConfigValidation.NoDuplicateInListValidator</a></td>
<td class="colLast">
<div class="block">validates a list of has no duplicates</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.NotNullValidator.html" title="class in org.apache.storm.validation">ConfigValidation.NotNullValidator</a></td>
<td class="colLast">
<div class="block">Validates if an object is not null</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.NumberValidator.html" title="class in org.apache.storm.validation">ConfigValidation.NumberValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.PacemakerAuthTypeValidator.html" title="class in org.apache.storm.validation">ConfigValidation.PacemakerAuthTypeValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.PositiveNumberValidator.html" title="class in org.apache.storm.validation">ConfigValidation.PositiveNumberValidator</a></td>
<td class="colLast">
<div class="block">Validates a positive number</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.PowerOf2Validator.html" title="class in org.apache.storm.validation">ConfigValidation.PowerOf2Validator</a></td>
<td class="colLast">
<div class="block">Validates if a number is a power of 2</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.SimpleTypeValidator.html" title="class in org.apache.storm.validation">ConfigValidation.SimpleTypeValidator</a></td>
<td class="colLast">
<div class="block">Validates basic types</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.StringOrStringListValidator.html" title="class in org.apache.storm.validation">ConfigValidation.StringOrStringListValidator</a></td>
<td class="colLast">
<div class="block">Validates a String or a list of Strings</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.StringValidator.html" title="class in org.apache.storm.validation">ConfigValidation.StringValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.UserResourcePoolEntryValidator.html" title="class in org.apache.storm.validation">ConfigValidation.UserResourcePoolEntryValidator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidation.Validator.html" title="class in org.apache.storm.validation">ConfigValidation.Validator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.html" title="class in org.apache.storm.validation">ConfigValidationAnnotations</a></td>
<td class="colLast">
<div class="block">Note: every annotation interface must have method <code>validatorClass()</code> For every annotation there must validator class to do the validation To add another annotation for config validation, add another annotation @interface class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.ValidatorParams.html" title="class in org.apache.storm.validation">ConfigValidationAnnotations.ValidatorParams</a></td>
<td class="colLast">
<div class="block">Field names for annotations</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationUtils.html" title="class in org.apache.storm.validation">ConfigValidationUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationUtils.NestableFieldValidator.html" title="class in org.apache.storm.validation">ConfigValidationUtils.NestableFieldValidator</a></td>
<td class="colLast">
<div class="block">Declares a method for validating configuration values that is nestable.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.CustomValidator.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.CustomValidator</a></td>
<td class="colLast">
<div class="block">For custom validators</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isBoolean.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isBoolean</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isImplementationOfClass.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isImplementationOfClass</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isInteger.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isInteger</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isKryoReg.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isKryoReg</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isListEntryCustom.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isListEntryCustom</a></td>
<td class="colLast">
<div class="block">Validates each entry in a list with a list of validators Validators with fields: validatorClass and entryValidatorClass</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isListEntryType.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isListEntryType</a></td>
<td class="colLast">
<div class="block">validates each entry in a list is of a certain type</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isMapEntryCustom.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isMapEntryCustom</a></td>
<td class="colLast">
<div class="block">Validates a each key and value in a Map with a list of validators Validator with fields: validatorClass, keyValidatorClasses, valueValidatorClasses</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isMapEntryType.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isMapEntryType</a></td>
<td class="colLast">
<div class="block">Validates the type of each key and value in a map Validator with fields: validatorClass, keyValidatorClass, valueValidatorClass</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isNoDuplicateInList.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isNoDuplicateInList</a></td>
<td class="colLast">
<div class="block">Validates that there are no duplicates in a list</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isNumber.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isNumber</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isPositiveNumber.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isPositiveNumber</a></td>
<td class="colLast">
<div class="block">Checks if a number is positive and whether zero inclusive Validator with fields: validatorClass, includeZero</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isPowerOf2.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isPowerOf2</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isString.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isString</a></td>
<td class="colLast">
<div class="block">Validators with fields: validatorClass</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isStringList.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isStringList</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isStringOrStringList.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isStringOrStringList</a></td>
<td class="colLast">
<div class="block">Complex/custom type validators</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.isType.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.isType</a></td>
<td class="colLast">
<div class="block">Validators with fields: validatorClass and type</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/validation/ConfigValidationAnnotations.NotNull.html" title="annotation in org.apache.storm.validation">ConfigValidationAnnotations.NotNull</a></td>
<td class="colLast">
<div class="block">Validates on object is not null</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/utils/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/windowing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/validation/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>