Package com.diffplug.blowdryer

Class BlowdryerSetup

java.lang.Object

com.diffplug.blowdryer.BlowdryerSetup

public class BlowdryerSetup
extends java.lang.Object

Configures where Blowdryer.file(String) downloads files from.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BlowdryerSetup.Bitbucket
static class	BlowdryerSetup.BitbucketType
static class	BlowdryerSetup.GitAnchorType
class	BlowdryerSetup.GitHub
class	BlowdryerSetup.GitLab
static class	BlowdryerSetup.PluginsBlock

Constructor Summary

Constructors

Constructor	Description
BlowdryerSetup(java.io.File rootDir)	Pass in the directory that will be used to resolve string arguments to devLocal.

Method Summary

Modifier and Type	Method	Description
BlowdryerSetup.Bitbucket	bitbucket(java.lang.String repoOrg, BlowdryerSetup.GitAnchorType anchorType, java.lang.String anchor)	Sets the source where we will grab these scripts.
void	classpathJar(java.lang.String name)	Finds a jar already on the classpath (e.g.
void	devLocal(java.lang.Object devPath)	Sets the source to be the given local folder, usually for developing changes before they are pushed to git.
void	experimental(groovy.lang.Closure<java.lang.String> function)	Sets the mapping from `file(String)` to `immutableUrl(String)`.
void	experimental(java.util.function.Function<java.lang.String,java.lang.String> function)	Sets the mapping from `file(String)` to `immutableUrl(String)`.
BlowdryerSetup.GitHub	github(java.lang.String repoOrg, BlowdryerSetup.GitAnchorType anchorType, java.lang.String anchor)	Sets the source where we will grab these scripts.
BlowdryerSetup.GitLab	gitlab(java.lang.String repoOrg, BlowdryerSetup.GitAnchorType anchorType, java.lang.String anchor)	Sets the source where we will grab these scripts.
void	localJar(java.io.File jarFile)	Uses the provided jarFile to extract a file resource.
void	repoSubfolder(java.lang.String repoSubfolder)	Default value is `src/main/resources`.
void	setPluginsBlockTo(Action<BlowdryerSetup.PluginsBlock> versionSetter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlowdryerSetup

public BlowdryerSetup(java.io.File rootDir)

Pass in the directory that will be used to resolve string arguments to devLocal.

Method Detail

repoSubfolder

public void repoSubfolder(java.lang.String repoSubfolder)

Default value is `src/main/resources`. If you change, you must change as the *first* call. The nice thing about the default `src/main/resources` is that if you ever want to, you could copy the blowdryer code into your blowdryer repo, and deploy your own plugin that pulls resources from the local jar rather than from github. Keeping the default lets you switch to that approach in the future without moving your scripts.

github

public BlowdryerSetup.GitHub github(java.lang.String repoOrg,
                                    BlowdryerSetup.GitAnchorType anchorType,
                                    java.lang.String anchor)

Sets the source where we will grab these scripts.

gitlab

public BlowdryerSetup.GitLab gitlab(java.lang.String repoOrg,
                                    BlowdryerSetup.GitAnchorType anchorType,
                                    java.lang.String anchor)

Sets the source where we will grab these scripts.

bitbucket

public BlowdryerSetup.Bitbucket bitbucket(java.lang.String repoOrg,
                                          BlowdryerSetup.GitAnchorType anchorType,
                                          java.lang.String anchor)

Sets the source where we will grab these scripts.

localJar

public void localJar(java.io.File jarFile)

Uses the provided jarFile to extract a file resource.

Parameters:

jarFile - Absolute path to JAR on the file system.

classpathJar

public void classpathJar(java.lang.String name)

Finds a jar already on the classpath (e.g. one declared in the `plugins` block of `settings.gradle`) whose filename contains name, and uses it to extract a file resource, same as localJar(File).

Parameters:

name - Substring to match against the filename of a jar on the classpath.

experimental

public void experimental(groovy.lang.Closure<java.lang.String> function)

Sets the mapping from `file(String)` to `immutableUrl(String)`.

experimental

public void experimental(java.util.function.Function<java.lang.String,java.lang.String> function)

Sets the mapping from `file(String)` to `immutableUrl(String)`.

devLocal

public void devLocal(java.lang.Object devPath)

Sets the source to be the given local folder, usually for developing changes before they are pushed to git.

setPluginsBlockTo

public void setPluginsBlockTo(Action<BlowdryerSetup.PluginsBlock> versionSetter)
                       throws java.io.IOException

Throws:

java.io.IOException