naether 0.13.4-java → 0.13.5-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,705 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Naether::Notation
8
+
9
+ &mdash; Documentation by YARD 0.8.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (N)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span></span>
36
+ &raquo;
37
+ <span class="title">Notation</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Naether::Notation
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Naether::Notation</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/naether/notation.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Helper for handling Maven notations, supports notations:</p>
106
+
107
+ <pre class="code ruby"><code class="ruby">* artifactId:groupId:version
108
+ * artifactId:groupId:type:version
109
+ * artifactId:groupId:type:classifier:version</code></pre>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+ <h2>Constant Summary</h2>
119
+
120
+ <dl class="constants">
121
+
122
+ <dt id="PATTERN-constant" class="">PATTERN =
123
+
124
+ </dt>
125
+ <dd><pre class="code"><span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_compile'>compile</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>^(.+?):(.+?):(.+?)(:(.+?)(:(.+))?)?$</span><span class='tstring_end'>'</span></span> <span class='rparen'>)</span></pre></dd>
126
+
127
+ </dl>
128
+
129
+
130
+
131
+
132
+
133
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
134
+ <ul class="summary">
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#artifact-instance_method" title="#artifact (instance method)">- (Object) <strong>artifact</strong> </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+ <span class="note title readonly">readonly</span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Returns the value of attribute artifact.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#classifier-instance_method" title="#classifier (instance method)">- (Object) <strong>classifier</strong> </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+ <span class="note title readonly">readonly</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Returns the value of attribute classifier.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#group-instance_method" title="#group (instance method)">- (Object) <strong>group</strong> </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+ <span class="note title readonly">readonly</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'>
217
+ <p>Returns the value of attribute group.</p>
218
+ </div></span>
219
+
220
+ </li>
221
+
222
+
223
+ <li class="public ">
224
+ <span class="summary_signature">
225
+
226
+ <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
227
+
228
+
229
+
230
+ </span>
231
+
232
+
233
+
234
+
235
+ <span class="note title readonly">readonly</span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'>
246
+ <p>Returns the value of attribute type.</p>
247
+ </div></span>
248
+
249
+ </li>
250
+
251
+
252
+ <li class="public ">
253
+ <span class="summary_signature">
254
+
255
+ <a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
256
+
257
+
258
+
259
+ </span>
260
+
261
+
262
+
263
+
264
+ <span class="note title readonly">readonly</span>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+ <span class="summary_desc"><div class='inline'>
275
+ <p>Returns the value of attribute version.</p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ </ul>
282
+
283
+
284
+
285
+
286
+
287
+ <h2>
288
+ Instance Method Summary
289
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
290
+ </h2>
291
+
292
+ <ul class="summary">
293
+
294
+ <li class="public ">
295
+ <span class="summary_signature">
296
+
297
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Notation) <strong>initialize</strong>(notation) </a>
298
+
299
+
300
+
301
+ </span>
302
+
303
+
304
+ <span class="note title constructor">constructor</span>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+ <span class="summary_desc"><div class='inline'>
314
+ <p>A new instance of Notation.</p>
315
+ </div></span>
316
+
317
+ </li>
318
+
319
+
320
+ <li class="public ">
321
+ <span class="summary_signature">
322
+
323
+ <a href="#to_notation-instance_method" title="#to_notation (instance method)">- (Object) <strong>to_notation</strong> </a>
324
+
325
+
326
+
327
+ </span>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <span class="summary_desc"><div class='inline'></div></span>
338
+
339
+ </li>
340
+
341
+
342
+ </ul>
343
+
344
+
345
+ <div id="constructor_details" class="method_details_list">
346
+ <h2>Constructor Details</h2>
347
+
348
+ <div class="method_details first">
349
+ <h3 class="signature first" id="initialize-instance_method">
350
+
351
+ - (<tt><span class='object_link'><a href="" title="Naether::Notation (class)">Notation</a></span></tt>) <strong>initialize</strong>(notation)
352
+
353
+
354
+
355
+
356
+
357
+ </h3><div class="docstring">
358
+ <div class="discussion">
359
+
360
+ <p>Returns a new instance of Notation</p>
361
+
362
+
363
+ </div>
364
+ </div>
365
+ <div class="tags">
366
+
367
+
368
+ </div><table class="source_code">
369
+ <tr>
370
+ <td>
371
+ <pre class="lines">
372
+
373
+
374
+ 14
375
+ 15
376
+ 16
377
+ 17
378
+ 18
379
+ 19
380
+ 20
381
+ 21
382
+ 22
383
+ 23
384
+ 24
385
+ 25
386
+ 26
387
+ 27
388
+ 28
389
+ 29
390
+ 30
391
+ 31
392
+ 32
393
+ 33
394
+ 34
395
+ 35
396
+ 36
397
+ 37
398
+ 38
399
+ 39
400
+ 40</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 14</span>
404
+
405
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_notation'>notation</span><span class='rparen'>)</span>
406
+ <span class='kw'>if</span> <span class='id identifier rubyid_notation'>notation</span> <span class='op'>=~</span> <span class='const'>PATTERN</span>
407
+ <span class='ivar'>@group</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
408
+ <span class='ivar'>@artifact</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span>
409
+
410
+ <span class='comment'># artifactId:groupId:type:classifier:version
411
+ </span> <span class='kw'>if</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>7</span><span class='rparen'>)</span>
412
+ <span class='ivar'>@type</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
413
+ <span class='ivar'>@classifier</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span>
414
+ <span class='ivar'>@version</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>7</span><span class='rparen'>)</span>
415
+
416
+ <span class='comment'># artifactId:groupId:type:version
417
+ </span> <span class='kw'>elsif</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span>
418
+ <span class='ivar'>@type</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
419
+ <span class='ivar'>@version</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span>
420
+ <span class='comment'># artifactId:groupId:version -
421
+ </span> <span class='kw'>else</span>
422
+ <span class='ivar'>@type</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jar</span><span class='tstring_end'>'</span></span>
423
+ <span class='ivar'>@version</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
424
+ <span class='kw'>end</span>
425
+
426
+ <span class='kw'>end</span>
427
+
428
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_notation'>to_notation</span>
429
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group'>group</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_artifact'>artifact</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_classifier'>classifier</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_classifier'>classifier</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_version'>version</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
430
+ <span class='kw'>end</span>
431
+ <span class='kw'>end</span></pre>
432
+ </td>
433
+ </tr>
434
+ </table>
435
+ </div>
436
+
437
+ </div>
438
+
439
+ <div id="instance_attr_details" class="attr_details">
440
+ <h2>Instance Attribute Details</h2>
441
+
442
+
443
+ <span id=""></span>
444
+ <div class="method_details first">
445
+ <h3 class="signature first" id="artifact-instance_method">
446
+
447
+ - (<tt>Object</tt>) <strong>artifact</strong> <span class="extras">(readonly)</span>
448
+
449
+
450
+
451
+
452
+
453
+ </h3><div class="docstring">
454
+ <div class="discussion">
455
+
456
+ <p>Returns the value of attribute artifact</p>
457
+
458
+
459
+ </div>
460
+ </div>
461
+ <div class="tags">
462
+
463
+
464
+ </div><table class="source_code">
465
+ <tr>
466
+ <td>
467
+ <pre class="lines">
468
+
469
+
470
+ 10
471
+ 11
472
+ 12</pre>
473
+ </td>
474
+ <td>
475
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 10</span>
476
+
477
+ <span class='kw'>def</span> <span class='id identifier rubyid_artifact'>artifact</span>
478
+ <span class='ivar'>@artifact</span>
479
+ <span class='kw'>end</span></pre>
480
+ </td>
481
+ </tr>
482
+ </table>
483
+ </div>
484
+
485
+
486
+ <span id=""></span>
487
+ <div class="method_details ">
488
+ <h3 class="signature " id="classifier-instance_method">
489
+
490
+ - (<tt>Object</tt>) <strong>classifier</strong> <span class="extras">(readonly)</span>
491
+
492
+
493
+
494
+
495
+
496
+ </h3><div class="docstring">
497
+ <div class="discussion">
498
+
499
+ <p>Returns the value of attribute classifier</p>
500
+
501
+
502
+ </div>
503
+ </div>
504
+ <div class="tags">
505
+
506
+
507
+ </div><table class="source_code">
508
+ <tr>
509
+ <td>
510
+ <pre class="lines">
511
+
512
+
513
+ 10
514
+ 11
515
+ 12</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 10</span>
519
+
520
+ <span class='kw'>def</span> <span class='id identifier rubyid_classifier'>classifier</span>
521
+ <span class='ivar'>@classifier</span>
522
+ <span class='kw'>end</span></pre>
523
+ </td>
524
+ </tr>
525
+ </table>
526
+ </div>
527
+
528
+
529
+ <span id=""></span>
530
+ <div class="method_details ">
531
+ <h3 class="signature " id="group-instance_method">
532
+
533
+ - (<tt>Object</tt>) <strong>group</strong> <span class="extras">(readonly)</span>
534
+
535
+
536
+
537
+
538
+
539
+ </h3><div class="docstring">
540
+ <div class="discussion">
541
+
542
+ <p>Returns the value of attribute group</p>
543
+
544
+
545
+ </div>
546
+ </div>
547
+ <div class="tags">
548
+
549
+
550
+ </div><table class="source_code">
551
+ <tr>
552
+ <td>
553
+ <pre class="lines">
554
+
555
+
556
+ 10
557
+ 11
558
+ 12</pre>
559
+ </td>
560
+ <td>
561
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 10</span>
562
+
563
+ <span class='kw'>def</span> <span class='id identifier rubyid_group'>group</span>
564
+ <span class='ivar'>@group</span>
565
+ <span class='kw'>end</span></pre>
566
+ </td>
567
+ </tr>
568
+ </table>
569
+ </div>
570
+
571
+
572
+ <span id=""></span>
573
+ <div class="method_details ">
574
+ <h3 class="signature " id="type-instance_method">
575
+
576
+ - (<tt>Object</tt>) <strong>type</strong> <span class="extras">(readonly)</span>
577
+
578
+
579
+
580
+
581
+
582
+ </h3><div class="docstring">
583
+ <div class="discussion">
584
+
585
+ <p>Returns the value of attribute type</p>
586
+
587
+
588
+ </div>
589
+ </div>
590
+ <div class="tags">
591
+
592
+
593
+ </div><table class="source_code">
594
+ <tr>
595
+ <td>
596
+ <pre class="lines">
597
+
598
+
599
+ 10
600
+ 11
601
+ 12</pre>
602
+ </td>
603
+ <td>
604
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 10</span>
605
+
606
+ <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
607
+ <span class='ivar'>@type</span>
608
+ <span class='kw'>end</span></pre>
609
+ </td>
610
+ </tr>
611
+ </table>
612
+ </div>
613
+
614
+
615
+ <span id=""></span>
616
+ <div class="method_details ">
617
+ <h3 class="signature " id="version-instance_method">
618
+
619
+ - (<tt>Object</tt>) <strong>version</strong> <span class="extras">(readonly)</span>
620
+
621
+
622
+
623
+
624
+
625
+ </h3><div class="docstring">
626
+ <div class="discussion">
627
+
628
+ <p>Returns the value of attribute version</p>
629
+
630
+
631
+ </div>
632
+ </div>
633
+ <div class="tags">
634
+
635
+
636
+ </div><table class="source_code">
637
+ <tr>
638
+ <td>
639
+ <pre class="lines">
640
+
641
+
642
+ 10
643
+ 11
644
+ 12</pre>
645
+ </td>
646
+ <td>
647
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 10</span>
648
+
649
+ <span class='kw'>def</span> <span class='id identifier rubyid_version'>version</span>
650
+ <span class='ivar'>@version</span>
651
+ <span class='kw'>end</span></pre>
652
+ </td>
653
+ </tr>
654
+ </table>
655
+ </div>
656
+
657
+ </div>
658
+
659
+
660
+ <div id="instance_method_details" class="method_details_list">
661
+ <h2>Instance Method Details</h2>
662
+
663
+
664
+ <div class="method_details first">
665
+ <h3 class="signature first" id="to_notation-instance_method">
666
+
667
+ - (<tt>Object</tt>) <strong>to_notation</strong>
668
+
669
+
670
+
671
+
672
+
673
+ </h3><table class="source_code">
674
+ <tr>
675
+ <td>
676
+ <pre class="lines">
677
+
678
+
679
+ 37
680
+ 38
681
+ 39</pre>
682
+ </td>
683
+ <td>
684
+ <pre class="code"><span class="info file"># File 'lib/naether/notation.rb', line 37</span>
685
+
686
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_notation'>to_notation</span>
687
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group'>group</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_artifact'>artifact</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_classifier'>classifier</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_classifier'>classifier</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_version'>version</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
688
+ <span class='kw'>end</span></pre>
689
+ </td>
690
+ </tr>
691
+ </table>
692
+ </div>
693
+
694
+ </div>
695
+
696
+ </div>
697
+
698
+ <div id="footer">
699
+ Generated on Thu Mar 6 23:10:12 2014 by
700
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
701
+ 0.8.7.3 (ruby-1.9.3).
702
+ </div>
703
+
704
+ </body>
705
+ </html>