org.gradle.api.Incubating Java Examples

/**
 * Returns all init scripts, including explicit init scripts and implicit init scripts.
 *
 * @return All init scripts, including explicit init scripts and implicit init scripts.
 */
@Incubating
public List<File> getAllInitScripts() {
    CompositeInitScriptFinder initScriptFinder = new CompositeInitScriptFinder(
            new UserHomeInitScriptFinder(getGradleUserHomeDir()), new DistributionInitScriptFinder(gradleHomeDir)
    );

    List<File> scripts = new ArrayList<File>(getInitScripts());
    initScriptFinder.findScripts(scripts);
    return Collections.unmodifiableList(scripts);
}
 

@Incubating
/**
 * Configure the java compilation to be incremental (e.g. compiles only those java classes that were changed or that are dependencies to the changed classes).
 * The feature is incubating and does not yet satisfies all compilation scenarios.
 */
public CompileOptions setIncremental(boolean incremental) {
    SingleMessageLogger.incubatingFeatureUsed("Incremental java compilation");
    this.incremental = incremental;
    return this;
}
 

@Incubating
public void setConfigureOnDemand(boolean configureOnDemand) {
    this.configureOnDemand = configureOnDemand;
}
 

@Incubating
ArtifactResolutionQuery createArtifactResolutionQuery();
 

/**
 * Returns the list of acceptable source file extensions. Only takes effect when compiling against
 * Groovy 1.7 or higher. Defaults to {@code ImmutableList.of("java", "groovy")}.
 */
@Input
@Incubating
public List<String> getFileExtensions() {
    return fileExtensions;
}
 

/**
 * Sets the list of acceptable source file extensions. Only takes effect when compiling against
 * Groovy 1.7 or higher. Defaults to {@code ImmutableList.of("java", "groovy")}.
 */
@Incubating
public void setFileExtensions(List<String> fileExtensions) {
    this.fileExtensions = fileExtensions;
}
 

/**
 * Sets the tool chain to use to generate the Javadoc.
 */
@Incubating
public void setToolChain(JavaToolChain toolChain) {
    // Implementation is generated
    throw new UnsupportedOperationException();
}
 

/**
 * Returns the tool chain that will be used to generate the Javadoc.
 */
@Incubating @Inject
public JavaToolChain getToolChain() {
    // Implementation is generated
    throw new UnsupportedOperationException();
}
 

/**
 * Sets the tool chain that should be used to compile the Java source.
 *
 * @param toolChain The tool chain.
 */
@Incubating
public void setToolChain(JavaToolChain toolChain) {
    // Implementation is generated
    throw new UnsupportedOperationException();
}
 

/**
 * Returns the tool chain that will be used to compile the Java source.
 *
 * @return The tool chain.
 */
@Incubating @Inject
public JavaToolChain getToolChain() {
    // Implementation is generated
    throw new UnsupportedOperationException();
}
 

/**
 * informs whether to use experimental incremental compilation feature. See {@link #setIncremental(boolean)}
 */
@Incubating
public boolean isIncremental() {
    return incremental;
}
 

@Incubating
public void setConfigureOnDemand(boolean configureOnDemand) {
    this.configureOnDemand = configureOnDemand;
}
 

/**
 * informs whether to use experimental incremental compilation feature. See {@link #setIncremental(boolean)}
 */
@Incubating
public boolean isIncremental() {
    return incremental;
}
 

@Incubating
DomainObjectSet<? extends TaskSelector> getTaskSelectors();
 

/**
 * Returns the list of acceptable source file extensions. Only takes effect when compiling against
 * Groovy 1.7 or higher. Defaults to {@code ImmutableList.of("java", "groovy")}.
 */
@Input
@Incubating
public List<String> getFileExtensions() {
    return fileExtensions;
}
 

/**
 * Sets the list of acceptable source file extensions. Only takes effect when compiling against
 * Groovy 1.7 or higher. Defaults to {@code ImmutableList.of("java", "groovy")}.
 */
@Incubating
public void setFileExtensions(List<String> fileExtensions) {
    this.fileExtensions = fileExtensions;
}
 

/**
 * If the configure-on-demand mode is active
 */
@Incubating
public boolean isConfigureOnDemand() {
    return configureOnDemand;
}
 

/**
 * Returns the root folder for the test results in internal binary format.
 *
 * @return the test result directory, containing the test results in binary format.
 */
@OutputDirectory
@Incubating
public File getBinResultsDir() {
    return binResultsDir;
}
 

@Incubating
DomainObjectSet<? extends TaskSelector> getTaskSelectors();
 

@Incubating
DomainObjectSet<? extends Task> getTasks();
 

