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:12 PDT 2015 -->
< title > GemUtils (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="GemUtils (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/GemUtils" target = "_top" > Frames< / a > < / li >
< li > < a href = "GemUtils.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested_summary" > Nested< / a > < / li > Field Constructor < li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > | Detail: < / li >
Field Constructor < 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 GemUtils" class = "title" > [Groovy] Class GemUtils< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > < ul class = "inheritance" > < / ul > < / li > < li > com.github.jrubygradle.GemUtils
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< p > A collection of utilities to manipulate GEMs
< DL > < DT > < B > Authors:< / B > < / DT > < DD > R Tyler Croy< / DD > < DD > Schalk W. Cronjé< / DD > < / DL > < / p >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- =========== NESTED CLASS SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "nested_summary" > <!-- --> < / a >
< h3 > Nested Class Summary< / h3 >
< ul class = "blockList" >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Nested Class Summary table, listing nested classes, and an explanation" >
< caption > < span > Nested classes< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifiers< / th >
< th class = "colLast" scope = "col" > Name< / th >
< th class = "colLast" scope = "col" > Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < strong > enum< / strong > < / code > < / td >
< td class = "colLast" > < code > < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > GemUtils.OverwriteAction< / a > < / code > < / td >
< td class = "colLast" > < / code > < / td >
< / tr >
< / table >
< / ul >
< / li >
< / ul >
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== PROPERTY SUMMARY =========== -->
<!-- =========== 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" > < / 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 > static void< / strong > < / code > < / td >
2015-08-14 16:06:49 +00:00
< td class = "colLast" > < code > < strong > < a href = "#extractGem(org.gradle.api.Project, java.io.File, java.io.File, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > extractGem< / a > < / strong > (org.gradle.api.Project project, java.io.File jRubyClasspath, java.io.File gem, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / code > < br > Extracts a gem to a folder< / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static void< / strong > < / code > < / td >
2015-08-14 16:06:49 +00:00
< td class = "colLast" > < code > < strong > < a href = "#extractGems(org.gradle.api.Project, java.io.File, org.gradle.api.file.FileCollection, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > extractGems< / a > < / strong > (org.gradle.api.Project project, java.io.File jRubyClasspath, org.gradle.api.file.FileCollection gems, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / code > < br > < / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static void< / strong > < / code > < / td >
2015-08-14 16:06:49 +00:00
< td class = "colLast" > < code > < strong > < a href = "#extractGems(org.gradle.api.Project, org.gradle.api.artifacts.Configuration, org.gradle.api.artifacts.Configuration, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > extractGems< / a > < / strong > (org.gradle.api.Project project, org.gradle.api.artifacts.Configuration jRubyConfig, org.gradle.api.artifacts.Configuration gemConfig, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > action)< / code > < br > Extract Gems from a given configuration.< / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "rowColor" >
2015-08-14 16:06:49 +00:00
< td class = "colFirst" > < code > static org.gradle.api.file.CopySpec< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#gemCopySpec(def, org.gradle.api.Project, java.lang.Object)" > gemCopySpec< / a > < / strong > (java.lang.Object properties = [:], org.gradle.api.Project project, java.lang.Object dir)< / code > < br > Adds a GEM CopySpec to an archive< / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static java.lang.String< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#gemFullNameFromFile(java.lang.String)" > gemFullNameFromFile< / a > < / strong > (java.lang.String filename)< / code > < br > Take the given .gem filename (e.g. rake-10.3.2.gem) and just return the
gem "full name" (e.g. rake-10.3.2)< / td >
< / tr >
< tr class = "rowColor" >
2015-08-14 16:06:49 +00:00
< td class = "colFirst" > < code > static org.gradle.api.file.FileCollection< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#getGems(org.gradle.api.file.FileCollection)" > getGems< / a > < / strong > (org.gradle.api.file.FileCollection fc)< / code > < br > Given a FileCollection return a filtered FileCollection only containing GEMs< / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "altColor" >
2015-08-14 16:06:49 +00:00
< td class = "colFirst" > < code > static org.gradle.api.file.CopySpec< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#jarCopySpec(org.gradle.api.Project, java.lang.Object)" > jarCopySpec< / a > < / strong > (org.gradle.api.Project project, java.lang.Object dir)< / code > < br > // specifications/*
2015-07-21 18:45:51 +00:00
if(!< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#rewriteJarDependencies(java.io.File, List<File>, Map<String, String>, com.github.jrubygradle.GemUtils.OverwriteAction)" > rewriteJarDependencies< / a > < / strong > (java.io.File jarsDir, java.util.List< java.io.File> dependencies, java.util.Map< java.lang.String, java.lang.String> renameMap, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / code > < br > < / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static void< / strong > < / code > < / td >
2015-08-14 16:06:49 +00:00
< td class = "colLast" > < code > < strong > < a href = "#setupJars(org.gradle.api.artifacts.Configuration, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > setupJars< / a > < / strong > (org.gradle.api.artifacts.Configuration config, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / code > < br > < / td >
2015-07-21 18:45:51 +00:00
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static void< / strong > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "#writeJarsLock(java.io.File, List<String>, com.github.jrubygradle.GemUtils.OverwriteAction)" > writeJarsLock< / a > < / strong > (java.io.File jarsLock, java.util.List< java.lang.String> coordinates, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / code > < br > < / 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" >
<!-- =========== 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 = "extractGem(org.gradle.api.Project, java.io.File, java.io.File, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static void < strong > extractGem< / strong > (org.gradle.api.Project project, java.io.File jRubyClasspath, java.io.File gem, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / h4 >
2015-07-21 18:45:51 +00:00
< p > Extracts a gem to a folder
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > project< / code > - Project instance< / DD > < DD > < code > jRubyClasspath< / code > - Where to find the jruby-complete jar< / DD > < DD > < code > gem< / code > - Gem file to extract< / DD > < DD > < code > destDir< / code > - Directory to extract to< / DD > < DD > < code > overwrite< / code > - Allow overwrite of an existing gem folder< / DD > < / DL > < / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "extractGems(org.gradle.api.Project, java.io.File, org.gradle.api.file.FileCollection, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static void < strong > extractGems< / strong > (org.gradle.api.Project project, java.io.File jRubyClasspath, org.gradle.api.file.FileCollection gems, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / h4 >
2015-07-21 18:45:51 +00:00
< p > < / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "extractGems(org.gradle.api.Project, org.gradle.api.artifacts.Configuration, org.gradle.api.artifacts.Configuration, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static void < strong > extractGems< / strong > (org.gradle.api.Project project, org.gradle.api.artifacts.Configuration jRubyConfig, org.gradle.api.artifacts.Configuration gemConfig, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > action)< / h4 >
2015-07-21 18:45:51 +00:00
< p > Extract Gems from a given configuration.
< DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > project< / code > - Project instance< / DD > < DD > < code > jRubyClasspath< / code > - Where to find the jruby-complete jar< / DD > < DD > < code > gemConfig< / code > - Configuration containing GEMs< / DD > < DD > < code > destDir< / code > - Directory to extract to< / DD > < DD > < code > action< / code > - Allow overwrite of an existing gem folder< / DD > < / DL > < / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "gemCopySpec(def, org.gradle.api.Project, java.lang.Object)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static org.gradle.api.file.CopySpec < strong > gemCopySpec< / strong > (java.lang.Object properties = [:], org.gradle.api.Project project, java.lang.Object dir)< / h4 >
2015-07-21 18:45:51 +00:00
< p > Adds a GEM CopySpec to an archive
The following are supported as properties:
< ul >
< li > fullGem (boolean) - Copy all of the GEM content, not just a minimal subset< / li >
< li > subfolder (Object) - Adds an additional subfolder into the GEM
< / ul >
2015-07-31 08:11:32 +00:00
< DL > < DT > < B > Returns:< / B > < / DT > < DD > Returns a CopySpec which can be attached as a child to another object that implements a CopySpec< / DD > < / DL > < DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > Additional< / code > - properties to control behaviour< / DD > < DD > < code > dir< / code > - The source of the GEM files< / DD > < / DL > < DL > < DT > < B > Since:< / B > < / DT > < DD > 0.1.2< / DD > < / DL > < / p >
2015-07-21 18:45:51 +00:00
< / li >
< / ul >
< a name = "gemFullNameFromFile(java.lang.String)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > static java.lang.String < strong > gemFullNameFromFile< / strong > (java.lang.String filename)< / h4 >
< p > Take the given .gem filename (e.g. rake-10.3.2.gem) and just return the
gem "full name" (e.g. rake-10.3.2)
< / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "getGems(org.gradle.api.file.FileCollection)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static org.gradle.api.file.FileCollection < strong > getGems< / strong > (org.gradle.api.file.FileCollection fc)< / h4 >
2015-07-21 18:45:51 +00:00
< p > Given a FileCollection return a filtered FileCollection only containing GEMs
2015-07-31 08:11:32 +00:00
< DL > < DT > < B > Returns:< / B > < / DT > < DD > Filtered FileCollection< / DD > < / DL > < DL > < DT > < B > Parameters:< / B > < / DT > < DD > < code > fc< / code > - Original FileCollection< / DD > < / DL > < / p >
2015-07-21 18:45:51 +00:00
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "jarCopySpec(org.gradle.api.Project, java.lang.Object)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static org.gradle.api.file.CopySpec < strong > jarCopySpec< / strong > (org.gradle.api.Project project, java.lang.Object dir)< / h4 >
2015-07-21 18:45:51 +00:00
< p >
// specifications/*
if(!fullGem) {
exclude 'cache/**'
exclude 'gems/< / p >
< / li >
< / ul >
< a name = "rewriteJarDependencies(java.io.File, List<File>, Map<String, String>, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > static void < strong > rewriteJarDependencies< / strong > (java.io.File jarsDir, java.util.List< java.io.File> dependencies, java.util.Map< java.lang.String, java.lang.String> renameMap, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / h4 >
< p > < / p >
< / li >
< / ul >
2015-08-14 16:06:49 +00:00
< a name = "setupJars(org.gradle.api.artifacts.Configuration, java.io.File, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
2015-07-21 18:45:51 +00:00
< ul class = "blockListLast" >
< li class = "blockList" >
2015-08-14 16:06:49 +00:00
< h4 > static void < strong > setupJars< / strong > (org.gradle.api.artifacts.Configuration config, java.io.File destDir, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / h4 >
2015-07-21 18:45:51 +00:00
< p > < / p >
< / li >
< / ul >
< a name = "writeJarsLock(java.io.File, List<String>, com.github.jrubygradle.GemUtils.OverwriteAction)" > <!-- --> < / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > static void < strong > writeJarsLock< / strong > (java.io.File jarsLock, java.util.List< java.lang.String> coordinates, < a href = '../../../com/github/jrubygradle/GemUtils.OverwriteAction.html' > OverwriteAction< / a > overwrite)< / h4 >
< p > < / 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/GemUtils" target = "_top" > Frames< / a > < / li >
< li > < a href = "GemUtils.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested_summary" > Nested< / a > < / li > Field Constructor < li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > | Detail: < / li >
Field Constructor < 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 >