summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/DataTypeValidator.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
committerRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
commit8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch)
tree9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/DataTypeValidator.html
parent076be316935180341d7ee7a9335281a4b18d1fa9 (diff)
downloadcaxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz
caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/DataTypeValidator.html')
-rw-r--r--doc/Axlsx/DataTypeValidator.html316
1 files changed, 0 insertions, 316 deletions
diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html
deleted file mode 100644
index b120e469..00000000
--- a/doc/Axlsx/DataTypeValidator.html
+++ /dev/null
@@ -1,316 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
- Class: Axlsx::DataTypeValidator
-
- &mdash; AXLSX
-
-</title>
-
- <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-
- <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- relpath = '..';
- if (relpath != '') relpath += '/';
-</script>
-
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-
-
- </head>
- <body>
- <script type="text/javascript" charset="utf-8">
- if (window.top.frames.main) document.body.className = 'frames';
- </script>
-
- <div id="header">
- <div id="menu">
-
- <a href="../_index.html">Index (D)</a> &raquo;
- <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
- &raquo;
- <span class="title">DataTypeValidator</span>
-
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
- <div id="search">
-
- <a id="class_list_link" href="#">Class List</a>
-
- <a id="method_list_link" href="#">Method List</a>
-
- <a id="file_list_link" href="#">File List</a>
-
-</div>
- <div class="clear"></div>
- </div>
-
- <iframe id="search_frame"></iframe>
-
- <div id="content"><h1>Class: Axlsx::DataTypeValidator
-
-
-
-</h1>
-
-<dl class="box">
-
- <dt class="r1">Inherits:</dt>
- <dd class="r1">
- <span class="inheritName">Object</span>
-
- <ul class="fullTree">
- <li>Object</li>
-
- <li class="next">Axlsx::DataTypeValidator</li>
-
- </ul>
- <a href="#" class="inheritanceTree">show all</a>
-
- </dd>
-
-
-
-
-
-
-
-
-
- <dt class="r2 last">Defined in:</dt>
- <dd class="r2 last">lib/axlsx/util/validators.rb</dd>
-
-</dl>
-<div class="clear"></div>
-
-<h2>Overview</h2><div class="docstring">
- <div class="discussion">
-
-<p>Validate that the class of the value provided is either an instance or the
-class of the allowed types and that any specified additional validation
-returns true.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div>
-
-
-
-
-
- <h2>
- Class Method Summary
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
- </h2>
-
- <ul class="summary">
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, types, v, other = lambda{|arg| true }) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Perform validation.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-
-
- <div id="class_method_details" class="method_details_list">
- <h2>Class Method Details</h2>
-
-
- <div class="method_details first">
- <p class="signature first" id="validate-class_method">
-
- + (<tt>Boolean</tt>) <strong>validate</strong>(name, types, v, other = lambda{|arg| true })
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Perform validation</p>
-
-
- </div>
-</div>
-<div class="tags">
- <h3>Parameters:</h3>
-<ul class="param">
-
- <li>
-
- <span class='name'>name</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>The name of what is being validated. This is included in the error message</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>types</span>
-
-
- <span class='type'>(<tt>Array</tt>, <tt>Class</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>A single class or array of classes that the value is validated against.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>other</span>
-
-
- <span class='type'>(<tt>Block</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>lambda{|arg| true }</tt>)</em>
-
-
- &mdash;
- <div class='inline'>
-<p>Any block that must evaluate to true for the value to be valid</p>
-</div>
-
- </li>
-
-</ul>
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>true if validation succeeds.</p>
-</div>
-
- </li>
-
-</ul>
-<h3>Raises:</h3>
-<ul class="raise">
-
- <li>
-
-
- <span class='type'>(<tt>ArugumentError</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>Raised if the class of the value provided is not in the specified array of
-types or the block passed returns false</p>
-</div>
-
- </li>
-
-</ul>
-
- <h3>See Also:</h3>
- <ul class="see">
-
- <li><span class='object_link'><a href="../Axlsx.html#validate_boolean-class_method" title="Axlsx.validate_boolean (method)">Axlsx.validate_boolean</a></span></li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 34</span>
-
-<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='other identifier id'>other</span><span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span><span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='arg identifier id'>arg</span><span class='bitor op'>|</span> <span class='true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
- <span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='types identifier id'>types</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span>
- <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='false false kw'>false</span>
- <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Class constant id'>Class</span>
- <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='ancestors identifier id'>ancestors</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
- <span class='else else kw'>else</span>
- <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
- <span class='end end kw'>end</span>
- <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_TYPE constant id'>ERR_TYPE</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='other identifier id'>other</span><span class='dot token'>.</span><span class='call identifier id'>call</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='andop op'>&amp;&amp;</span> <span class='valid_type identifier id'>valid_type</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-</div>
-
- <div id="footer">
- Generated on Wed Nov 30 08:46:27 2011 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.7.3 (ruby-1.8.7).
-</div>
-
- </body>
-</html> \ No newline at end of file