ReportUtils (gradle-quality-plugin 4.2.2 API)

ru.vyarus.gradle.plugin.quality.report.ReportUtils

Reporting utils.
Authors:
Vyacheslav Rusakov
Since:
16.11.2015

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`extractFile(java.lang.String path)` @param path absolute path to source file
	`static java.lang.String`	`extractJavaPackage(org.gradle.api.Project project, java.lang.String type, java.lang.String file)` Resolve java package from provided absolute source path.
	`static java.lang.String`	`extractJavaPackage(org.gradle.api.Project project, java.lang.String file)` Special version of package matching mechanism for muti-module resolution: looks for all source sets and all child modules.
	`static java.lang.String`	`noRootFilePath(java.io.File file)` @param file file to resolve path
	`static java.lang.String`	`toConsoleLink(java.io.File file)` @param file file
	`static java.lang.String`	`unescapeHtml(java.lang.String html)` Unescapes html string.

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
  - static java.lang.String extractFile(java.lang.String path)
    
    Parameters:
    path - absolute path to source file
    Returns:
    file name without path
  - @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static java.lang.String extractJavaPackage(org.gradle.api.Project project, java.lang.String type, java.lang.String file)
    
    Resolve java package from provided absolute source path. Use configured java source roots to properly detect class package.
    Parameters:
    project - project instance
    type - execution type (main or test)
    file - absolute path to source file
    Returns:
    package for provided java class path
  - static java.lang.String extractJavaPackage(org.gradle.api.Project project, java.lang.String file)
    
    Special version of package matching mechanism for muti-module resolution: looks for all source sets and all child modules.
    Parameters:
    project - project instance
    file - absolute path to source file
    Returns:
    package for provided java class path
  - static java.lang.String noRootFilePath(java.io.File file)
    
    Parameters:
    file - file to resolve path
    Returns:
    canonical file path with '/' as separator and without leading slash for linux
  - static java.lang.String toConsoleLink(java.io.File file)
    
    Parameters:
    file - file
    Returns:
    file link to use in console output
  - static java.lang.String unescapeHtml(java.lang.String html)
    
    Unescapes html string. Uses XmlSlurper as the simplest way.
    Parameters:
    html - html
    Returns:
    raw string without html specific words

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class ReportUtils

Methods Summary

Inherited Methods Summary

Method Detail

static java.lang.String extractFile(java.lang.String path)

@groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static java.lang.String extractJavaPackage(org.gradle.api.Project project, java.lang.String type, java.lang.String file)

static java.lang.String extractJavaPackage(org.gradle.api.Project project, java.lang.String file)

static java.lang.String noRootFilePath(java.io.File file)

static java.lang.String toConsoleLink(java.io.File file)

static java.lang.String unescapeHtml(java.lang.String html)