FileUtils (gradle-quality-plugin 4.2.2 API)

ru.vyarus.gradle.plugin.quality.util.FileUtils

Path utilities.
Authors:
Vyacheslav Rusakov
Since:
21.03.2017

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`extractJavaClass(java.util.Collection<java.io.File> roots, java.io.File file)` Resolves class name from source file.
	`static java.io.File`	`findConfigurationJar(org.gradle.api.Project project, java.lang.String configurationName, java.lang.String jarIdentity)` Finds exact jar in gradle configuration.
	`static org.gradle.api.tasks.SourceSet`	`findMatchingSet(java.lang.String baseName, java.lang.String taskName, java.util.Collection<org.gradle.api.tasks.SourceSet> sets)` Searches for source set current task belongs to using task name build convention.
`<T>`	`static T`	`loadFileFromJar(java.io.File jar, java.lang.String filePath, groovy.lang.Closure<T> action)` Loads file from provided jar file (found with findConfigurationJar(org.gradle.api.Project, java.lang.String, java.lang.String)).
	`static java.util.Set<java.io.File>`	`resolveIgnoredFiles(org.gradle.api.file.FileTree files, java.util.Collection<java.lang.String> excludes)` Resolves excluded files of file set.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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()`

- Method Detail
  - @java.lang.SuppressWarnings('DuplicateStringLiteral') static java.lang.String extractJavaClass(java.util.Collection<java.io.File> roots, java.io.File file)
    
    Resolves class name from source file.
    Parameters:
    roots - source directories
    file - java source file
    Returns:
    class name
  - static java.io.File findConfigurationJar(org.gradle.api.Project project, java.lang.String configurationName, java.lang.String jarIdentity)
    
    Finds exact jar in gradle configuration.
    throws:
    IllegalArgumentException if jar not found
    
    Parameters:
    project - project to look configurations in
    configurationName - configuration name
    jarIdentity - part of jar name to identify it
    Returns:
    found jar file
  - static org.gradle.api.tasks.SourceSet findMatchingSet(java.lang.String baseName, java.lang.String taskName, java.util.Collection<org.gradle.api.tasks.SourceSet> sets)
    
    Searches for source set current task belongs to using task name build convention.
    Parameters:
    baseName - base name for task group
    taskName - full task name
    sets - source sets to search in
    Returns:
    found source set or null when not found
  - <T> static T loadFileFromJar(java.io.File jar, java.lang.String filePath, groovy.lang.Closure<T> action)
    
    Loads file from provided jar file (found with findConfigurationJar(org.gradle.api.Project, java.lang.String, java.lang.String)).
    Action closure receives input stream (and so could load file contents and handle it). Opened input stream is always closed after closure execution.
    throws:
    IllegalArgumentException if file not found in jar
    
    Parameters:
    jar - jar file to search in
    filePath - file path inside jar
    action - closure to handle file contents
    Returns:
    value returned by action closure
  - @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static java.util.Set<java.io.File> resolveIgnoredFiles(org.gradle.api.file.FileTree files, java.util.Collection<java.lang.String> excludes)
    
    Resolves excluded files of file set.
    Parameters:
    files - files collection
    excludes - exclude patterns
    Returns:
    set of excluded files

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class FileUtils

Methods Summary

Inherited Methods Summary

Method Detail

@java.lang.SuppressWarnings('DuplicateStringLiteral') static java.lang.String extractJavaClass(java.util.Collection<java.io.File> roots, java.io.File file)

static java.io.File findConfigurationJar(org.gradle.api.Project project, java.lang.String configurationName, java.lang.String jarIdentity)

static org.gradle.api.tasks.SourceSet findMatchingSet(java.lang.String baseName, java.lang.String taskName, java.util.Collection<org.gradle.api.tasks.SourceSet> sets)

<T> static T loadFileFromJar(java.io.File jar, java.lang.String filePath, groovy.lang.Closure<T> action)

@groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static java.util.Set<java.io.File> resolveIgnoredFiles(org.gradle.api.file.FileTree files, java.util.Collection<java.lang.String> excludes)