/usr/share/doc/libneedle-ruby1.8/api/classes/Needle/Registry.html is in libneedle-ruby1.8 1.3.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | <?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<title>Class: Needle::Registry</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Needle::Registry</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/needle/registry_rb.html">
lib/needle/registry.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Container.html">
Container
</a>
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
<a href="Registry.html">Registry</a> is a specialization of <a
href="Container.html">Container</a>, with additional functionality for
bootstrapping basic services into a new registry. It also supports a <a
href="Registry.html#M000044">define!</a> method for easily registering new
services.
</p>
<p>
Usage:
</p>
<pre>
require 'needle'
registry = Needle::Registry.new
registry.register( :foo ) { Foo.new }
registry.register( :bar ) { |c| Bar.new( c.foo ) }
bar = registry.bar
</pre>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000045">define</a>
<a href="#M000044">define!</a>
<a href="#M000047">fullname</a>
<a href="#M000046">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000045" class="method-detail">
<a name="M000045"></a>
<div class="method-heading">
<a href="#M000045" class="method-signature">
<span class="method-name">define</span><span class="method-args">( *parms, &block )</span>
</a>
</div>
<div class="method-description">
<p>
Instantiate a new <a href="Registry.html">Registry</a> (via <a
href="Registry.html#M000046">new</a>) and immediately invoke <a
href="Registry.html#M000045">define</a> using the given block.
</p>
<p>
Usage:
</p>
<pre>
registry = Needle::Registry.define do |b|
b.add { Adder.new }
...
end
adder = registry.add
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000045-source">
<pre>
<span class="ruby-comment cmt"># File lib/needle/registry.rb, line 74</span>
74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">define</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">parms</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
75: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NeedleError</span>, <span class="ruby-value str">"needs a block"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">nil?</span>
76: <span class="ruby-identifier">new</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">parms</span> ) { <span class="ruby-operator">|</span><span class="ruby-identifier">reg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">reg</span>.<span class="ruby-identifier">define</span>( <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) }
77: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000044" class="method-detail">
<a name="M000044"></a>
<div class="method-heading">
<a href="#M000044" class="method-signature">
<span class="method-name">define!</span><span class="method-args">( *parms, &block )</span>
</a>
</div>
<div class="method-description">
<p>
Instantiate a new <a href="Registry.html">Registry</a> (via <a
href="Registry.html#M000046">new</a>) and immediately invoke <a
href="Registry.html#M000044">define!</a> using the given block.
</p>
<p>
Usage:
</p>
<pre>
registry = Needle::Registry.define! do
add { Adder.new }
...
end
adder = registry.add
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000044-source">
<pre>
<span class="ruby-comment cmt"># File lib/needle/registry.rb, line 58</span>
58: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">define!</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">parms</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
59: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NeedleError</span>, <span class="ruby-value str">"needs a block"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">nil?</span>
60: <span class="ruby-identifier">new</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">parms</span> ) { <span class="ruby-operator">|</span><span class="ruby-identifier">reg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">reg</span>.<span class="ruby-identifier">define!</span>( <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> ) }
61: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000046" class="method-detail">
<a name="M000046"></a>
<div class="method-heading">
<a href="#M000046" class="method-signature">
<span class="method-name">new</span><span class="method-args">( opts={} ) {|self| ...}</span>
</a>
</div>
<div class="method-description">
<p>
Instantiate a new <a href="Registry.html">Registry</a>. The options hash
may include the following keys:
</p>
<table>
<tr><td valign="top"><tt>:logs</tt>:</td><td>options used to initialize the logger factory. The value to this key should
be another hash.
</td></tr>
<tr><td valign="top"><tt>:parent</tt>:</td><td>The parent container of this registry.
</td></tr>
<tr><td valign="top"><tt>:name</tt>:</td><td>The name of this registry.
</td></tr>
</table>
<p>
If a block is given, the constructed registry instance is yielded to it.
</p>
<p>
Usage:
</p>
<pre>
registry = Needle::Registry.new
</pre>
<p>
or
</p>
<pre>
registry = Needle::Registry.new do |reg|
reg.register( :add ) { Adder.new }
end
</pre>
<p>
or
</p>
<pre>
registry = Needle::Registry.new(
:logs => { :filename => "/dev/null" }
)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000046-source">
<pre>
<span class="ruby-comment cmt"># File lib/needle/registry.rb, line 104</span>
104: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">opts</span>={} )
105: <span class="ruby-keyword kw">super</span>( <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:parent</span>], <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:name</span>] )
106: <span class="ruby-identifier">bootstrap</span>( <span class="ruby-identifier">opts</span> ) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">nil?</span>
107: <span class="ruby-keyword kw">yield</span>( <span class="ruby-keyword kw">self</span> ) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
108: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000047" class="method-detail">
<a name="M000047"></a>
<div class="method-heading">
<a href="#M000047" class="method-signature">
<span class="method-name">fullname</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns <tt>nil</tt>, unless the registry has a parent, in which case it
acts like <a href="Container.html#M000051">Container#fullname</a>.
Registries are usually unnamed containers.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000047-source">
<pre>
<span class="ruby-comment cmt"># File lib/needle/registry.rb, line 112</span>
112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fullname</span>
113: <span class="ruby-identifier">parent</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">super</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
114: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|