2015-07-21 18:45:51 +00:00
<!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 >
2015-09-10 22:25:23 +00:00
<!-- Generated by groovydoc (2.3.3) on Thu Sep 10 15:25:13 PDT 2015 -->
< title > JRubyPluginExtension (jruby-gradle-base-plugin 1.1.0 API)< / title >
2015-09-10 22:23:51 +00:00
< meta name = "date" content = "2015-09-10" >
2015-07-21 18:45:51 +00:00
< 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) {
2015-09-10 22:25:23 +00:00
parent.document.title="JRubyPluginExtension (jruby-gradle-base-plugin 1.1.0 API)";
2015-07-21 18:45:51 +00:00
}
//-->
< / 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/JRubyPluginExtension" target = "_top" > Frames< / a > < / li >
< li > < a href = "JRubyPluginExtension.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
Nested Field < li > < a href = "#property_summary" > Property< / a > < / li > < li > < a href = "#constructor_summary" > Constructor< / a > < / li > < li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > | Detail: < / li >
Field < li > < a href = "#prop_detail" > Property< / a > < / li > < li > < a href = "#constructor_detail" > Constructor< / a > < / li > < li > < a href = "#method_detail" > Method< / a > < / li >
< / 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< / strong > < / div >
< h2 title = "[Groovy] Class JRubyPluginExtension" class = "title" > [Groovy] Class JRubyPluginExtension< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > < ul class = "inheritance" > < / ul > < / li > < li > com.github.jrubygradle.JRubyPluginExtension
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< / 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" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Type< / th >
< th class = "colLast" scope = "col" > Name and description< / th >
< / tr >
< tr class = "altColor" >
2015-08-14 16:06:49 +00:00
< td class = "colFirst" > < code > < strong > static java.lang.String< / strong > < / code > < / td >
< td class = "colLast" > < code > < a href = "#DEFAULT_JRUBY_VERSION" > < / a > DEFAULT_JRUBY_VERSION< / code > < br > < / td >
< / tr >
< tr class = "rowColor" >
2015-07-21 18:45:51 +00:00
< td class = "colFirst" > < code > < strong > boolean< / strong > < / code > < / td >
< td class = "colLast" > < code > < a href = "#defaultRepositories" > < / a > defaultRepositories< / code > < br > Set this to false if you do not want the default set of repositories to be loaded.< / td >
< / tr >
2015-08-14 16:06:49 +00:00
< tr class = "altColor" >
2015-07-21 18:45:51 +00:00
< td class = "colFirst" > < code > < strong > java.lang.String< / strong > < / code > < / td >
< td class = "colLast" > < code > < a href = "#defaultVersion" > < / a > defaultVersion< / code > < br > The default version of jruby that will be used by jrubyWar< / td >
< / tr >
2015-08-14 16:06:49 +00:00
< tr class = "rowColor" >
2015-07-21 18:45:51 +00:00
< td class = "colFirst" > < code > < strong > java.lang.String< / strong > < / code > < / td >
< td class = "colLast" > < code > < a href = "#execVersion" > < / a > execVersion< / code > < br > The version of jruby used by jrubyexec as well as default version of jruby that will be used by JRubyExec< / td >
< / tr >
< / table >
< / ul >
< / li >
< / ul >
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_summary" > <!-- --> < / a >
< h3 > Constructor Summary< / h3 >
< ul class = "blockList" >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructors Summary table" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Constructor and description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" >
2015-08-14 16:06:49 +00:00
< code > < a href = "#JRubyPluginExtension(org.gradle.api.Project)" > JRubyPluginExtension< / a > < / strong >
(org.gradle.api.Project p)< / code > < br > < / td >
2015-07-21 18:45:51 +00:00
< / tr >
< / table >
< / ul >
< / li >
< / ul >
<!-- ========== 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" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Type< / th >
< th class = "colLast" scope = "col" > Name and description< / th >
< / tr >
< tr class = "altColor" >
2015-08-14 16:06:49 +00:00
< td class = "colFirst" > < code > void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#defaultVersion(java.lang.String)" > defaultVersion< / a > < / strong > (java.lang.String newDefaultVersion)< / code > < br > Set the default version of JRuby to be used by all JRuby/Gradle code< / td >
< / tr >
< tr class = "rowColor" >
2015-07-21 18:45:51 +00:00
< td class = "colFirst" > < code > java.io.File< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#getGemInstallDir()" > getGemInstallDir< / a > < / strong > ()< / code > < br > Resolves the currently configured GEM installation directory.< / td >
< / tr >
2015-08-14 16:06:49 +00:00
< tr class = "altColor" >
2015-07-21 18:45:51 +00:00
< td class = "colFirst" > < code > java.io.File< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#getJarInstallDir()" > getJarInstallDir< / a > < / strong > ()< / code > < br > Resolves the currently configured Jars installation directory.< / td >
< / tr >
2015-08-14 16:06:49 +00:00
< tr class = "rowColor" >
< td class = "colFirst" > < code > void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#registerDefaultVersionCallback(groovy.lang.Closure)" > registerDefaultVersionCallback< / a > < / strong > (groovy.lang.Closure callback)< / code > < br > Register a callback to be invoked when defaultVersion is updated< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#registerExecVersionCallback(groovy.lang.Closure)" > registerExecVersionCallback< / a > < / strong > (groovy.lang.Closure callback)< / code > < br > Register a callback to be invoked when execVersion is updated< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#setDefaultVersion(java.lang.String)" > setDefaultVersion< / a > < / strong > (java.lang.String newDefaultVersion)< / code > < br > < / td >
< / tr >
2015-07-21 18:45:51 +00:00
< tr class = "altColor" >
< td class = "colFirst" > < code > void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#setExecVersion(java.lang.String)" > setExecVersion< / a > < / strong > (java.lang.String newVersion)< / code > < br > Change the version of jruby for jrubyexec and JRubyExec< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > java.lang.Object< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#setGemInstallDir(java.lang.Object)" > setGemInstallDir< / a > < / strong > (java.lang.Object dir)< / code > < br > Sets the gem installation directory. < / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > java.lang.Object< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#setJarInstallDir(java.lang.Object)" > setJarInstallDir< / a > < / strong > (java.lang.Object dir)< / code > < br > Sets the jar installation directory. < / td >
< / tr >
< / table >
< / ul >
< / li >
< li class = "blockList" > < a name = "method_summary" > <!-- --> < / a >
< h3 > Inherited Methods Summary< / h3 >
< ul class = "blockList" >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Inherited Methods Summary table" >
< caption > < span > Inherited Methods< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Methods inherited from class< / th >
< th class = "colLast" scope = "col" > Name< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > class java.lang.Object< / strong > < / code > < / td >
< td class = "colLast" > < code > java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()< / code > < / 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 >
2015-08-14 16:06:49 +00:00
< a name = "DEFAULT_JRUBY_VERSION" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > static final java.lang.String < strong > DEFAULT_JRUBY_VERSION< / strong > < / h4 >
< p > < / p >
< / li >
< / ul >
2015-07-21 18:45:51 +00:00
< a name = "defaultRepositories" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > @org.gradle.api.Incubating
2015-07-21 18:45:51 +00:00
boolean < strong > defaultRepositories< / strong > < / h4 >
< p > Set this to false if you do not want the default set of repositories to be loaded.
< DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.1< / DD > < / DL > < / p >
< / li >
< / ul >
< a name = "defaultVersion" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > java.lang.String < strong > defaultVersion< / strong > < / h4 >
2015-08-14 16:06:49 +00:00
< p > The default version of jruby that will be used by jrubyWar < / p >
2015-07-21 18:45:51 +00:00
< / li >
< / ul >
< a name = "execVersion" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > @java.lang.Deprecated
java.lang.String < strong > execVersion< / strong > < / h4 >
< p > The version of jruby used by jrubyexec as well as default version of jruby that will be used by JRubyExec< DL > < DT > < B > deprecated:< / B > < / DT > < DD > Setting execVersion is not very often done and should probably
be avoided. Set jrubyVersion on your JRubyExec tasks instead< / DD > < / DL >
2015-07-21 18:45:51 +00:00
< / p >
< / li >
< / ul >
< / li >
< / ul >
<!-- =========== CONSTRUCTOR DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
2015-08-14 16:06:49 +00:00
< a name = "JRubyPluginExtension(org.gradle.api.Project)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > < strong > JRubyPluginExtension< / strong > (org.gradle.api.Project p)< / h4 >
2015-07-21 18:45:51 +00:00
< p > < / p >
< / li >
< / ul >
< / li >
< / ul >
<!-- =========== METHOD DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2015-08-14 16:06:49 +00:00
< a name = "defaultVersion(java.lang.String)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > void < strong > defaultVersion< / strong > (java.lang.String newDefaultVersion)< / h4 >
< p > Set the default version of JRuby to be used by all JRuby/Gradle code
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > newDefaultVersion< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 1.1.0< / DD > < / DL > < / p >
< / li >
< / ul >
2015-07-21 18:45:51 +00:00
< a name = "getGemInstallDir()" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > java.io.File < strong > getGemInstallDir< / strong > ()< / h4 >
< p > Resolves the currently configured GEM installation directory.
< DL > < DT > < B > Returns:< / B > < / DT > < DD > Install directory as an absolute path< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.12< / DD > < / DL > < / p >
< / li >
< / ul >
< a name = "getJarInstallDir()" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > java.io.File < strong > getJarInstallDir< / strong > ()< / h4 >
< p > Resolves the currently configured Jars installation directory.
< DL > < DT > < B > Returns:< / B > < / DT > < DD > Install directory as an absolute path< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.16< / DD > < / DL > < / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "registerDefaultVersionCallback(groovy.lang.Closure)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > @org.gradle.api.Incubating
void < strong > registerDefaultVersionCallback< / strong > (groovy.lang.Closure callback)< / h4 >
< p > Register a callback to be invoked when defaultVersion is updated
NOTE: This is primarily meant for JRuby/Gradle plugin developers
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > callback< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 1.1.0< / DD > < / DL > < / p >
< / li >
< / ul >
< a name = "registerExecVersionCallback(groovy.lang.Closure)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > @org.gradle.api.Incubating
void < strong > registerExecVersionCallback< / strong > (groovy.lang.Closure callback)< / h4 >
< p > Register a callback to be invoked when execVersion is updated
This is primarily meant for JRuby/Gradle plugin developers. You can expect
that this callback will be executed if defaultVersion is changed but
execVersion is not changed.
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > callback< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 1.1.0< / DD > < / DL > < / p >
< / li >
< / ul >
< a name = "setDefaultVersion(java.lang.String)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > void < strong > setDefaultVersion< / strong > (java.lang.String newDefaultVersion)< / h4 >
< p > < / p >
< / li >
< / ul >
2015-07-21 18:45:51 +00:00
< a name = "setExecVersion(java.lang.String)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > @java.lang.Deprecated
void < strong > setExecVersion< / strong > (java.lang.String newVersion)< / h4 >
< p > Change the version of jruby for jrubyexec and JRubyExec< DL > < DT > < B > deprecated:< / B > < / DT > < DD > Setting execVersion is not very often done and should probably
be avoided. Set jrubyVersion on your JRubyExec tasks instead< / DD > < / DL >
2015-07-21 18:45:51 +00:00
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > newVersion< / DD > < / DL > < / p >
< / li >
< / ul >
< a name = "setGemInstallDir(java.lang.Object)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > java.lang.Object < strong > setGemInstallDir< / strong > (java.lang.Object dir)< / h4 >
< p > Sets the gem installation directory. Anything that can be passed to < CODE > project.file< / CODE > can be
passed here as well.
2015-07-31 08:11:32 +00:00
< DL > < DT > < B > Returns:< / B > < / DT > < DD > The passed object.< / DD > < / DL > < DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > dir< / code > - Directory (String, GString, File, Closure etc.)< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.12< / DD > < / DL > < / p >
2015-07-21 18:45:51 +00:00
< / li >
< / ul >
< a name = "setJarInstallDir(java.lang.Object)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > java.lang.Object < strong > setJarInstallDir< / strong > (java.lang.Object dir)< / h4 >
< p > Sets the jar installation directory. Anything that can be passed to < CODE > project.file< / CODE > can be
passed here as well.
2015-07-31 08:11:32 +00:00
< DL > < DT > < B > Returns:< / B > < / DT > < DD > The passed object.< / DD > < / DL > < DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > dir< / code > - Directory (String, GString, File, Closure etc.)< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.16< / DD > < / DL > < / p >
2015-07-21 18:45:51 +00:00
< / 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/JRubyPluginExtension" target = "_top" > Frames< / a > < / li >
< li > < a href = "JRubyPluginExtension.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
Nested Field < li > < a href = "#property_summary" > Property< / a > < / li > < li > < a href = "#constructor_summary" > Constructor< / a > < / li > < li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > | Detail: < / li >
Field < li > < a href = "#prop_detail" > Property< / a > < / li > < li > < a href = "#constructor_detail" > Constructor< / a > < / li > < li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< p > Groovy Documentation< / p >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a >
< / div >
< / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >