common-plugin

alltypes

abstract class AbstractFileTransfer : FileTransferHandler, Serializable

AbstractFileTransfer(common: CommonExtension)
protected val common: CommonExtension
open fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String): Unit
fun downloader(): FileDownloader
open fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open var enabled: Boolean
open fun list(dirUrl: String): List<FileEntry>
open val parallelable: Boolean
open fun stat(dirUrl: String, fileName: String): FileEntry?
open fun truncate(dirUrl: String): Unit
fun uploader(): FileUploader
open fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

open class Await : RuntimeDefaultTask

Await()
const val NAME: String

object Behaviors

class Timer

Timer()
val elapsed: Long
fun reset(): Unit
val started: Long
fun tick(): Unit
val ticks: Long

fun waitFor(duration: Int): Unit
fun waitFor(duration: Long): Unit
fun waitUntil(interval: Int, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: Long, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: (Long) -> Long, condition: (Timer) -> Boolean): Unit

class BuildScope

BuildScope()
@Synchronized fun doOnce(operation: String, action: () -> Unit): Boolean?
fun <T : Any> get(key: String): T?
fun <T : Any> getOrPut(key: String, defaultValue: () -> T): T
fun <T : Any> getOrPut(key: String, defaultValue: () -> T, invalidate: Boolean): T
fun of(project: Project): BuildScope
fun <T : Any> put(key: String, value: T): Unit
fun <T : Any> tryGetOrPut(key: String, defaultValue: () -> T?): T?

class CollectingLogger

CollectingLogger()
fun debug(message: String): Unit
fun debug(summary: String, details: String): Unit
val entries: MutableList<LogEntry>
fun error(message: String): Unit
fun error(summary: String, details: String): Unit
fun info(message: String): Unit
fun info(summary: String, details: String): Unit
fun lifecycle(message: String): Unit
fun lifecycle(summary: String, details: String): Unit
fun log(level: LogLevel, details: String, summary: String? = null): Unit
data class LogEntry

LogEntry(level: LogLevel, details: String, summary: String? = null)
val details: String
val level: LogLevel
val summary: String?

fun logTo(logger: Logger, levelMapper: (LogLevel) -> LogLevel = { it }): Unit
fun warn(message: String): Unit
fun warn(summary: String, details: String): Unit

abstract class CommonDefaultPlugin : Plugin<Project>

CommonDefaultPlugin()
open fun apply(project: Project): Unit
abstract fun Project.configureProject(): Unit
fun Project.tasks(configurer: TaskFacade.() -> Unit): Unit

open class CommonDefaultTask : DefaultTask, CommonTask

CommonDefaultTask()
fun checkForce(): Unit
val common: CommonExtension
open fun projectEvaluated(): Unit
fun projectEvaluated(callback: () -> Unit): Unit
open fun projectsEvaluated(): Unit
fun projectsEvaluated(callback: () -> Unit): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun taskGraphReady(callback: (TaskExecutionGraph) -> Unit): Unit

open class CommonException : GradleException

CommonException(message: String, cause: Throwable)
CommonException(message: String)

open class CommonExtension

CommonExtension(project: Project)
val buildScope: BuildScope
val fileTransfer: FileTransferManager
fun fileTransfer(options: FileTransferManager.() -> Unit): Unit
val formats: Formats
fun <T> http(consumer: HttpClient.() -> T): T
fun <T> httpFile(consumer: HttpFileTransfer.() -> T): T
val logger: Logger!
const val NAME: String
val notifier: NotifierFacade
fun notifier(configurer: NotifierFacade.() -> Unit): Unit
val obj: ObjectFactory
fun of(project: Project): CommonExtension
val parallel: Parallel
val patterns: Patterns
fun <T> progress(total: Int, action: ProgressIndicator.() -> T): T
fun <T> progress(total: Long, action: ProgressIndicator.() -> T): T
fun <T> progress(action: ProgressIndicator.() -> T): T
fun progressCountdown(time: Long): Unit
fun progressCountdown(options: ProgressCountdown.() -> Unit): Unit
fun <T> progressIndicator(action: ProgressIndicator.() -> T): T
fun <T> progressLogger(action: ProgressLogger.() -> T): T
val project: Project
val prop: PropertyParser
fun resolveFile(value: Any): File
fun resolveFile(options: FileResolver.() -> Unit): File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
fun retry(configurer: Retry.() -> Unit): Retry
fun retry(): Retry
val services: ServiceAccessor
fun <T> sftpFile(consumer: SftpFileTransfer.() -> T): T
fun <T> smbFile(consumer: SmbFileTransfer.() -> T): T
val tasks: TaskFacade
fun tasks(configurer: TaskFacade.() -> Unit): Unit
const val TEMPORARY_DIR: String
val temporaryDir: File
fun temporaryFile(path: String): File
val userInput: UserInputHandler
fun waitFor(time: Long): Unit
fun watchFiles(options: FileWatcher.() -> Unit): Unit

class CommonPlugin : Plugin<Project>

CommonPlugin()
fun apply(project: Project): Unit
const val ID: String

interface CommonTask : Task

abstract val common: CommonExtension
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

class CustomFileTransfer : ProtocolFileTransfer

CustomFileTransfer(common: CommonExtension)
fun delete(callback: (dirUrl: String, fileName: String) -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun download(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun exists(callback: (dirUrl: String, fileName: String) -> Boolean): Unit
fun exists(dirUrl: String, fileName: String): Boolean
fun list(callback: (dirUrl: String) -> List<FileEntry>): Unit
fun list(dirUrl: String): List<FileEntry>
lateinit var name: String
var parallelable: Boolean
lateinit var protocols: List<String>
fun truncate(callback: (dirUrl: String) -> Unit): Unit
fun truncate(dirUrl: String): Unit
fun upload(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class DelegatingFileAlterationListener : FileAlterationListener

DelegatingFileAlterationListener(notify: (Event) -> Unit)
fun onDirectoryChange(directory: File?): Unit
fun onDirectoryCreate(directory: File): Unit
fun onDirectoryDelete(directory: File): Unit
fun onFileChange(file: File): Unit
fun onFileCreate(file: File): Unit
fun onFileDelete(file: File): Unit
fun onStart(observer: FileAlterationObserver?): Unit
fun onStop(observer: FileAlterationObserver?): Unit

class DependencyFile

DependencyFile(project: Project, notation: Any)
val dependency: Dependency
val file: File
fun hintNotation(notation: Any, extensionHint: String): Any
fun isNotation(text: String): Boolean

open class Destroy : RuntimeDefaultTask

Destroy()
const val NAME: String

class DorkboxNotifier : Notifier

DorkboxNotifier(facade: NotifierFacade, configurer: Notify.() -> Unit)
val configurer: Notify.() -> Unit
val DORKBOX_DARK_LIGHT_THEME: Theme
const val DORKBOX_HIDE_AFTER_SECONDS: Long
val facade: NotifierFacade
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit): Unit

open class Down : RuntimeDefaultTask

Down()
const val NAME: String

class Event

Event(file: File, type: EventType)
val file: File
fun toString(): String
val type: EventType

enum class EventType

DIR_CREATED
DIR_DELETED
FILE_CHANGED
FILE_CREATED
FILE_DELETED

class FileContentReader : BaseFilterReader, ChainableReader

FileContentReader(input: Reader)
fun chain(reader: Reader): Reader
fun filter(filterable: ContentFilterable, filter: (String) -> String): Unit
fun props(filter: (String) -> String): Map<String, (String) -> String>
fun read(): Int

class FileDownloader

FileDownloader(common: CommonExtension)
fun download(size: Long, input: InputStream, target: File): Unit
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File, startDownloadTime: Long): Unit
fun remainingDownloadTime(startDownloadTime: Long, fullLength: Long): Long
const val TRANSFER_CHUNK_100_KB: Int

data class FileEntry

FileEntry(name: String, size: Long? = null, modified: Long? = null)
val modified: Long?
val name: String
fun of(file: File): FileEntry
val size: Long?

open class FileException : CommonException

FileException(message: String, cause: Throwable)
FileException(message: String)

open class FileGroup

FileGroup(resolver: Resolver<FileGroup>, name: String)
protected open fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val dirs: List<File>
val files: List<File>
val name: String
val resolutions: List<FileResolution>
fun resolve(id: String, resolver: (FileResolution) -> File): FileResolution
fun resolve(): List<File>
val resolver: Resolver<FileGroup>

open class FileResolution

FileResolution(group: FileGroup, id: String, resolver: (FileResolution) -> File)
fun archiveFile(archive: File, entryPattern: String): File
fun archiveFiles(archive: File, entriesPattern: String): Sequence<File>
fun archiveTree(archive: File): FileTree
fun copyArchiveFile(archive: File, entryPattern: String, target: File): File
fun copyArchiveFiles(archive: File, entriesPattern: String, targetDir: File): Unit
fun copyFile(source: File, target: File): Unit
fun copyToDirectory(source: File, targetDir: File): Unit
val dir: File
val file: File
val group: FileGroup
val id: String
fun resolve(): File
fun then(operation: FileResolution.(File) -> File): Unit
fun use(operation: FileResolution.(File) -> Unit): Unit

open class FileResolver : Resolver<FileGroup>

FileResolver(common: CommonExtension)
open fun createGroup(name: String): FileGroup

interface FileTransfer

open fun delete(fileUrl: String): Unit
abstract fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String, target: File): Unit
abstract fun download(fileUrl: String): Unit
abstract fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open fun downloadTo(fileUrl: String, dir: File): File
open fun exists(fileUrl: String): Boolean
open fun exists(dirUrl: String, fileName: String): Boolean
abstract fun handles(fileUrl: String): Boolean
abstract fun list(dirUrl: String): List<FileEntry>
fun splitFileUrl(fileUrl: String): Pair<String, String>
abstract fun stat(dirUrl: String, fileName: String): FileEntry?
open fun stat(fileUrl: String): FileEntry?
abstract fun truncate(dirUrl: String): Unit
open fun upload(fileUrl: String, source: File): Unit
abstract fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
open fun uploadTo(dirUrl: String, source: File): Unit

open class FileTransferException : CommonException

FileTransferException(message: String, cause: Throwable)
FileTransferException(message: String)

class FileTransferFactory

FileTransferFactory(common: CommonExtension)
fun <T> http(options: HttpFileTransfer.() -> T): T
fun <T> sftp(options: SftpFileTransfer.() -> T): T
fun <T> smb(options: SmbFileTransfer.() -> T): T

interface FileTransferHandler : FileTransfer

abstract val enabled: Boolean
abstract val name: String
abstract val parallelable: Boolean

class FileTransferManager : FileTransfer

FileTransferManager(common: CommonExtension)
val credentials: Pair<String, String>
fun credentials(user: String?, password: String?, domain: String? = null): Unit
val credentialsString: String
fun custom(name: String, definition: CustomFileTransfer.() -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
var domain: String?
fun download(fileUrl: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, fileUrl: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, target: File): Unit
val factory: FileTransferFactory
fun handles(fileUrl: String): Boolean
fun handling(fileUrl: String): FileTransferHandler
val http: HttpFileTransfer
fun http(options: HttpFileTransfer.() -> Unit): Unit
fun list(dirUrl: String): List<FileEntry>
const val NAME: String
fun named(name: String): FileTransfer
var password: String?
val path: PathFileTransfer
fun path(options: PathFileTransfer.() -> Unit): Unit
val resolve: ResolveFileTransfer
fun resolve(options: ResolveFileTransfer.() -> Unit): Unit
val sftp: SftpFileTransfer
fun sftp(options: SftpFileTransfer.() -> Unit): Unit
val smb: SmbFileTransfer
fun smb(options: SmbFileTransfer.() -> Unit): Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
const val TMP_SUFFIX: String
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, fileUrl: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, source: File): Unit
val url: UrlFileTransfer
fun url(options: UrlFileTransfer.() -> Unit): Unit
var user: String?

class FileUploader

FileUploader(common: CommonExtension)
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File): Unit
const val TRANSFER_CHUNK_100_KB: Int
fun upload(file: File, output: OutputStream, cleanup: (File) -> Unit = {}): Unit

open class FileWatcher

FileWatcher(common: CommonExtension)
val common: CommonExtension
lateinit var dirs: List<File>
fun ignore(vararg paths: String): Unit
fun ignore(paths: Iterable<String>): Unit
var ignores: MutableList<String>
var interval: Long
lateinit var onChange: (Event) -> Unit
fun start(): Unit

class FileWatcherException : CommonException

FileWatcherException(message: String, cause: Throwable)
FileWatcherException(message: String)

object Formats

fun asHtml(value: String): Document!
fun asHtml(input: InputStream): Document!
fun asJson(input: InputStream): DocumentContext!
fun asJson(value: String): DocumentContext!
fun asVersion(value: String, partsTaken: Int = 3): GradleVersion
fun date(date: Date = Date()): String
fun dateFileName(date: Date = Date()): String
fun duration(millis: Long): String
fun durationFit(thenMillis: Long, thenZoneId: ZoneId, durationMillis: Long): Boolean
fun durationSince(millis: Long): String
fun fileSize(file: File): String
fun fileSizeBytesToHuman(bytes: Long): String
fun <reified T : Any> fromJson(json: String): T
fun <T> fromJson(input: InputStream, clazz: Class<T>): T
fun <T> fromJson(json: String, clazz: Class<T>): T
fun fromJsonToMap(json: String): Map<String, Any?>
fun normalizePath(path: String): String
fun percent(current: Int, total: Int): String
fun percent(current: Long, total: Long): String
fun percentExplained(current: Int, total: Int): String
fun percentExplained(current: Long, total: Long): String
fun projectPath(file: File, project: Project): String
fun projectPath(path: String, project: Project): String
fun relativePath(path: String, basePath: String): String
fun rootProjectPath(file: File, project: Project): String
fun rootProjectPath(path: String, project: Project): String
fun toBase64(value: String): String
fun toJson(value: Any, pretty: Boolean = true): String
fun toJson(value: Map<String, Any?>, pretty: Boolean = true): String
fun toList(value: String?, delimiter: String = ","): List<String>?
fun toMap(value: String?, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
fun toMd5(text: String): String
fun toPassword(value: String): String
fun versionAtLeast(actual: String, required: String): Boolean
fun versionUnknown(): GradleVersion!

open class HttpClient

HttpClient(common: CommonExtension)
fun asHtml(response: HttpResponse): Document
fun asHtml(htmlString: String): Document
fun asJson(response: HttpResponse): DocumentContext
fun asJson(jsonString: String): DocumentContext
fun <reified T : Any> asObjectFromJson(response: HttpResponse): T
fun <T> asObjectFromJson(response: HttpResponse, clazz: Class<T>): T
fun asStream(response: HttpResponse): InputStream
fun asString(response: HttpResponse): String
var authorizationPreemptive: Boolean
var baseUrl: String
open fun baseUrl(uri: String): String
var basicCredentials: Pair<String?, String?>
var basicPassword: String?
var basicUser: String?
fun checkHtml(response: HttpResponse, validator: Document.() -> Boolean): Unit
fun checkStatus(response: HttpResponse, statusCodes: IntRange = STATUS_CODE_VALID): Unit
fun checkStatus(response: HttpResponse, statusCode: Int): Unit
fun checkStatus(response: HttpResponse, statusCodes: List<Int>): Unit
fun checkText(response: HttpResponse, containedText: String, ignoreCase: Boolean = true): Unit
val client: CloseableHttpClient!
var clientBuilder: HttpClientBuilder.() -> Unit
var connectionIgnoreSsl: Boolean
var connectionRetries: Boolean
var connectionTimeout: Int
open fun createEntityMultipart(params: Map<String, Any?>): HttpEntity
open fun createEntityUrlencoded(params: Map<String, Any?>): HttpEntity
fun delete(uri: String): Unit
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpDelete.() -> Unit): T
open fun <T> execute(method: HttpRequestBase, handler: HttpClient.(HttpResponse) -> T): T
fun execute(method: HttpRequestBase): Unit
fun <T> fileTransfer(operation: HttpFileTransfer.() -> T): T
fun get(uri: String): Unit
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpGet.() -> Unit): T
fun head(uri: String): Unit
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpHead.() -> Unit): T
fun patch(path: String): Unit
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPatch.() -> Unit): T
fun post(url: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> post(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPost.() -> Unit): T
fun postMultipart(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postMultipart(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun postUrlencoded(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postUrlencoded(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
var proxyHost: String?
var proxyPort: Int?
var proxyScheme: String?
fun put(uri: String): Unit
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPut.() -> Unit): T
fun <T> request(method: String, uri: String, handler: HttpClient.(HttpResponse) -> T): T
var requestConfigurer: HttpRequestBase.() -> Unit
var responseChecker: (HttpResponse) -> Unit
var responseChecks: Boolean
var responseHandler: (HttpResponse) -> Unit
val STATUS_CODE_VALID: IntRange
open fun throwStatusException(response: HttpResponse): Unit

open class HttpException : CommonException

HttpException(message: String, cause: Throwable)
HttpException(message: String)

class HttpFileException : FileException

HttpFileException(message: String, cause: Throwable)
HttpFileException(message: String)

class HttpFileTransfer : ProtocolFileTransfer

HttpFileTransfer(common: CommonExtension, client: HttpClient = client(common))
fun client(configurer: HttpClient.() -> Unit): Unit
var client: HttpClient
fun client(common: CommonExtension): HttpClient
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
val protocols: List<String>

open class JarTask : Jar, CommonTask

JarTask()
val common: CommonExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

class JsonPassword : JsonSerializer<String>

JsonPassword()
fun serialize(value: String?, generator: JsonGenerator, serializers: SerializerProvider): Unit

kotlin.collections.Iterable

fun <T> Iterable<T>.onEachApply(block: T.() -> Unit): Iterable<T>

interface Notifier

abstract fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit

class NotifierFacade

val common: CommonExtension
var config: NotifierFacade.() -> Notifier
fun custom(notifier: (title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit) -> Unit): Notifier
fun dorkbox(configurer: Notify.() -> Unit = {}): Notifier
var enabled: Boolean
fun error(title: String, text: String): Unit
var image: File
fun info(title: String, text: String): Unit
fun lifecycle(title: String, text: String): Unit
fun log(title: String): Unit
fun log(title: String, message: String): Unit
fun log(title: String, message: String, level: LogLevel): Unit
fun notify(title: String): Unit
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit
fun notify(title: String, text: String): Unit
fun of(common: CommonExtension): NotifierFacade
fun warn(title: String, text: String): Unit

class ObjectFactory

ObjectFactory(project: Project)
fun boolean(options: Property<Boolean>.() -> Unit = {}): Property<Boolean!>!
fun buildDir(path: String): DirectoryProperty!
fun buildFile(path: String): RegularFileProperty!
fun dir(options: DirectoryProperty.() -> Unit = {}): DirectoryProperty!
val factory: ObjectFactory!
fun file(options: RegularFileProperty.() -> Unit = {}): RegularFileProperty!
fun files(options: ConfigurableFileCollection.() -> Unit = {}): ConfigurableFileCollection!
fun int(options: Property<Int>.() -> Unit = {}): Property<Int!>!
val layout: ProjectLayout!
inline fun <reified T> list(options: ListProperty<T>.() -> Unit = {}): ListProperty<T>!
fun long(options: Property<Long>.() -> Unit = {}): Property<Long!>!
inline fun <reified K, reified V> map(options: MapProperty<K, V>.() -> Unit = {}): MapProperty<K, V>!
fun projectDir(path: String): DirectoryProperty!
fun projectFile(path: String): RegularFileProperty!
fun <T> provider(value: () -> T): Provider<T>!
fun relativeDir(dir: DirectoryProperty, path: String): DirectoryProperty!
fun relativeFile(dir: DirectoryProperty, path: String): RegularFileProperty!
fun string(options: Property<String>.() -> Unit = {}): Property<String!>!
fun strings(options: ListProperty<String>.() -> Unit = {}): ListProperty<String!>!
inline fun <reified T> typed(options: Property<T>.() -> Unit = {}): Property<T>!

org.gradle.api.Project

val Project.common: CommonExtension

object Parallel

fun <A> each(iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> map(iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): Collection<B>
fun <A, B : Any> map(iterable: Iterable<A>, filter: (A) -> Boolean, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> poolEach(threads: Int, name: String, iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> poolMap(threads: Int, name: String, iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> with(iterable: Iterable<A>, callback: A.() -> Unit): Unit

class PathFileTransfer : AbstractFileTransfer

PathFileTransfer(common: CommonExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

object Patterns

const val WILDCARD: String
fun wildcard(file: File, matcher: String): Boolean
fun wildcard(file: File, matchers: Iterable<String>): Boolean
fun wildcard(path: String, matcher: String): Boolean
fun wildcard(path: String, matchers: Iterable<String>): Boolean
const val WILDCARD_NEGATION: String
const val WILDCARD_SEPARATOR: String

class PreemptiveAuthInterceptor : HttpRequestInterceptor

PreemptiveAuthInterceptor()
fun process(request: HttpRequest, context: HttpContext): Unit

class ProgressCountdown

ProgressCountdown(project: Project)
var loggerInterval: Int
fun progress(messageComposer: (Long) -> String): Unit
fun run(): Unit
var time: Long
var timePrefix: String

class ProgressIndicator

ProgressIndicator(project: Project)
var count: Long
fun increment(): Unit
fun increment(message: String): Unit
fun <T> increment(message: String, block: () -> T): T
fun <T> launch(block: ProgressIndicator.() -> T): T
var message: String
fun reset(): Unit
var step: String
var total: Long
fun update(): Unit
fun update(message: String): Unit
fun updater(updater: ProgressIndicator.() -> Unit): Unit

open class ProgressLogger

var header: String
fun <T> launch(block: ProgressLogger.() -> T): T
fun of(project: Project): ProgressLogger
fun parents(project: Project): Queue<ProgressLogger>
fun progress(message: String): Unit
var progressEach: (String) -> Unit
var progressWindow: Long

open class PropertyException : CommonException

PropertyException(message: String, cause: Throwable)
PropertyException(message: String)

class PropertyParser

PropertyParser(project: Project)
fun boolean(name: String): Boolean?
val envProps: MutableMap<String!, String!>!
fun expand(file: File, props: Map<String, Any?>): Unit
fun expand(source: String, props: Map<String, Any?>, context: String? = null): String
fun file(name: String, projectRelative: Project): File?
fun file(name: String, projectRootFallback: Boolean = true): File?
fun flag(vararg names: String): Boolean
fun flag(name: String): Boolean
val force: Boolean
const val FORCE_PROP: String
fun int(name: String): Int?
fun list(name: String, delimiter: String = ","): List<String>?
fun long(name: String): Long?
fun map(name: String, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
fun string(name: String): String?
val systemProps: Map<String, String>

abstract class ProtocolFileTransfer : AbstractFileTransfer

ProtocolFileTransfer(common: CommonExtension)
open fun handles(fileUrl: String): Boolean
abstract val protocols: List<String>

class RequestException : HttpException

RequestException(message: String, cause: Throwable)
RequestException(message: String)

open class Resetup : RuntimeDefaultTask

Resetup()
const val NAME: String

open class Resolve : RuntimeDefaultTask

Resolve()
const val NAME: String

class ResolveFileException : FileException

ResolveFileException(message: String, cause: Throwable)
ResolveFileException(message: String)

class ResolveFileTransfer : ProtocolFileTransfer

ResolveFileTransfer(aem: CommonExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
val name: String
const val NAME: String
val parallelable: Boolean
val protocols: List<String>
fun resolve(value: Any): File

abstract class Resolver<G : FileGroup>

Resolver(common: CommonExtension)
val allFiles: List<File>
fun allFiles(filter: G.() -> Boolean): List<File>
fun allGroups(filter: G.() -> Boolean): List<G>
val common: CommonExtension
fun config(configurer: G.() -> Unit): Unit
abstract fun createGroup(name: String): G
fun download(urlDir: String, vararg fileNames: String): List<FileResolution>
fun download(urlDir: String, fileNames: Iterable<String>): List<FileResolution>
fun download(url: String): FileResolution
const val DOWNLOAD_DIR_DEFAULT: String
val downloadDir: DirectoryProperty!
fun downloadHttp(url: String, options: HttpFileTransfer.() -> Unit): FileResolution
fun downloadSftp(url: String, options: SftpFileTransfer.() -> Unit): FileResolution
fun downloadSmb(url: String, options: SmbFileTransfer.() -> Unit): FileResolution
fun get(value: Any): FileResolution
fun group(name: String): G
@Synchronized fun group(name: String, configurer: Resolver<G>.() -> Unit): Unit
fun group(name: String, downloadUrl: String): Unit
const val GROUP_DEFAULT: String
val groups: List<G>
operator fun String.invoke(value: Any): Unit
operator fun String.invoke(url: String, vararg fileNames: String): Unit
operator fun String.invoke(configurer: Resolver<G>.() -> Unit): Unit
val localFilePatterns: ListProperty<String!>!
val outputDirs: List<File>
fun outputDirs(filter: G.() -> Boolean): List<File>
val parallelLevel: Property<Int!>!
fun resolve(dependencyNotation: Any): FileResolution
fun useLocal(path: String): FileResolution
fun useLocal(sourceFile: File): FileResolution
fun useLocalBy(dir: Any, filePatterns: Iterable<String>, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalBy(dir: Any, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalLastModified(dir: Any): FileResolution?
fun useLocalLastNamed(dir: Any): FileResolution?
fun useLocalRecent(dir: Any): FileResolution?

class ResponseException : HttpException

ResponseException(message: String, cause: Throwable)
ResponseException(message: String)

open class Restart : RuntimeDefaultTask

Restart()
const val NAME: String

class Retry

fun after(times: Long, delay: (Long) -> Long): Unit
fun afterSecond(times: Long): Unit
fun afterSquaredSecond(times: Long): Unit
val common: CommonExtension
var delay: (Long) -> Long
fun none(common: CommonExtension): Retry
const val SECOND_MILLIS: Long
var times: Long
inline fun <T, reified E> withCountdown(operation: String, block: (Long) -> T): T
inline fun <T, reified E> withSleep(block: (Long) -> T): T

open class RuntimeDefaultTask : CommonDefaultTask

RuntimeDefaultTask()

class RuntimePlugin : CommonDefaultPlugin

RuntimePlugin()
fun Project.configureProject(): Unit

open class ServiceAccessor

ServiceAccessor(project: Project)
fun <reified T : Any> get(): T
operator fun invoke(obj: Any, method: String, vararg args: Any): Any
fun invoke(obj: Any, method: String, args: List<Any?>, argTypes: List<Class<out Any>>): Any
val project: Project
val serviceFactory: Any

open class Setup : RuntimeDefaultTask

Setup()
const val NAME: String

class SftpFileException : FileException

SftpFileException(message: String, cause: Throwable)
SftpFileException(message: String)

class SftpFileTransfer : ProtocolFileTransfer

SftpFileTransfer(common: CommonExtension)
fun client(options: SshClient.() -> Unit): Unit
var clientOptions: SshClient.() -> Unit
fun <T> connect(url: String, callback: SftpClient.(String) -> T): T
fun <T> connectDir(dirUrl: String, callback: SftpClient.(String) -> T): T
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
const val PORT_DEFAULT: Int
val protocols: List<String>
fun session(options: ClientSession.() -> Unit): Unit
var sessionOptions: ClientSession.() -> Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
val STATUS_NOT_EXISTS: Array<Int>
var timeout: Long
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

class SmbFileException : FileException

SmbFileException(message: String, cause: Throwable)
SmbFileException(message: String)

class SmbFileTransfer : ProtocolFileTransfer

SmbFileTransfer(common: CommonExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun dir(dirUrl: String): SmbFile
var domain: String?
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun file(dirUrl: String, fileName: String): SmbFile
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
val protocols: List<String>
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

class TaskFacade : Serializable

TaskFacade(project: Project)
val checks: List<Task>
fun composeException(taskName: String, type: Class<*>? = null, cause: Exception? = null, project: Project = this.project): CommonException
fun define(name: String, configurer: CommonDefaultTask.() -> Unit = {}): TaskProvider<CommonDefaultTask>
fun <reified T : Task> get(path: String): T
fun <reified T : Task> getAll(): List<T>
@Synchronized fun <T : Task> getAllSafely(type: Class<T>): List<T>
@Synchronized fun getSafely(path: String): Task?
inline fun <reified T : Task> named(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <reified T : Task> pathed(path: String): TaskProvider<T>
fun pathed(paths: Collection<Any>): List<TaskProvider<out Task>>
val project: Project
inline fun <reified T : Task> register(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun registerSequence(name: String, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun registerSequence(name: String, taskOptions: Task.() -> Unit, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
val tests: List<Test>
inline fun <reified T : Task> typed(noinline configurer: T.() -> Unit): Unit

class TaskSequence

TaskSequence()
var afterTasks: Collection<Any>
var dependentTasks: Collection<Any>
fun dependsOn(vararg tasks: Any): Unit
fun dependsOn(tasks: Collection<Any>): Unit
fun dependsOrdered(vararg tasks: Any): Unit
fun mustRunAfter(vararg tasks: Any): Unit
fun mustRunAfter(tasks: Collection<Any>): Unit

open class Up : RuntimeDefaultTask

Up()
const val NAME: String

class UrlFileTransfer : ProtocolFileTransfer

UrlFileTransfer(common: CommonExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
const val PROTOCOL: String
val protocols: List<String>

object Utils

fun mapOfNonNullValues(vararg entries: Pair<String, String?>): Map<String, String>
fun unroll(value: Any?, callback: (Any?) -> Unit): Unit

open class ZipTask : Zip, CommonTask

ZipTask()
val common: CommonExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

package com.cognifide.gradle.common

abstract class CommonDefaultPlugin : Plugin<Project>

CommonDefaultPlugin()
open fun apply(project: Project): Unit
abstract fun Project.configureProject(): Unit
fun Project.tasks(configurer: TaskFacade.() -> Unit): Unit

open class CommonDefaultTask : DefaultTask, CommonTask

CommonDefaultTask()
fun checkForce(): Unit
val common: CommonExtension
open fun projectEvaluated(): Unit
fun projectEvaluated(callback: () -> Unit): Unit
open fun projectsEvaluated(): Unit
fun projectsEvaluated(callback: () -> Unit): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun taskGraphReady(callback: (TaskExecutionGraph) -> Unit): Unit

open class CommonException : GradleException

CommonException(message: String, cause: Throwable)
CommonException(message: String)

open class CommonExtension

CommonExtension(project: Project)
val buildScope: BuildScope
val fileTransfer: FileTransferManager
fun fileTransfer(options: FileTransferManager.() -> Unit): Unit
val formats: Formats
fun <T> http(consumer: HttpClient.() -> T): T
fun <T> httpFile(consumer: HttpFileTransfer.() -> T): T
val logger: Logger!
const val NAME: String
val notifier: NotifierFacade
fun notifier(configurer: NotifierFacade.() -> Unit): Unit
val obj: ObjectFactory
fun of(project: Project): CommonExtension
val parallel: Parallel
val patterns: Patterns
fun <T> progress(total: Int, action: ProgressIndicator.() -> T): T
fun <T> progress(total: Long, action: ProgressIndicator.() -> T): T
fun <T> progress(action: ProgressIndicator.() -> T): T
fun progressCountdown(time: Long): Unit
fun progressCountdown(options: ProgressCountdown.() -> Unit): Unit
fun <T> progressIndicator(action: ProgressIndicator.() -> T): T
fun <T> progressLogger(action: ProgressLogger.() -> T): T
val project: Project
val prop: PropertyParser
fun resolveFile(value: Any): File
fun resolveFile(options: FileResolver.() -> Unit): File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
fun retry(configurer: Retry.() -> Unit): Retry
fun retry(): Retry
val services: ServiceAccessor
fun <T> sftpFile(consumer: SftpFileTransfer.() -> T): T
fun <T> smbFile(consumer: SmbFileTransfer.() -> T): T
val tasks: TaskFacade
fun tasks(configurer: TaskFacade.() -> Unit): Unit
const val TEMPORARY_DIR: String
val temporaryDir: File
fun temporaryFile(path: String): File
val userInput: UserInputHandler
fun waitFor(time: Long): Unit
fun watchFiles(options: FileWatcher.() -> Unit): Unit

class CommonPlugin : Plugin<Project>

CommonPlugin()
fun apply(project: Project): Unit
const val ID: String

interface CommonTask : Task

abstract val common: CommonExtension
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

org.gradle.api.Project

val Project.common: CommonExtension

open class RuntimeDefaultTask : CommonDefaultTask

RuntimeDefaultTask()

class RuntimePlugin : CommonDefaultPlugin

RuntimePlugin()
fun Project.configureProject(): Unit

package com.cognifide.gradle.common.build

object Behaviors

class Timer

Timer()
val elapsed: Long
fun reset(): Unit
val started: Long
fun tick(): Unit
val ticks: Long

fun waitFor(duration: Int): Unit
fun waitFor(duration: Long): Unit
fun waitUntil(interval: Int, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: Long, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: (Long) -> Long, condition: (Timer) -> Boolean): Unit

class BuildScope

BuildScope()
@Synchronized fun doOnce(operation: String, action: () -> Unit): Boolean?
fun <T : Any> get(key: String): T?
fun <T : Any> getOrPut(key: String, defaultValue: () -> T): T
fun <T : Any> getOrPut(key: String, defaultValue: () -> T, invalidate: Boolean): T
fun of(project: Project): BuildScope
fun <T : Any> put(key: String, value: T): Unit
fun <T : Any> tryGetOrPut(key: String, defaultValue: () -> T?): T?

class CollectingLogger

CollectingLogger()
fun debug(message: String): Unit
fun debug(summary: String, details: String): Unit
val entries: MutableList<LogEntry>
fun error(message: String): Unit
fun error(summary: String, details: String): Unit
fun info(message: String): Unit
fun info(summary: String, details: String): Unit
fun lifecycle(message: String): Unit
fun lifecycle(summary: String, details: String): Unit
fun log(level: LogLevel, details: String, summary: String? = null): Unit
data class LogEntry

LogEntry(level: LogLevel, details: String, summary: String? = null)
val details: String
val level: LogLevel
val summary: String?

fun logTo(logger: Logger, levelMapper: (LogLevel) -> LogLevel = { it }): Unit
fun warn(message: String): Unit
fun warn(summary: String, details: String): Unit

class DependencyFile

DependencyFile(project: Project, notation: Any)
val dependency: Dependency
val file: File
fun hintNotation(notation: Any, extensionHint: String): Any
fun isNotation(text: String): Boolean

class ObjectFactory

ObjectFactory(project: Project)
fun boolean(options: Property<Boolean>.() -> Unit = {}): Property<Boolean!>!
fun buildDir(path: String): DirectoryProperty!
fun buildFile(path: String): RegularFileProperty!
fun dir(options: DirectoryProperty.() -> Unit = {}): DirectoryProperty!
val factory: ObjectFactory!
fun file(options: RegularFileProperty.() -> Unit = {}): RegularFileProperty!
fun files(options: ConfigurableFileCollection.() -> Unit = {}): ConfigurableFileCollection!
fun int(options: Property<Int>.() -> Unit = {}): Property<Int!>!
val layout: ProjectLayout!
inline fun <reified T> list(options: ListProperty<T>.() -> Unit = {}): ListProperty<T>!
fun long(options: Property<Long>.() -> Unit = {}): Property<Long!>!
inline fun <reified K, reified V> map(options: MapProperty<K, V>.() -> Unit = {}): MapProperty<K, V>!
fun projectDir(path: String): DirectoryProperty!
fun projectFile(path: String): RegularFileProperty!
fun <T> provider(value: () -> T): Provider<T>!
fun relativeDir(dir: DirectoryProperty, path: String): DirectoryProperty!
fun relativeFile(dir: DirectoryProperty, path: String): RegularFileProperty!
fun string(options: Property<String>.() -> Unit = {}): Property<String!>!
fun strings(options: ListProperty<String>.() -> Unit = {}): ListProperty<String!>!
inline fun <reified T> typed(options: Property<T>.() -> Unit = {}): Property<T>!

object Parallel

fun <A> each(iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> map(iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): Collection<B>
fun <A, B : Any> map(iterable: Iterable<A>, filter: (A) -> Boolean, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> poolEach(threads: Int, name: String, iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> poolMap(threads: Int, name: String, iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> with(iterable: Iterable<A>, callback: A.() -> Unit): Unit

class ProgressCountdown

ProgressCountdown(project: Project)
var loggerInterval: Int
fun progress(messageComposer: (Long) -> String): Unit
fun run(): Unit
var time: Long
var timePrefix: String

class ProgressIndicator

ProgressIndicator(project: Project)
var count: Long
fun increment(): Unit
fun increment(message: String): Unit
fun <T> increment(message: String, block: () -> T): T
fun <T> launch(block: ProgressIndicator.() -> T): T
var message: String
fun reset(): Unit
var step: String
var total: Long
fun update(): Unit
fun update(message: String): Unit
fun updater(updater: ProgressIndicator.() -> Unit): Unit

open class ProgressLogger

var header: String
fun <T> launch(block: ProgressLogger.() -> T): T
fun of(project: Project): ProgressLogger
fun parents(project: Project): Queue<ProgressLogger>
fun progress(message: String): Unit
var progressEach: (String) -> Unit
var progressWindow: Long

open class PropertyException : CommonException

PropertyException(message: String, cause: Throwable)
PropertyException(message: String)

class PropertyParser

PropertyParser(project: Project)
fun boolean(name: String): Boolean?
val envProps: MutableMap<String!, String!>!
fun expand(file: File, props: Map<String, Any?>): Unit
fun expand(source: String, props: Map<String, Any?>, context: String? = null): String
fun file(name: String, projectRelative: Project): File?
fun file(name: String, projectRootFallback: Boolean = true): File?
fun flag(vararg names: String): Boolean
fun flag(name: String): Boolean
val force: Boolean
const val FORCE_PROP: String
fun int(name: String): Int?
fun list(name: String, delimiter: String = ","): List<String>?
fun long(name: String): Long?
fun map(name: String, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
fun string(name: String): String?
val systemProps: Map<String, String>

class Retry

fun after(times: Long, delay: (Long) -> Long): Unit
fun afterSecond(times: Long): Unit
fun afterSquaredSecond(times: Long): Unit
val common: CommonExtension
var delay: (Long) -> Long
fun none(common: CommonExtension): Retry
const val SECOND_MILLIS: Long
var times: Long
inline fun <T, reified E> withCountdown(operation: String, block: (Long) -> T): T
inline fun <T, reified E> withSleep(block: (Long) -> T): T

open class ServiceAccessor

ServiceAccessor(project: Project)
fun <reified T : Any> get(): T
operator fun invoke(obj: Any, method: String, vararg args: Any): Any
fun invoke(obj: Any, method: String, args: List<Any?>, argTypes: List<Class<out Any>>): Any
val project: Project
val serviceFactory: Any

package com.cognifide.gradle.common.file

class FileContentReader : BaseFilterReader, ChainableReader

FileContentReader(input: Reader)
fun chain(reader: Reader): Reader
fun filter(filterable: ContentFilterable, filter: (String) -> String): Unit
fun props(filter: (String) -> String): Map<String, (String) -> String>
fun read(): Int

open class FileException : CommonException

FileException(message: String, cause: Throwable)
FileException(message: String)

open class FileWatcher

FileWatcher(common: CommonExtension)
val common: CommonExtension
lateinit var dirs: List<File>
fun ignore(vararg paths: String): Unit
fun ignore(paths: Iterable<String>): Unit
var ignores: MutableList<String>
var interval: Long
lateinit var onChange: (Event) -> Unit
fun start(): Unit

class FileWatcherException : CommonException

FileWatcherException(message: String, cause: Throwable)
FileWatcherException(message: String)

package com.cognifide.gradle.common.file.resolver

open class FileGroup

FileGroup(resolver: Resolver<FileGroup>, name: String)
protected open fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val dirs: List<File>
val files: List<File>
val name: String
val resolutions: List<FileResolution>
fun resolve(id: String, resolver: (FileResolution) -> File): FileResolution
fun resolve(): List<File>
val resolver: Resolver<FileGroup>

open class FileResolution

FileResolution(group: FileGroup, id: String, resolver: (FileResolution) -> File)
fun archiveFile(archive: File, entryPattern: String): File
fun archiveFiles(archive: File, entriesPattern: String): Sequence<File>
fun archiveTree(archive: File): FileTree
fun copyArchiveFile(archive: File, entryPattern: String, target: File): File
fun copyArchiveFiles(archive: File, entriesPattern: String, targetDir: File): Unit
fun copyFile(source: File, target: File): Unit
fun copyToDirectory(source: File, targetDir: File): Unit
val dir: File
val file: File
val group: FileGroup
val id: String
fun resolve(): File
fun then(operation: FileResolution.(File) -> File): Unit
fun use(operation: FileResolution.(File) -> Unit): Unit

open class FileResolver : Resolver<FileGroup>

FileResolver(common: CommonExtension)
open fun createGroup(name: String): FileGroup

abstract class Resolver<G : FileGroup>

Resolver(common: CommonExtension)
val allFiles: List<File>
fun allFiles(filter: G.() -> Boolean): List<File>
fun allGroups(filter: G.() -> Boolean): List<G>
val common: CommonExtension
fun config(configurer: G.() -> Unit): Unit
abstract fun createGroup(name: String): G
fun download(urlDir: String, vararg fileNames: String): List<FileResolution>
fun download(urlDir: String, fileNames: Iterable<String>): List<FileResolution>
fun download(url: String): FileResolution
const val DOWNLOAD_DIR_DEFAULT: String
val downloadDir: DirectoryProperty!
fun downloadHttp(url: String, options: HttpFileTransfer.() -> Unit): FileResolution
fun downloadSftp(url: String, options: SftpFileTransfer.() -> Unit): FileResolution
fun downloadSmb(url: String, options: SmbFileTransfer.() -> Unit): FileResolution
fun get(value: Any): FileResolution
fun group(name: String): G
@Synchronized fun group(name: String, configurer: Resolver<G>.() -> Unit): Unit
fun group(name: String, downloadUrl: String): Unit
const val GROUP_DEFAULT: String
val groups: List<G>
operator fun String.invoke(value: Any): Unit
operator fun String.invoke(url: String, vararg fileNames: String): Unit
operator fun String.invoke(configurer: Resolver<G>.() -> Unit): Unit
val localFilePatterns: ListProperty<String!>!
val outputDirs: List<File>
fun outputDirs(filter: G.() -> Boolean): List<File>
val parallelLevel: Property<Int!>!
fun resolve(dependencyNotation: Any): FileResolution
fun useLocal(path: String): FileResolution
fun useLocal(sourceFile: File): FileResolution
fun useLocalBy(dir: Any, filePatterns: Iterable<String>, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalBy(dir: Any, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalLastModified(dir: Any): FileResolution?
fun useLocalLastNamed(dir: Any): FileResolution?
fun useLocalRecent(dir: Any): FileResolution?

package com.cognifide.gradle.common.file.transfer

abstract class AbstractFileTransfer : FileTransferHandler, Serializable

AbstractFileTransfer(common: CommonExtension)
protected val common: CommonExtension
open fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String): Unit
fun downloader(): FileDownloader
open fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open var enabled: Boolean
open fun list(dirUrl: String): List<FileEntry>
open val parallelable: Boolean
open fun stat(dirUrl: String, fileName: String): FileEntry?
open fun truncate(dirUrl: String): Unit
fun uploader(): FileUploader
open fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class FileDownloader

FileDownloader(common: CommonExtension)
fun download(size: Long, input: InputStream, target: File): Unit
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File, startDownloadTime: Long): Unit
fun remainingDownloadTime(startDownloadTime: Long, fullLength: Long): Long
const val TRANSFER_CHUNK_100_KB: Int

data class FileEntry

FileEntry(name: String, size: Long? = null, modified: Long? = null)
val modified: Long?
val name: String
fun of(file: File): FileEntry
val size: Long?

interface FileTransfer

open fun delete(fileUrl: String): Unit
abstract fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String, target: File): Unit
abstract fun download(fileUrl: String): Unit
abstract fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open fun downloadTo(fileUrl: String, dir: File): File
open fun exists(fileUrl: String): Boolean
open fun exists(dirUrl: String, fileName: String): Boolean
abstract fun handles(fileUrl: String): Boolean
abstract fun list(dirUrl: String): List<FileEntry>
fun splitFileUrl(fileUrl: String): Pair<String, String>
abstract fun stat(dirUrl: String, fileName: String): FileEntry?
open fun stat(fileUrl: String): FileEntry?
abstract fun truncate(dirUrl: String): Unit
open fun upload(fileUrl: String, source: File): Unit
abstract fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
open fun uploadTo(dirUrl: String, source: File): Unit

open class FileTransferException : CommonException

FileTransferException(message: String, cause: Throwable)
FileTransferException(message: String)

class FileTransferFactory

FileTransferFactory(common: CommonExtension)
fun <T> http(options: HttpFileTransfer.() -> T): T
fun <T> sftp(options: SftpFileTransfer.() -> T): T
fun <T> smb(options: SmbFileTransfer.() -> T): T

interface FileTransferHandler : FileTransfer

abstract val enabled: Boolean
abstract val name: String
abstract val parallelable: Boolean

class FileTransferManager : FileTransfer

FileTransferManager(common: CommonExtension)
val credentials: Pair<String, String>
fun credentials(user: String?, password: String?, domain: String? = null): Unit
val credentialsString: String
fun custom(name: String, definition: CustomFileTransfer.() -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
var domain: String?
fun download(fileUrl: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, fileUrl: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, target: File): Unit
val factory: FileTransferFactory
fun handles(fileUrl: String): Boolean
fun handling(fileUrl: String): FileTransferHandler
val http: HttpFileTransfer
fun http(options: HttpFileTransfer.() -> Unit): Unit
fun list(dirUrl: String): List<FileEntry>
const val NAME: String
fun named(name: String): FileTransfer
var password: String?
val path: PathFileTransfer
fun path(options: PathFileTransfer.() -> Unit): Unit
val resolve: ResolveFileTransfer
fun resolve(options: ResolveFileTransfer.() -> Unit): Unit
val sftp: SftpFileTransfer
fun sftp(options: SftpFileTransfer.() -> Unit): Unit
val smb: SmbFileTransfer
fun smb(options: SmbFileTransfer.() -> Unit): Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
const val TMP_SUFFIX: String
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, fileUrl: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, source: File): Unit
val url: UrlFileTransfer
fun url(options: UrlFileTransfer.() -> Unit): Unit
var user: String?

class FileUploader

FileUploader(common: CommonExtension)
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File): Unit
const val TRANSFER_CHUNK_100_KB: Int
fun upload(file: File, output: OutputStream, cleanup: (File) -> Unit = {}): Unit

abstract class ProtocolFileTransfer : AbstractFileTransfer

ProtocolFileTransfer(common: CommonExtension)
open fun handles(fileUrl: String): Boolean
abstract val protocols: List<String>

package com.cognifide.gradle.common.file.transfer.generic

class CustomFileTransfer : ProtocolFileTransfer

CustomFileTransfer(common: CommonExtension)
fun delete(callback: (dirUrl: String, fileName: String) -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun download(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun exists(callback: (dirUrl: String, fileName: String) -> Boolean): Unit
fun exists(dirUrl: String, fileName: String): Boolean
fun list(callback: (dirUrl: String) -> List<FileEntry>): Unit
fun list(dirUrl: String): List<FileEntry>
lateinit var name: String
var parallelable: Boolean
lateinit var protocols: List<String>
fun truncate(callback: (dirUrl: String) -> Unit): Unit
fun truncate(dirUrl: String): Unit
fun upload(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class PathFileTransfer : AbstractFileTransfer

PathFileTransfer(common: CommonExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class UrlFileTransfer : ProtocolFileTransfer

UrlFileTransfer(common: CommonExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
const val PROTOCOL: String
val protocols: List<String>

package com.cognifide.gradle.common.file.transfer.http

class HttpFileException : FileException

HttpFileException(message: String, cause: Throwable)
HttpFileException(message: String)

class HttpFileTransfer : ProtocolFileTransfer

HttpFileTransfer(common: CommonExtension, client: HttpClient = client(common))
fun client(configurer: HttpClient.() -> Unit): Unit
var client: HttpClient
fun client(common: CommonExtension): HttpClient
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
val protocols: List<String>

package com.cognifide.gradle.common.file.transfer.resolve

class ResolveFileException : FileException

ResolveFileException(message: String, cause: Throwable)
ResolveFileException(message: String)

class ResolveFileTransfer : ProtocolFileTransfer

ResolveFileTransfer(aem: CommonExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
val name: String
const val NAME: String
val parallelable: Boolean
val protocols: List<String>
fun resolve(value: Any): File

package com.cognifide.gradle.common.file.transfer.sftp

class SftpFileException : FileException

SftpFileException(message: String, cause: Throwable)
SftpFileException(message: String)

class SftpFileTransfer : ProtocolFileTransfer

SftpFileTransfer(common: CommonExtension)
fun client(options: SshClient.() -> Unit): Unit
var clientOptions: SshClient.() -> Unit
fun <T> connect(url: String, callback: SftpClient.(String) -> T): T
fun <T> connectDir(dirUrl: String, callback: SftpClient.(String) -> T): T
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
const val PORT_DEFAULT: Int
val protocols: List<String>
fun session(options: ClientSession.() -> Unit): Unit
var sessionOptions: ClientSession.() -> Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
val STATUS_NOT_EXISTS: Array<Int>
var timeout: Long
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

package com.cognifide.gradle.common.file.transfer.smb

class SmbFileException : FileException

SmbFileException(message: String, cause: Throwable)
SmbFileException(message: String)

class SmbFileTransfer : ProtocolFileTransfer

SmbFileTransfer(common: CommonExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun dir(dirUrl: String): SmbFile
var domain: String?
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun file(dirUrl: String, fileName: String): SmbFile
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
val protocols: List<String>
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

package com.cognifide.gradle.common.file.watcher

class DelegatingFileAlterationListener : FileAlterationListener

DelegatingFileAlterationListener(notify: (Event) -> Unit)
fun onDirectoryChange(directory: File?): Unit
fun onDirectoryCreate(directory: File): Unit
fun onDirectoryDelete(directory: File): Unit
fun onFileChange(file: File): Unit
fun onFileCreate(file: File): Unit
fun onFileDelete(file: File): Unit
fun onStart(observer: FileAlterationObserver?): Unit
fun onStop(observer: FileAlterationObserver?): Unit

class Event

Event(file: File, type: EventType)
val file: File
fun toString(): String
val type: EventType

enum class EventType

DIR_CREATED
DIR_DELETED
FILE_CHANGED
FILE_CREATED
FILE_DELETED

package com.cognifide.gradle.common.http

open class HttpClient

HttpClient(common: CommonExtension)
fun asHtml(response: HttpResponse): Document
fun asHtml(htmlString: String): Document
fun asJson(response: HttpResponse): DocumentContext
fun asJson(jsonString: String): DocumentContext
fun <reified T : Any> asObjectFromJson(response: HttpResponse): T
fun <T> asObjectFromJson(response: HttpResponse, clazz: Class<T>): T
fun asStream(response: HttpResponse): InputStream
fun asString(response: HttpResponse): String
var authorizationPreemptive: Boolean
var baseUrl: String
open fun baseUrl(uri: String): String
var basicCredentials: Pair<String?, String?>
var basicPassword: String?
var basicUser: String?
fun checkHtml(response: HttpResponse, validator: Document.() -> Boolean): Unit
fun checkStatus(response: HttpResponse, statusCodes: IntRange = STATUS_CODE_VALID): Unit
fun checkStatus(response: HttpResponse, statusCode: Int): Unit
fun checkStatus(response: HttpResponse, statusCodes: List<Int>): Unit
fun checkText(response: HttpResponse, containedText: String, ignoreCase: Boolean = true): Unit
val client: CloseableHttpClient!
var clientBuilder: HttpClientBuilder.() -> Unit
var connectionIgnoreSsl: Boolean
var connectionRetries: Boolean
var connectionTimeout: Int
open fun createEntityMultipart(params: Map<String, Any?>): HttpEntity
open fun createEntityUrlencoded(params: Map<String, Any?>): HttpEntity
fun delete(uri: String): Unit
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpDelete.() -> Unit): T
open fun <T> execute(method: HttpRequestBase, handler: HttpClient.(HttpResponse) -> T): T
fun execute(method: HttpRequestBase): Unit
fun <T> fileTransfer(operation: HttpFileTransfer.() -> T): T
fun get(uri: String): Unit
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpGet.() -> Unit): T
fun head(uri: String): Unit
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpHead.() -> Unit): T
fun patch(path: String): Unit
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPatch.() -> Unit): T
fun post(url: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> post(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPost.() -> Unit): T
fun postMultipart(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postMultipart(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun postUrlencoded(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postUrlencoded(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
var proxyHost: String?
var proxyPort: Int?
var proxyScheme: String?
fun put(uri: String): Unit
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPut.() -> Unit): T
fun <T> request(method: String, uri: String, handler: HttpClient.(HttpResponse) -> T): T
var requestConfigurer: HttpRequestBase.() -> Unit
var responseChecker: (HttpResponse) -> Unit
var responseChecks: Boolean
var responseHandler: (HttpResponse) -> Unit
val STATUS_CODE_VALID: IntRange
open fun throwStatusException(response: HttpResponse): Unit

open class HttpException : CommonException

HttpException(message: String, cause: Throwable)
HttpException(message: String)

class PreemptiveAuthInterceptor : HttpRequestInterceptor

PreemptiveAuthInterceptor()
fun process(request: HttpRequest, context: HttpContext): Unit

class RequestException : HttpException

RequestException(message: String, cause: Throwable)
RequestException(message: String)

class ResponseException : HttpException

ResponseException(message: String, cause: Throwable)
ResponseException(message: String)

package com.cognifide.gradle.common.notifier

class DorkboxNotifier : Notifier

DorkboxNotifier(facade: NotifierFacade, configurer: Notify.() -> Unit)
val configurer: Notify.() -> Unit
val DORKBOX_DARK_LIGHT_THEME: Theme
const val DORKBOX_HIDE_AFTER_SECONDS: Long
val facade: NotifierFacade
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit): Unit

interface Notifier

abstract fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit

class NotifierFacade

val common: CommonExtension
var config: NotifierFacade.() -> Notifier
fun custom(notifier: (title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit) -> Unit): Notifier
fun dorkbox(configurer: Notify.() -> Unit = {}): Notifier
var enabled: Boolean
fun error(title: String, text: String): Unit
var image: File
fun info(title: String, text: String): Unit
fun lifecycle(title: String, text: String): Unit
fun log(title: String): Unit
fun log(title: String, message: String): Unit
fun log(title: String, message: String, level: LogLevel): Unit
fun notify(title: String): Unit
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit
fun notify(title: String, text: String): Unit
fun of(common: CommonExtension): NotifierFacade
fun warn(title: String, text: String): Unit

package com.cognifide.gradle.common.tasks

open class JarTask : Jar, CommonTask

JarTask()
val common: CommonExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

class TaskFacade : Serializable

TaskFacade(project: Project)
val checks: List<Task>
fun composeException(taskName: String, type: Class<*>? = null, cause: Exception? = null, project: Project = this.project): CommonException
fun define(name: String, configurer: CommonDefaultTask.() -> Unit = {}): TaskProvider<CommonDefaultTask>
fun <reified T : Task> get(path: String): T
fun <reified T : Task> getAll(): List<T>
@Synchronized fun <T : Task> getAllSafely(type: Class<T>): List<T>
@Synchronized fun getSafely(path: String): Task?
inline fun <reified T : Task> named(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <reified T : Task> pathed(path: String): TaskProvider<T>
fun pathed(paths: Collection<Any>): List<TaskProvider<out Task>>
val project: Project
inline fun <reified T : Task> register(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun registerSequence(name: String, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun registerSequence(name: String, taskOptions: Task.() -> Unit, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
val tests: List<Test>
inline fun <reified T : Task> typed(noinline configurer: T.() -> Unit): Unit

class TaskSequence

TaskSequence()
var afterTasks: Collection<Any>
var dependentTasks: Collection<Any>
fun dependsOn(vararg tasks: Any): Unit
fun dependsOn(tasks: Collection<Any>): Unit
fun dependsOrdered(vararg tasks: Any): Unit
fun mustRunAfter(vararg tasks: Any): Unit
fun mustRunAfter(tasks: Collection<Any>): Unit

open class ZipTask : Zip, CommonTask

ZipTask()
val common: CommonExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

package com.cognifide.gradle.common.tasks.runtime

open class Await : RuntimeDefaultTask

Await()
const val NAME: String

open class Destroy : RuntimeDefaultTask

Destroy()
const val NAME: String

open class Down : RuntimeDefaultTask

Down()
const val NAME: String

open class Resetup : RuntimeDefaultTask

Resetup()
const val NAME: String

open class Resolve : RuntimeDefaultTask

Resolve()
const val NAME: String

open class Restart : RuntimeDefaultTask

Restart()
const val NAME: String

open class Setup : RuntimeDefaultTask

Setup()
const val NAME: String

open class Up : RuntimeDefaultTask

Up()
const val NAME: String

package com.cognifide.gradle.common.utils

object Formats

fun asHtml(value: String): Document!
fun asHtml(input: InputStream): Document!
fun asJson(input: InputStream): DocumentContext!
fun asJson(value: String): DocumentContext!
fun asVersion(value: String, partsTaken: Int = 3): GradleVersion
fun date(date: Date = Date()): String
fun dateFileName(date: Date = Date()): String
fun duration(millis: Long): String
fun durationFit(thenMillis: Long, thenZoneId: ZoneId, durationMillis: Long): Boolean
fun durationSince(millis: Long): String
fun fileSize(file: File): String
fun fileSizeBytesToHuman(bytes: Long): String
fun <reified T : Any> fromJson(json: String): T
fun <T> fromJson(input: InputStream, clazz: Class<T>): T
fun <T> fromJson(json: String, clazz: Class<T>): T
fun fromJsonToMap(json: String): Map<String, Any?>
fun normalizePath(path: String): String
fun percent(current: Int, total: Int): String
fun percent(current: Long, total: Long): String
fun percentExplained(current: Int, total: Int): String
fun percentExplained(current: Long, total: Long): String
fun projectPath(file: File, project: Project): String
fun projectPath(path: String, project: Project): String
fun relativePath(path: String, basePath: String): String
fun rootProjectPath(file: File, project: Project): String
fun rootProjectPath(path: String, project: Project): String
fun toBase64(value: String): String
fun toJson(value: Any, pretty: Boolean = true): String
fun toJson(value: Map<String, Any?>, pretty: Boolean = true): String
fun toList(value: String?, delimiter: String = ","): List<String>?
fun toMap(value: String?, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
fun toMd5(text: String): String
fun toPassword(value: String): String
fun versionAtLeast(actual: String, required: String): Boolean
fun versionUnknown(): GradleVersion!

kotlin.collections.Iterable

fun <T> Iterable<T>.onEachApply(block: T.() -> Unit): Iterable<T>

object Patterns

const val WILDCARD: String
fun wildcard(file: File, matcher: String): Boolean
fun wildcard(file: File, matchers: Iterable<String>): Boolean
fun wildcard(path: String, matcher: String): Boolean
fun wildcard(path: String, matchers: Iterable<String>): Boolean
const val WILDCARD_NEGATION: String
const val WILDCARD_SEPARATOR: String

fun <T> T.using(block: T.() -> Unit): Unit
object Utils

fun mapOfNonNullValues(vararg entries: Pair<String, String?>): Map<String, String>
fun unroll(value: Any?, callback: (Any?) -> Unit): Unit

package com.cognifide.gradle.common.utils.formats

class JsonPassword : JsonSerializer<String>

JsonPassword()
fun serialize(value: String?, generator: JsonGenerator, serializers: SerializerProvider): Unit