| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
| Type | Name and description |
|---|---|
java.util.Map<java.nio.file.Path, java.util.Map<java.lang.String, java.lang.Object>> |
defaults |
java.io.File |
defaultsDirThe directory holding the defaults, normally src/main/defaults. |
java.lang.String |
defaultsFileExtensionThe file extension that identifies default templates. |
java.io.File |
outputDirThe output directory to generate into. |
boolean |
prependControls whether the target-specific properties are prepended to the defaults or vice versa. |
boolean |
sortThe generated properties will be sorted alphabetically if this field is set to true. |
boolean |
structuredIndicates that the generated properties are structured, if set to true. |
java.io.File |
templatesDirThe directory holding the templates, normally or src/main/templates. |
boolean |
trim |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
apply() |
|
void |
applyWithDefaults() |
|
void |
applyWithDefaults(Map.Entry<java.nio.file.Path, java.util.Map<java.lang.String, java.lang.Object>> entry) |
|
void |
applyWithoutDefaults() |
|
org.gradle.api.Task |
configure(groovy.lang.Closure closure) |
|
void |
configureDefaults() |
|
java.util.List<java.io.File> |
findDefaults()Finds every file in the defaults source set with the defaults extension. |
|
java.util.List<java.io.File> |
generateProperties(java.nio.file.Path defaultsPath, java.util.Map defaults) |
|
java.io.File |
generateProperties(java.util.List<java.lang.String> defaults, java.io.File file, java.io.File resolvedOutputDir) |
|
java.lang.String |
generateProperties(java.util.List<java.lang.String> defaults, java.util.List<java.lang.String> properties) |
|
static java.io.File |
getDefaultDefaultsDir(org.gradle.api.Project project) |
|
static java.io.File |
getDefaultOutputDir(org.gradle.api.Project project) |
|
static java.io.File |
getDefaultTemplatesDir(org.gradle.api.Project project) |
|
java.lang.String |
getPropertiesBasename(java.io.File defaultsFile)Strips the .defaults.vtl suffix from the defaults filename to
produce the basename of the properties file the defaults are for. |
|
java.util.Map<java.nio.file.Path, java.util.Map<java.lang.String, java.lang.Object>> |
readDefaults()Collects the available defaults into a map keyed on the property filenames. |
|
java.util.Map<java.lang.String, java.lang.Object> |
readDefaults(java.io.File defaultsFile) |
|
java.nio.file.Path |
relativizeDefaults(java.io.File defaultsFile) |
|
void |
throwIfNotStructured(java.util.List<java.util.Properties> properties) |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#replaceLogger(org.gradle.api.logging.Logger), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#getRequiredServices(), org.gradle.api.DefaultTask#getSharedResources(), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
The directory holding the defaults, normally src/main/defaults.
The file extension that identifies default templates.
The output directory to generate into.
Controls whether the target-specific properties are prepended to the defaults or vice versa. The default is to append, which means the defaults appear first.
The generated properties will be sorted alphabetically if this field is set to true. The default is false, which leaves the properties in the order defined in the source files.
Indicates that the generated properties are structured, if set to true. This means that every result must define the same properties, or in other words, that if one result defines a particular property then every other result must also define a value for that property. Defaults to false. If the value is false then the generated properties are semi-structured, which means that individual results may include properties that some of the other results don't have.
The directory holding the templates, normally
or src/main/templates.
Finds every file in the defaults source set with the defaults extension.
Strips the .defaults.vtl suffix from the defaults filename to
produce the basename of the properties file the defaults are for.
defaultsFile - The defaults file to derive a basename fromCollects the available defaults into a map keyed on the property filenames. The values are string lists holding the lines of the defaults files.