jruby-gradle.github.io/groovydoc/jruby-gradle-war-plugin/com/github/jrubygradle/war/JRubyWar.html

303 lines
12 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc (2.3.3) on Fri Jul 31 01:11:25 PDT 2015 -->
<title>JRubyWar (jruby-gradle-war-plugin 1.0.0-alpha API)</title>
<meta name="date" content="2015-07-31">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JRubyWar (jruby-gradle-war-plugin 1.0.0-alpha API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="navList">
<li><a href="../../../../index.html?com/github/jrubygradle/war/JRubyWar" target="_top">Frames</a></li>
<li><a href="JRubyWar.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;<li><a href="#property_summary">Property</a></li>&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;<li><a href="#prop_detail">Property</a></li>&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Package: <strong>com.github.jrubygradle.war</strong></div>
<h2 title="[Groovy] Class JRubyWar" class="title">[Groovy] Class JRubyWar</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.war.JRubyWar
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<p>
<DL><DT><B>Authors:</B></DT><DD>R. Tyler Croy</DD></DL></p>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== PROPERTY SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="property_summary"><!-- --></a>
<h3>Properties Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Properties Summary table, listing nested classes, and an explanation">
<caption><span>Properties</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#JRUBYWAR_CONFIG"></a>JRUBYWAR_CONFIG</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#JRUBYWAR_MAINCLASS"></a>JRUBYWAR_MAINCLASS</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#mainClass"></a>mainClass</code><br>Setting the main class allows for a runnable War.
</td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#copy()">copy</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static&nbsp;void</strong></code></td>
<td class="colLast"><code><strong><a href="#updateJRubyDependencies(Project)">updateJRubyDependencies</a></strong>(<a href='../../../../Project.html'>Project</a> project)</code><br>Update dependencies on the project to include those necessary for
building JRubyWar's</td>
</tr>
</table>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- =========== PROPERTY DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="prop_detail">
<!-- -->
</a>
<h3>Property Detail</h3>
<a name="JRUBYWAR_CONFIG"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>JRUBYWAR_CONFIG</strong></h4>
<p></p>
</li>
</ul>
<a name="JRUBYWAR_MAINCLASS"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>JRUBYWAR_MAINCLASS</strong></h4>
<p></p>
</li>
</ul>
<a name="mainClass"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@Input
java.lang.String <strong>mainClass</strong></h4>
<p> Setting the main class allows for a runnable War.
By default the value is <CODE>JRUBYWAR_MAINCLASS</CODE>
</p>
</li>
</ul>
</li>
</ul>
<!-- =========== METHOD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="copy()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override
void <strong>copy</strong>()</h4>
<p></p>
</li>
</ul>
<a name="updateJRubyDependencies(Project)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;void <strong>updateJRubyDependencies</strong>(<a href='../../../../Project.html'>Project</a> project)</h4>
<p> Update dependencies on the project to include those necessary for
building JRubyWar's
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="navList">
<li><a href="../../../../index.html?com/github/jrubygradle/war/JRubyWar" target="_top">Frames</a></li>
<li><a href="JRubyWar.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;<li><a href="#property_summary">Property</a></li>&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;<li><a href="#prop_detail">Property</a></li>&nbsp;&nbsp;&nbsp;Constructor&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<p>Groovy Documentation</p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>