Constructor Detail

• FilePlugin(org.savantbuild.domain.Project project, org.savantbuild.runtime.RuntimeConfiguration runtimeConfiguration, org.savantbuild.output.Output output)

Method Detail

• void append(java.util.Map<java.lang.String, java.lang.Object> attributes, @groovy.lang.DelegatesTo(value: AppendDelegate.class)
  groovy.lang.Closure closure)

  Appends one or more files to a file. The "to" attribute specifies the target file and the "files" attribute is an array of files to append to it.

  Here is an example of calling this method:

     file.append(to: "build/somefile.txt") {
       fileSet(dir: "foo")
     }
   

  Parameters:

  attributes - The named attributes (to and files are required).

• int copy(java.util.Map<java.lang.String, java.lang.Object> attributes, @groovy.lang.DelegatesTo(value: CopyDelegate.class)
  groovy.lang.Closure closure)

  Copies files around. This uses the CopyDelegate class to handle Closure methods.

  Here is an example of calling this method:

     file.copy(to: "build/distributions/bin") {*     fileSet(dir: "src/main/scripts")
  }* 

  Parameters:

  attributes - The named attributes (to is required).

  closure - The closure that is invoked.

  Returns:

  The number of files copied.

• void copyFile(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Copies a single file to another location.

  Here is an example of calling this method:

     file.copyFile(file: "some-file.txt", to: "build/some-file-renamed.txt")
   

  Parameters:

  attributes - The named attributes (file and to are required).

• void delete(@groovy.lang.DelegatesTo(value: DeleteDelegate.class)
  groovy.lang.Closure closure)

  Deletes files using fileSets.

  Here is an example of calling this method:

     file.delete {*     fileSet(dir: "build/example", includePatterns: [~/foobar.+/])
  }* 

• int jar(java.util.Map<java.lang.String, java.lang.Object> attributes, @groovy.lang.DelegatesTo(value: JarDelegate.class)
  groovy.lang.Closure closure)

  Creates a JAR file from various files. This uses the JarDelegate class to handle Closure methods.

  Here is an example of calling this method:

     file.jar(file: "build/jars/foo.jar") {*     fileSet(dir: "build/classes/main")
  }* 

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

  Returns:

  The number of files added to the Jar.

• void mkdir(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Creates a directory. Here is an example of calling this method:

     file.mkdir(dir: "foo")
   

  Parameters:

  attributes - The named attributes (dir is required).

• void prune(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Prunes the given directory. This does not traverse symlinks. It unlinks symlinks.

  Here is an example of calling this method:

     file.prune(dir: "build/classes/main")
   

  Parameters:

  attributes - The named attributes (dir is required).

• void rename(@groovy.lang.DelegatesTo(value: RenameDelegate.class)
  groovy.lang.Closure closure)

  Renames the files specified by one or more fileSets using the filter specified.

  Here is an example of calling this method:

     file.rename {*     fileSet(dir: "build/classes/main")
       filter(token: "foobar", value: "baz")
  }* 

  Parameters:

  closure - The closure

• void symlink(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Creates a symbol link at the [link] attribute that points to the [target] attribute.

  Here is an example of calling this method:

     file.symlink(target: "build/classes/main", link: "/tmp/foo/bar")
   

  Parameters:

  attributes - The named attributes (target and link are required).

• int tar(java.util.Map<java.lang.String, java.lang.Object> attributes, @groovy.lang.DelegatesTo(value: TarDelegate.class)
  groovy.lang.Closure closure)

  Creates a Tarball from various files. This uses the TarDelegate class to handle Closure methods.

  Here is an example of calling this method:

     file.tar(file: "build/tars/foobar.tar.gz") {*     fileSet(dir: "src/main/java")
  }* 

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

  Returns:

  The number of files added to the Tarball.

• void unjar(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Unzips a JAR file to a directory. This requires the [file] and [to] attributes.

  Here is an example of calling this method:

     file.unjar(file: "build/zips/foobar.jar", to: "build/output")
   

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

• void untar(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Untars a TAR file to a directory. This requires the [file] and [to] attributes.

  Here is an example of calling this method:

     file.untar(file: "build/tars/foobar.tar.gz", to: "build/output")
   

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

• void unzip(java.util.Map<java.lang.String, java.lang.Object> attributes)

  Unzips a ZIP file to a directory. This requires the [file] and [to] attributes.

  Here is an example of calling this method:

     file.unzip(file: "build/zips/foobar.zip", to: "build/output")
   

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

• int zip(java.util.Map<java.lang.String, java.lang.Object> attributes, @groovy.lang.DelegatesTo(value: ZipDelegate.class)
  groovy.lang.Closure closure)

  Creates a ZIP file from various files. This uses the ZipDelegate class to handle Closure methods.

  Here is an example of calling this method:

     file.zip(file: "build/jars/foo.zip") {*     fileSet(dir: "build/classes/main")
  }* 

  Parameters:

  attributes - The named attributes (file is required).

  closure - The closure that is invoked.

  Returns:

  The number of files added to the ZIP.