<!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>
Module: Naether
— Documentation by YARD 0.8.7.2
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</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>
<div id="header">
<div id="menu">
<a href="_index.html">Index (N)</a> »
<span class="title">Naether</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 class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Naether
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/naether/java.rb<span class="defines">,<br />
lib/naether.rb,<br /> lib/naether/maven.rb,<br /> lib/naether/runtime.rb,<br /> lib/naether/notation.rb,<br /> lib/naether/java/ruby.rb,<br /> lib/naether/bootstrap.rb,<br /> lib/naether/java/jruby.rb,<br /> lib/naether/configuration.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'>
<p>Michael Guymon</p>
</div>
</li>
</ul>
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Naether/Bootstrap.html" title="Naether::Bootstrap (class)">Bootstrap</a></span>, <span class='object_link'><a href="Naether/Configurator.html" title="Naether::Configurator (class)">Configurator</a></span>, <span class='object_link'><a href="Naether/Java.html" title="Naether::Java (class)">Java</a></span>, <span class='object_link'><a href="Naether/Maven.html" title="Naether::Maven (class)">Maven</a></span>, <span class='object_link'><a href="Naether/Notation.html" title="Naether::Notation (class)">Notation</a></span>, <span class='object_link'><a href="Naether/Runtime.html" title="Naether::Runtime (class)">Runtime</a></span>
</p>
<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="#bootstrap_dependencies-class_method" title="bootstrap_dependencies (class method)">+ (Object) <strong>bootstrap_dependencies</strong>(dep_file = nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>List of Java dependencies needed to bootstrap Naether.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_from_jars-class_method" title="create_from_jars (class method)">+ (Naether) <strong>create_from_jars</strong>(jars) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Loads all jars creates a new instance of Naether.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#platform-class_method" title="platform (class method)">+ (Object) <strong>platform</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Helper for platform detection.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="bootstrap_dependencies-class_method">
+ (<tt>Object</tt>) <strong>bootstrap_dependencies</strong>(dep_file = nil)
</h3><div class="docstring">
<div class="discussion">
<p>List of Java dependencies needed to bootstrap Naether</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>dep_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
<p>path</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>{Naether{Naether::Bootstrap{Naether::Bootstrap#dependencies}</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bootstrap_dependencies'>bootstrap_dependencies</span><span class='lparen'>(</span> <span class='id identifier rubyid_dep_file'>dep_file</span><span class='op'>=</span><span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>/naether/bootstrap</span><span class='tstring_end'>"</span></span>
<span class='const'>Naether</span><span class='op'>::</span><span class='const'>Bootstrap</span><span class='period'>.</span><span class='id identifier rubyid_dependencies'>dependencies</span><span class='lparen'>(</span> <span class='id identifier rubyid_dep_file'>dep_file</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create-class_method">
+ (<tt>Object</tt>) <strong>create</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>/naether/runtime</span><span class='tstring_end'>"</span></span>
<span class='const'>Naether</span><span class='op'>::</span><span class='const'>Runtime</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_from_jars-class_method">
+ (<tt><span class='object_link'><a href="" title="Naether (module)">Naether</a></span></tt>) <strong>create_from_jars</strong>(jars)
</h3><div class="docstring">
<div class="discussion">
<p>Loads all jars creates a new instance of Naether</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>jars</span>
<span class='type'>(<tt>Array<String></tt>)</span>
—
<div class='inline'>
<p>of paths</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Naether (module)">Naether</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_from_jars'>create_from_jars</span><span class='lparen'>(</span> <span class='id identifier rubyid_jars'>jars</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>/naether/java</span><span class='tstring_end'>"</span></span>
<span class='const'>Naether</span><span class='op'>::</span><span class='const'>Java</span><span class='period'>.</span><span class='id identifier rubyid_internal_load_paths'>internal_load_paths</span><span class='lparen'>(</span> <span class='id identifier rubyid_jars'>jars</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_create'>create</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="platform-class_method">
+ (<tt>Object</tt>) <strong>platform</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Helper for platform detection</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_platform'>platform</span>
<span class='const'>Naether</span><span class='op'>::</span><span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_platform'>platform</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Oct 2 21:57:24 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.2 (ruby-1.9.3).
</div>
</body>
</html>