Added: websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Luhn.html ============================================================================== --- websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Luhn.html (added) +++ websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Luhn.html Wed Oct 17 03:11:28 2018 @@ -0,0 +1,268 @@ +<!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 (1.8.0_181) on Tue Oct 16 22:10:40 CDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Luhn (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)</title> +<meta name="date" content="2018-10-16"> +<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="Luhn (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Luhn.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/bval/extras/constraints/checkdigit/ISBN10Validator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/Luhn.html" target="_top">Frames</a></li> +<li><a href="Luhn.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>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</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.bval.extras.constraints.checkdigit</div> +<h2 title="Annotation Type Luhn" class="title">Annotation Type Luhn</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html?is-external=true"; title="class or interface in java.lang.annotation">@Documented</a> + @Constraint(validatedBy=<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">LuhnValidator.class</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE"; title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCT OR" title="class or interface in java.lang.annotation">CONSTRUCTOR</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>}) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) +public @interface <span class="memberNameLabel">Luhn</span></pre> +<div class="block"><p> + -- + TODO - This class is NOT part of the bean_validation spec and might disappear + as soon as a final version of the specification contains a similar functionality. + -- + </p> + Description: annotation to validate as Luhn<br/></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.optional.element.summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html#groups--">groups</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html#message--">message</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends javax.validation.Payload>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html#payload--">payload</a></span></code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="groups--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>groups</h4> +<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] groups</pre> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="message--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>message</h4> +<pre>public abstract <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> message</pre> +<dl> +<dt>Default:</dt> +<dd>"{org.apache.bval.extras.constraints.checkdigit.Luhn.message}"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="payload--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>payload</h4> +<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends javax.validation.Payload>[] payload</pre> +<dl> +<dt>Default:</dt> +<dd>{}</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/Luhn.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/bval/extras/constraints/checkdigit/ISBN10Validator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/Luhn.html" target="_top">Frames</a></li> +<li><a href="Luhn.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>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2010–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file
Added: websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html ============================================================================== --- websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html (added) +++ websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html Wed Oct 17 03:11:28 2018 @@ -0,0 +1,338 @@ +<!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 (1.8.0_181) on Tue Oct 16 22:10:40 CDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LuhnValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)</title> +<meta name="date" content="2018-10-16"> +<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="LuhnValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All 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/LuhnValidator.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/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" target="_top">Frames</a></li> +<li><a href="LuhnValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.bval.extras.constraints.checkdigit</div> +<h2 title="Class LuhnValidator" class="title">Class LuhnValidator</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/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">org.apache.bval.extras.constraints.checkdigit.ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Luhn</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.bval.extras.constraints.checkdigit.LuhnValidator</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.validation.ConstraintValidator<<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Luhn</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">LuhnValidator</span> +extends <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Luhn</a>></pre> +<div class="block">Modulus 10 <b>Luhn</b> Check Digit calculation/validation. + <p> + Luhn check digits are used, for example, by: + <ul> + <li><a href="http://en.wikipedia.org/wiki/Credit_card";>Credit Card Numbers</a></li> + <li><a href="http://en.wikipedia.org/wiki/IMEI";>IMEI Numbers</a> - International + Mobile Equipment Identity Numbers</li> + </ul> + Check digit calculation is based on <i>modulus 10</i> with digits in + an <i>odd</i> position (from right to left) being weighted 1 and <i>even</i> + position digits being weighted 2 (weighted values greater than 9 have 9 subtracted). + <p> + See <a href="http://en.wikipedia.org/wiki/Luhn_algorithm";>Wikipedia</a> + for more details.</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"> </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/bval/extras/constraints/checkdigit/LuhnValidator.html#LuhnValidator--">LuhnValidator</a></span>()</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html#weightedValue-int-int-int-">weightedValue</a></span>(int charValue, + int leftPos, + int rightPos)</code> +<div class="block">Calculates the <i>weighted</i> value of a charcter in the + code at a specified position.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.bval.extras.constraints.checkdigit.ModulusValidator"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.bval.extras.constraints.checkdigit.<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a></h3> +<code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#initialize-A-">initialize</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#isValid-java.lang.CharSequence-javax.validation.ConstraintValidatorContext-">isValid</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#sumDigits-int-">sumDigits</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#toInt-char-int-int-">toInt</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 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/ja va/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> +</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="LuhnValidator--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LuhnValidator</h4> +<pre>public LuhnValidator()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="weightedValue-int-int-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>weightedValue</h4> +<pre>protected int weightedValue(int charValue, + int leftPos, + int rightPos) + 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"><p>Calculates the <i>weighted</i> value of a charcter in the + code at a specified position.</p> + + <p>For Luhn (from right to left) <b>odd</b> digits are weighted + with a factor of <b>one</b> and <b>even</b> digits with a factor + of <b>two</b>. Weighted values > 9, have 9 subtracted</p> + + Calculates the <i>weighted</i> value of a character in the + code at a specified position. + <p> + Some modulus routines weight the value of a character + depending on its position in the code (e.g. ISBN-10), while + others use different weighting factors for odd/even positions + (e.g. EAN or Luhn). Implement the appropriate mechanism + required by overriding this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#weightedValue-int-int-int-">weightedValue</a></code> in class <code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Luhn</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>charValue</code> - The numeric value of the character</dd> +<dd><code>leftPos</code> - The position of the character in the code, counting from left to right</dd> +<dd><code>rightPos</code> - The position of the character in the code, counting from right to left</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The weighted value of the character</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/LuhnValidator.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/bval/extras/constraints/checkdigit/Luhn.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" target="_top">Frames</a></li> +<li><a href="LuhnValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2010–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file Added: websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html ============================================================================== --- websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html (added) +++ websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html Wed Oct 17 03:11:28 2018 @@ -0,0 +1,413 @@ +<!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 (1.8.0_181) on Tue Oct 16 22:10:40 CDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ModulusValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)</title> +<meta name="date" content="2018-10-16"> +<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="ModulusValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":6}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ModulusValidator.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/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" target="_top">Frames</a></li> +<li><a href="ModulusValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.bval.extras.constraints.checkdigit</div> +<h2 title="Class ModulusValidator" class="title">Class ModulusValidator<A extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>></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>org.apache.bval.extras.constraints.checkdigit.ModulusValidator<A></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>A</code> - </dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.validation.ConstraintValidator<A,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ABANumberValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ABANumberValidator</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/CUSIPValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">CUSIPValidator</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/EAN13Validator.html" title="class in org.apache.bval.extras.constraints.checkdigit">EAN13Validator</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ISBN10Validator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ISBN10Validator</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">LuhnValidator</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" title= "class in org.apache.bval.extras.constraints.checkdigit">SedolValidator</a></dd> +</dl> +<hr> +<br> +<pre>abstract class <span class="typeNameLabel">ModulusValidator<A extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>></span> +extends <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> +implements javax.validation.ConstraintValidator<A,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></pre> +<div class="block">Abstract <b>Modulus</b> Check digit calculation/validation. + <p> + Provides a <i>base</i> class for building <i>modulus</i> Check + Digit routines. + <p> + This implementation only handles <i>numeric</i> codes, such as + <b>EAN-13</b>. For <i>alphanumeric</i> codes such as <b>EAN-128</b> you + will need to implement/override the <code>toInt()</code> and + <code>toChar()</code> methods.</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"> </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/bval/extras/constraints/checkdigit/ModulusValidator.html#ModulusValidator-int-">ModulusValidator</a></span>(int modulus)</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/bval/extras/constraints/checkdigit/ModulusValidator.html#initialize-A-">initialize</a></span>(<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="type parameter in ModulusValidator">A</a> annotation)</code></td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#isValid-java.lang.CharSequence-javax.validation.ConstraintValidatorContext-">isValid</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> code, + javax.validation.ConstraintValidatorContext context)</code></td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#sumDigits-int-">sumDigits</a></span>(int number)</code> +<div class="block">Add together the individual digits in a number.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#toInt-char-int-int-">toInt</a></span>(char character, + int leftPos, + int rightPos)</code> +<div class="block">Convert a character at a specified position to an integer value.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected abstract int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#weightedValue-int-int-int-">weightedValue</a></span>(int charValue, + int leftPos, + int rightPos)</code> +<div class="block">Calculates the <i>weighted</i> value of a character in the + code at a specified position.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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/ja va/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> +</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="ModulusValidator-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ModulusValidator</h4> +<pre>public ModulusValidator(int modulus)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initialize-java.lang.annotation.Annotation-"> +<!-- --> +</a><a name="initialize-A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public final void initialize(<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="type parameter in ModulusValidator">A</a> annotation)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>initialize</code> in interface <code>javax.validation.ConstraintValidator<<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="type parameter in ModulusValidator">A</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></code></dd> +</dl> +</li> +</ul> +<a name="isValid-java.lang.CharSequence-javax.validation.ConstraintValidatorContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public boolean isValid(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> code, + javax.validation.ConstraintValidatorContext context)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>isValid</code> in interface <code>javax.validation.ConstraintValidator<<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="type parameter in ModulusValidator">A</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></code></dd> +</dl> +</li> +</ul> +<a name="weightedValue-int-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>weightedValue</h4> +<pre>protected abstract int weightedValue(int charValue, + int leftPos, + int rightPos) + 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">Calculates the <i>weighted</i> value of a character in the + code at a specified position. + <p> + Some modulus routines weight the value of a character + depending on its position in the code (e.g. ISBN-10), while + others use different weighting factors for odd/even positions + (e.g. EAN or Luhn). Implement the appropriate mechanism + required by overriding this method.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>charValue</code> - The numeric value of the character</dd> +<dd><code>leftPos</code> - The position of the character in the code, counting from left to right</dd> +<dd><code>rightPos</code> - The position of the character in the code, counting from right to left</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The weighted value of the character</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> +<a name="toInt-char-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toInt</h4> +<pre>protected int toInt(char character, + int leftPos, + int rightPos)</pre> +<div class="block">Convert a character at a specified position to an integer value. + <p> + <b>Note:</b> this implementation only handlers numeric values + For non-numeric characters, override this method to provide + character-->integer conversion.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>character</code> - The character to convert</dd> +<dd><code>leftPos</code> - The position of the character in the code, counting from left to right</dd> +<dd><code>rightPos</code> - The positionof the character in the code, counting from right to left</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The integer value of the character</dd> +</dl> +</li> +</ul> +<a name="sumDigits-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sumDigits</h4> +<pre>protected static int sumDigits(int number)</pre> +<div class="block">Add together the individual digits in a number.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>number</code> - The number whose digits are to be added</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The sum of the digits</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/ModulusValidator.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/bval/extras/constraints/checkdigit/LuhnValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" target="_top">Frames</a></li> +<li><a href="ModulusValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2010–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file Added: websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Sedol.html ============================================================================== --- websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Sedol.html (added) +++ websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/Sedol.html Wed Oct 17 03:11:28 2018 @@ -0,0 +1,268 @@ +<!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 (1.8.0_181) on Tue Oct 16 22:10:40 CDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Sedol (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)</title> +<meta name="date" content="2018-10-16"> +<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="Sedol (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Sedol.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/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/Sedol.html" target="_top">Frames</a></li> +<li><a href="Sedol.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>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</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.bval.extras.constraints.checkdigit</div> +<h2 title="Annotation Type Sedol" class="title">Annotation Type Sedol</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html?is-external=true"; title="class or interface in java.lang.annotation">@Documented</a> + @Constraint(validatedBy=<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">SedolValidator.class</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE"; title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCT OR" title="class or interface in java.lang.annotation">CONSTRUCTOR</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>}) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) +public @interface <span class="memberNameLabel">Sedol</span></pre> +<div class="block"><p> + -- + TODO - This class is NOT part of the bean_validation spec and might disappear + as soon as a final version of the specification contains a similar functionality. + -- + </p> + Description: annotation to validate as Sedol<br/></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.optional.element.summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html#groups--">groups</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html#message--">message</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends javax.validation.Payload>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html#payload--">payload</a></span></code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="groups--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>groups</h4> +<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] groups</pre> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="message--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>message</h4> +<pre>public abstract <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> message</pre> +<dl> +<dt>Default:</dt> +<dd>"{org.apache.bval.extras.constraints.checkdigit.Sedol.message}"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="payload--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>payload</h4> +<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends javax.validation.Payload>[] payload</pre> +<dl> +<dt>Default:</dt> +<dd>{}</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/Sedol.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/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/Sedol.html" target="_top">Frames</a></li> +<li><a href="Sedol.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>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2010–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file Added: websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/SedolValidator.html ============================================================================== --- websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/SedolValidator.html (added) +++ websites/production/bval/content/mvnsite/apidocs/org/apache/bval/extras/constraints/checkdigit/SedolValidator.html Wed Oct 17 03:11:28 2018 @@ -0,0 +1,366 @@ +<!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 (1.8.0_181) on Tue Oct 16 22:10:40 CDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SedolValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)</title> +<meta name="date" content="2018-10-16"> +<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="SedolValidator (Apache BVal :: bval-extras (optional) 2.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All 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/SedolValidator.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/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Verhoeff.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" target="_top">Frames</a></li> +<li><a href="SedolValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.bval.extras.constraints.checkdigit</div> +<h2 title="Class SedolValidator" class="title">Class SedolValidator</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/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">org.apache.bval.extras.constraints.checkdigit.ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Sedol</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.bval.extras.constraints.checkdigit.SedolValidator</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.validation.ConstraintValidator<<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Sedol</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a>></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">SedolValidator</span> +extends <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Sedol</a>></pre> +<div class="block">Modulus 10 <b>SEDOL</b> (UK Securities) Check Digit calculation/validation. + <p> + SEDOL Numbers are 7 character alphanumeric codes used + to identify UK Securities (SEDOL stands for Stock Exchange Daily Official List). + <p> + Check digit calculation is based on <i>modulus 10</i> with digits being weighted + based on their position, from left to right, as follows: + <p> + <pre><code> + position: 1 2 3 4 5 6 7 + weighting: 1 3 1 7 3 9 1 + </code></pre> + <p> + See <a href="http://en.wikipedia.org/wiki/SEDOL";>Wikipedia - SEDOL</a> + for more details.</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"> </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/bval/extras/constraints/checkdigit/SedolValidator.html#SedolValidator--">SedolValidator</a></span>()</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html#toInt-char-int-int-">toInt</a></span>(char character, + int leftPos, + int rightPos)</code> +<div class="block">Convert a character at a specified position to an integer value.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/SedolValidator.html#weightedValue-int-int-int-">weightedValue</a></span>(int charValue, + int leftPos, + int rightPos)</code> +<div class="block">Calculates the <i>weighted</i> value of a character in the + code at a specified position.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.bval.extras.constraints.checkdigit.ModulusValidator"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.bval.extras.constraints.checkdigit.<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a></h3> +<code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#initialize-A-">initialize</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#isValid-java.lang.CharSequence-javax.validation.ConstraintValidatorContext-">isValid</a>, <a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#sumDigits-int-">sumDigits</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 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/ja va/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> +</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="SedolValidator--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SedolValidator</h4> +<pre>public SedolValidator()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="weightedValue-int-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>weightedValue</h4> +<pre>protected int weightedValue(int charValue, + int leftPos, + int rightPos) + 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">Calculates the <i>weighted</i> value of a character in the + code at a specified position. + <p> + Some modulus routines weight the value of a character + depending on its position in the code (e.g. ISBN-10), while + others use different weighting factors for odd/even positions + (e.g. EAN or Luhn). Implement the appropriate mechanism + required by overriding this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#weightedValue-int-int-int-">weightedValue</a></code> in class <code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Sedol</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>charValue</code> - The numeric value of the character</dd> +<dd><code>leftPos</code> - The position of the character in the code, counting from left to right</dd> +<dd><code>rightPos</code> - The position of the character in the code, counting from right to left</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The weighted value of the character</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> +<a name="toInt-char-int-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toInt</h4> +<pre>protected int toInt(char character, + int leftPos, + int rightPos)</pre> +<div class="block">Convert a character at a specified position to an integer value. + <p> + <b>Note:</b> this implementation only handlers numeric values + For non-numeric characters, override this method to provide + character-->integer conversion.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html#toInt-char-int-int-">toInt</a></code> in class <code><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/ModulusValidator.html" title="class in org.apache.bval.extras.constraints.checkdigit">ModulusValidator</a><<a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit">Sedol</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>character</code> - The character to convert</dd> +<dd><code>leftPos</code> - The position of the character in the code, counting from left to right</dd> +<dd><code>rightPos</code> - The positionof the character in the code, counting from right to left</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The integer value of the character</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/SedolValidator.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/bval/extras/constraints/checkdigit/Sedol.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/bval/extras/constraints/checkdigit/Verhoeff.html" title="annotation in org.apache.bval.extras.constraints.checkdigit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/bval/extras/constraints/checkdigit/SedolValidator.html" target="_top">Frames</a></li> +<li><a href="SedolValidator.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2010–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file
