| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html |
| 3 |
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 4 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 5 |
|
| 6 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 7 |
<head> |
| 8 |
<title>Module: Kwalify::Types</title> |
| 9 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| 10 |
<meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| 11 |
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> |
| 12 |
<script type="text/javascript"> |
| 13 |
// <![CDATA[ |
| 14 |
|
| 15 |
function popupCode( url ) { |
| 16 |
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") |
| 17 |
} |
| 18 |
|
| 19 |
function toggleCode( id ) { |
| 20 |
if ( document.getElementById ) |
| 21 |
elem = document.getElementById( id ); |
| 22 |
else if ( document.all ) |
| 23 |
elem = eval( "document.all." + id ); |
| 24 |
else |
| 25 |
return false; |
| 26 |
|
| 27 |
elemStyle = elem.style; |
| 28 |
|
| 29 |
if ( elemStyle.display != "block" ) { |
| 30 |
elemStyle.display = "block" |
| 31 |
} else { |
| 32 |
elemStyle.display = "none" |
| 33 |
} |
| 34 |
|
| 35 |
return true; |
| 36 |
} |
| 37 |
|
| 38 |
// Make codeblocks hidden by default |
| 39 |
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) |
| 40 |
|
| 41 |
// ]]> |
| 42 |
</script> |
| 43 |
|
| 44 |
</head> |
| 45 |
<body> |
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
<div id="classHeader"> |
| 50 |
<table class="header-table"> |
| 51 |
<tr class="top-aligned-row"> |
| 52 |
<td><strong>Module</strong></td> |
| 53 |
<td class="class-name-in-header">Kwalify::Types</td> |
| 54 |
</tr> |
| 55 |
<tr class="top-aligned-row"> |
| 56 |
<td><strong>In:</strong></td> |
| 57 |
<td> |
| 58 |
<a href="../../files/kwalify/types_rb.html"> |
| 59 |
kwalify/types.rb |
| 60 |
</a> |
| 61 |
<br /> |
| 62 |
</td> |
| 63 |
</tr> |
| 64 |
|
| 65 |
</table> |
| 66 |
</div> |
| 67 |
<!-- banner header --> |
| 68 |
|
| 69 |
<div id="bodyContent"> |
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
<div id="contextContent"> |
| 74 |
|
| 75 |
|
| 76 |
|
| 77 |
</div> |
| 78 |
|
| 79 |
<div id="method-list"> |
| 80 |
<h3 class="section-bar">Methods</h3> |
| 81 |
|
| 82 |
<div class="name-list"> |
| 83 |
<a href="#M000011">collection?</a> |
| 84 |
<a href="#M000013">collection_type?</a> |
| 85 |
<a href="#M000010">get_type_class</a> |
| 86 |
<a href="#M000012">scalar?</a> |
| 87 |
<a href="#M000014">scalar_type?</a> |
| 88 |
<a href="#M000009">type_class</a> |
| 89 |
<a href="#M000008">type_table</a> |
| 90 |
</div> |
| 91 |
</div> |
| 92 |
|
| 93 |
</div> |
| 94 |
|
| 95 |
|
| 96 |
<!-- if includes --> |
| 97 |
|
| 98 |
<div id="section"> |
| 99 |
|
| 100 |
|
| 101 |
<div id="constants-list"> |
| 102 |
<h3 class="section-bar">Constants</h3> |
| 103 |
|
| 104 |
<div class="name-list"> |
| 105 |
<table summary="Constants"> |
| 106 |
<tr class="top-aligned-row context-row"> |
| 107 |
<td class="context-item-name">DEFAULT_TYPE</td> |
| 108 |
<td>=</td> |
| 109 |
<td class="context-item-value">"str"</td> |
| 110 |
</tr> |
| 111 |
</table> |
| 112 |
</div> |
| 113 |
</div> |
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
<!-- if method_list --> |
| 121 |
<div id="methods"> |
| 122 |
<h3 class="section-bar">Public Class methods</h3> |
| 123 |
|
| 124 |
<div id="method-M000010" class="method-detail"> |
| 125 |
<a name="M000010"></a> |
| 126 |
|
| 127 |
<div class="method-heading"> |
| 128 |
<a href="#M000010" class="method-signature"> |
| 129 |
<span class="method-name">get_type_class</span><span class="method-args">(type)</span> |
| 130 |
</a> |
| 131 |
</div> |
| 132 |
|
| 133 |
<div class="method-description"> |
| 134 |
<p><a class="source-toggle" href="#" |
| 135 |
onclick="toggleCode('M000010-source');return false;">[Source]</a></p> |
| 136 |
<div class="method-source-code" id="M000010-source"> |
| 137 |
<pre> |
| 138 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 119</span> |
| 139 |
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_type_class</span>(<span class="ruby-identifier">type</span>) |
| 140 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">type_class</span>(<span class="ruby-identifier">type</span>) |
| 141 |
<span class="ruby-keyword kw">end</span> |
| 142 |
</pre> |
| 143 |
</div> |
| 144 |
</div> |
| 145 |
</div> |
| 146 |
|
| 147 |
<div id="method-M000009" class="method-detail"> |
| 148 |
<a name="M000009"></a> |
| 149 |
|
| 150 |
<div class="method-heading"> |
| 151 |
<a href="#M000009" class="method-signature"> |
| 152 |
<span class="method-name">type_class</span><span class="method-args">(type)</span> |
| 153 |
</a> |
| 154 |
</div> |
| 155 |
|
| 156 |
<div class="method-description"> |
| 157 |
<p><a class="source-toggle" href="#" |
| 158 |
onclick="toggleCode('M000009-source');return false;">[Source]</a></p> |
| 159 |
<div class="method-source-code" id="M000009-source"> |
| 160 |
<pre> |
| 161 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 113</span> |
| 162 |
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">type_class</span>(<span class="ruby-identifier">type</span>) |
| 163 |
<span class="ruby-identifier">klass</span> = <span class="ruby-ivar">@@type_table</span>[<span class="ruby-identifier">type</span>] |
| 164 |
<span class="ruby-comment cmt">#assert_error('type=#{type.inspect}') unless klass</span> |
| 165 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">klass</span> |
| 166 |
<span class="ruby-keyword kw">end</span> |
| 167 |
</pre> |
| 168 |
</div> |
| 169 |
</div> |
| 170 |
</div> |
| 171 |
|
| 172 |
<div id="method-M000008" class="method-detail"> |
| 173 |
<a name="M000008"></a> |
| 174 |
|
| 175 |
<div class="method-heading"> |
| 176 |
<a href="#M000008" class="method-signature"> |
| 177 |
<span class="method-name">type_table</span><span class="method-args">()</span> |
| 178 |
</a> |
| 179 |
</div> |
| 180 |
|
| 181 |
<div class="method-description"> |
| 182 |
<p><a class="source-toggle" href="#" |
| 183 |
onclick="toggleCode('M000008-source');return false;">[Source]</a></p> |
| 184 |
<div class="method-source-code" id="M000008-source"> |
| 185 |
<pre> |
| 186 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 109</span> |
| 187 |
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">type_table</span> |
| 188 |
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@@type_table</span> |
| 189 |
<span class="ruby-keyword kw">end</span> |
| 190 |
</pre> |
| 191 |
</div> |
| 192 |
</div> |
| 193 |
</div> |
| 194 |
|
| 195 |
<h3 class="section-bar">Public Instance methods</h3> |
| 196 |
|
| 197 |
<div id="method-M000011" class="method-detail"> |
| 198 |
<a name="M000011"></a> |
| 199 |
|
| 200 |
<div class="method-heading"> |
| 201 |
<a href="#M000011" class="method-signature"> |
| 202 |
<span class="method-name">collection?</span><span class="method-args">(val)</span> |
| 203 |
</a> |
| 204 |
</div> |
| 205 |
|
| 206 |
<div class="method-description"> |
| 207 |
<p><a class="source-toggle" href="#" |
| 208 |
onclick="toggleCode('M000011-source');return false;">[Source]</a></p> |
| 209 |
<div class="method-source-code" id="M000011-source"> |
| 210 |
<pre> |
| 211 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 134</span> |
| 212 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collection?</span>(<span class="ruby-identifier">val</span>) |
| 213 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) |
| 214 |
<span class="ruby-keyword kw">end</span> |
| 215 |
</pre> |
| 216 |
</div> |
| 217 |
</div> |
| 218 |
</div> |
| 219 |
|
| 220 |
<div id="method-M000013" class="method-detail"> |
| 221 |
<a name="M000013"></a> |
| 222 |
|
| 223 |
<div class="method-heading"> |
| 224 |
<a href="#M000013" class="method-signature"> |
| 225 |
<span class="method-name">collection_type?</span><span class="method-args">(type)</span> |
| 226 |
</a> |
| 227 |
</div> |
| 228 |
|
| 229 |
<div class="method-description"> |
| 230 |
<p><a class="source-toggle" href="#" |
| 231 |
onclick="toggleCode('M000013-source');return false;">[Source]</a></p> |
| 232 |
<div class="method-source-code" id="M000013-source"> |
| 233 |
<pre> |
| 234 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 143</span> |
| 235 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collection_type?</span>(<span class="ruby-identifier">type</span>) |
| 236 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'seq'</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'map'</span> |
| 237 |
<span class="ruby-keyword kw">end</span> |
| 238 |
</pre> |
| 239 |
</div> |
| 240 |
</div> |
| 241 |
</div> |
| 242 |
|
| 243 |
<div id="method-M000012" class="method-detail"> |
| 244 |
<a name="M000012"></a> |
| 245 |
|
| 246 |
<div class="method-heading"> |
| 247 |
<a href="#M000012" class="method-signature"> |
| 248 |
<span class="method-name">scalar?</span><span class="method-args">(val)</span> |
| 249 |
</a> |
| 250 |
</div> |
| 251 |
|
| 252 |
<div class="method-description"> |
| 253 |
<p><a class="source-toggle" href="#" |
| 254 |
onclick="toggleCode('M000012-source');return false;">[Source]</a></p> |
| 255 |
<div class="method-source-code" id="M000012-source"> |
| 256 |
<pre> |
| 257 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 138</span> |
| 258 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scalar?</span>(<span class="ruby-identifier">val</span>) |
| 259 |
<span class="ruby-comment cmt">#return !val.is_a?(Array) && !val.is_a?(Hash) && val.class != Object</span> |
| 260 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">Scalar</span>) <span class="ruby-comment cmt">#&& val.class != Object</span> |
| 261 |
<span class="ruby-keyword kw">end</span> |
| 262 |
</pre> |
| 263 |
</div> |
| 264 |
</div> |
| 265 |
</div> |
| 266 |
|
| 267 |
<div id="method-M000014" class="method-detail"> |
| 268 |
<a name="M000014"></a> |
| 269 |
|
| 270 |
<div class="method-heading"> |
| 271 |
<a href="#M000014" class="method-signature"> |
| 272 |
<span class="method-name">scalar_type?</span><span class="method-args">(type)</span> |
| 273 |
</a> |
| 274 |
</div> |
| 275 |
|
| 276 |
<div class="method-description"> |
| 277 |
<p><a class="source-toggle" href="#" |
| 278 |
onclick="toggleCode('M000014-source');return false;">[Source]</a></p> |
| 279 |
<div class="method-source-code" id="M000014-source"> |
| 280 |
<pre> |
| 281 |
<span class="ruby-comment cmt"># File kwalify/types.rb, line 147</span> |
| 282 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scalar_type?</span>(<span class="ruby-identifier">type</span>) |
| 283 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'seq'</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'map'</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'any'</span> |
| 284 |
<span class="ruby-keyword kw">end</span> |
| 285 |
</pre> |
| 286 |
</div> |
| 287 |
</div> |
| 288 |
</div> |
| 289 |
|
| 290 |
|
| 291 |
</div> |
| 292 |
|
| 293 |
|
| 294 |
</div> |
| 295 |
|
| 296 |
|
| 297 |
<div id="validator-badges"> |
| 298 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
| 299 |
</div> |
| 300 |
|
| 301 |
</body> |
| 302 |
</html> |