/**
 * Returns the root folder for the test results in internal binary format.
 *
 * @return the test result directory, containing the test results in binary format.
 */
@OutputDirectory
@Incubating
public File getBinResultsDir() {
    return binResultsDir;
}
 

@Incubating
DomainObjectSet<? extends Task> getTasks();
 

/**
 * A Groovy script file that configures the compiler, allowing extensive control over how the code is compiled.
 * <p>
 * The script is executed as Groovy code, with the following context:
 * <ul>
 * <li>The instance of <a href="http://docs.groovy-lang.org/latest/html/gapi/org/codehaus/groovy/control/CompilerConfiguration.html">CompilerConfiguration</a> available as the {@code configuration} variable.</li>
 * <li>All static members of <a href="http://docs.groovy-lang.org/latest/html/gapi/org/codehaus/groovy/control/customizers/builder/CompilerCustomizationBuilder.html">CompilerCustomizationBuilder</a> pre imported.</li>
 * </ul>
 * </p>
 * <p>
 * This facilitates the following pattern:
 * <pre>
 * withConfig(configuration) {
 *   // use compiler configuration DSL here
 * }
 * </pre>
 * </p>
 * <p>
 * For example, to activate type checking for all Groovy classes…
 * <pre>
 * import groovy.transform.TypeChecked
 *
 * withConfig(configuration) {
 *     ast(TypeChecked)
 * }
 * </pre>
 * </p>
 * <p>
 * Please see <a href="http://groovy.codehaus.org/Advanced+compiler+configuration#Advancedcompilerconfiguration-Thecustomizationbuilder">the Groovy compiler customization builder documentation</a>
 * for more information about the compiler configuration DSL.
 * </p>
 * <p>
 * <b>This feature is only available if compiling with Groovy 2.1 or later.</b>
 * </p>
 * @see <a href="http://docs.groovy-lang.org/latest/html/gapi/org/codehaus/groovy/control/CompilerConfiguration.html">CompilerConfiguration</a>
 * @see <a href="http://docs.groovy-lang.org/latest/html/gapi/org/codehaus/groovy/control/customizers/builder/CompilerCustomizationBuilder.html">CompilerCustomizationBuilder</a>
 */
@InputFile
@Incubating
@Optional
public File getConfigurationScript() {
    return configurationScript;
}
 

/**
 * Sets the test name patterns to be included in execution.
 * Classes or method names are supported, wildcard '*' is supported.
 * For more information see the user guide chapter on testing.
 *
 * For more information on supported patterns see {@link TestFilter}
 */
@Option(option = "tests", description = "Sets test class or method name to be included, '*' is supported.")
@Incubating
public Test setTestNameIncludePattern(String testNamePattern) {
    filter.setIncludePatterns(testNamePattern);
    return this;
}
 

/**
 * Sets the root folder for the test results in internal binary format.
 *
 * @param binResultsDir The root folder
 */
@Incubating
public void setBinResultsDir(File binResultsDir) {
    this.binResultsDir = binResultsDir;
}
 

/**
 * The strategy to use when trying to copy more than one file to the same destination. Set to {@code null} to use the default strategy, which is inherited
 * from the parent copy spec, if any, or {@link DuplicatesStrategy#INCLUDE} if this copy spec has no parent.
 */
@Incubating
void setDuplicatesStrategy(@Nullable DuplicatesStrategy strategy);
 

/**
 * Returns the strategy to use when trying to copy more than one file to the same destination.
 * <p>
 * The value can be set with a case insensitive string of the enum value (e.g. {@code 'exclude'} for {@link DuplicatesStrategy#EXCLUDE}).
 * <p>
 * This strategy can be overridden for individual files by using {@link #eachFile(org.gradle.api.Action)} or {@link #filesMatching(String, org.gradle.api.Action)}.
 *
 * @return the strategy to use for files included by this copy spec.
 * @see DuplicatesStrategy
 */
@Incubating
DuplicatesStrategy getDuplicatesStrategy();
 

/**
 * Allows filtering tests for execution.
 *
 * @return filter object
 * @since 1.10
 */
@Incubating
@Nested
public TestFilter getFilter() {
    return filter;
}
 

/**
 * Executes the action against the {@link #getFilter()}.
 *
 * @param action configuration of the test filter
 * @since 1.10
 */
@Incubating
public void filter(Action<TestFilter> action) {
    action.execute(filter);
}
 

/**
 * Sets the launchables to execute. If no entries are specified, the project's default tasks are executed.
 *
 * @param launchables The launchables for this build.
 * @return this
 * @since 1.12
 */
@Incubating
BuildLauncher forLaunchables(Launchable... launchables);