Java 类org.gradle.api.Incubating 实例源码

/**
 * A filter specifying which bugs are reported. Replaces the {@code includeFilter} property.
 *
 * @since 2.2
 */
@Incubating
@Nested
@Optional
public TextResource getIncludeFilterConfig() {
    return includeFilterConfig;
}

/**
 * The character set used to encode ZIP metadata like file names.
 * Defaults to the platform's default character set.
 *
 * @param metadataCharset the character set used to encode ZIP metadata like file names
 * @since 2.14
 */
@Incubating
public void setMetadataCharset(String metadataCharset) {
    if (metadataCharset == null) {
        throw new InvalidUserDataException("metadataCharset must not be null");
    }
    if (!Charset.isSupported(metadataCharset)) {
        throw new InvalidUserDataException(String.format("Charset for metadataCharset '%s' is not supported by your JVM", metadataCharset));
    }
    this.metadataCharset = metadataCharset;
}

@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;
}

/**
 * Specifies the maximum number of concurrent workers used for underlying build operations.
 *
 * @throws IllegalArgumentException if {@code maxWorkerCount} is < 1
 * @see #getMaxWorkerCount()
 */
@Incubating
public void setMaxWorkerCount(int maxWorkerCount) {
    if (maxWorkerCount < 1) {
        throw new IllegalArgumentException("Max worker count must be > 0");
    } else {
        this.maxWorkerCount = maxWorkerCount;
    }
}

@Incubating
@OutputFiles
Map<String, File> getEnabledFileReportDestinations();

@Incubating
ComponentArtifactIdentifier getId();

/**
 * Specifies the rule priority threshold.
 *
 * @see PmdExtension#rulePriority
 */
@Input
@Incubating
public int getRulePriority() {
    return rulePriority;
}

/**
 * Whether or not to write PMD results to {@code System.out}.
 */
@Input
@Incubating
public boolean isConsoleOutput() {
    return consoleOutput;
}

@Incubating
public List<File> getIncludedBuilds() {
    return Collections.unmodifiableList(includedBuilds);
}

/**
 * The Windows start script generator.
 * <p>
 * Defaults to an implementation of {@link org.gradle.jvm.application.scripts.TemplateBasedScriptGenerator}.
 */
@Incubating
@Internal
public ScriptGenerator getWindowsStartScriptGenerator() {
    return windowsStartScriptGenerator;
}

@Incubating
public void setIncludeFilterConfig(TextResource includeFilterConfig) {
    this.includeFilterConfig = includeFilterConfig;
}

@Incubating
public boolean isContinuous() {
    return continuous;
}

@Incubating
public void setExcludeBugsFilterConfig(TextResource excludeBugsFilterConfig) {
    this.excludeBugsFilterConfig = excludeBugsFilterConfig;
}

@Incubating
void setCanBeConsumed(boolean allowed);

/**
 * The CodeNarc configuration to use. Replaces the {@code configFile} property.
 *
 * @since 2.2
 */
@Incubating
@Nested
public TextResource getConfig() {
    return config;
}

@Incubating
public void setIncludeCategories(Set<String> includeCategories) {
    this.includeCategories = includeCategories;
}

@Incubating
public void setScalaPlatform(ScalaPlatform scalaPlatform) {
    this.scalaPlatform = scalaPlatform;
}

/**
 * Whether or not to write PMD results to {@code System.out}.
 */
@Incubating
public boolean isConsoleOutput() {
    return consoleOutput;
}

@Override
@Incubating
public ConsoleOutput getConsoleOutput() {
    return consoleOutput;
}

/**
 * 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;
}

/**
 * The vcs used by the project.
 */
@Incubating
public String getVcs() {
    return vcs;
}

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

/**
 * The Scala version used by this module.
 */
@Incubating
public ScalaPlatform getScalaPlatform() {
    return scalaPlatform;
}

@Incubating
public void setLanguageLevel(IdeaLanguageLevel languageLevel) {
    this.languageLevel = languageLevel;
}

/**
 * Specifies the Gradle user home for the builder. If not set, an empty directory under the project directory
 * will be used.
 * @return The builder
 */
@Incubating
public ProjectBuilder withGradleUserHomeDir(File dir) {
    gradleUserHomeDir = dir;
    return this;
}

@Incubating
void setConfiguredCredentials(Credentials credentials);

/**
 * The project-level libraries of the IDEA project.
 */
@Incubating
public Set<ProjectLibrary> getProjectLibraries() {
    return projectLibraries;
}

@Incubating
public void setVcs(String vcs) {
    this.vcs = vcs;
}

@Incubating
public void setContinuous(boolean enabled) {
    this.continuous = enabled;
}

/**
 * The project-level libraries to be added to the IDEA project.
 */
@Incubating
public Set<ProjectLibrary> getProjectLibraries() {
    return projectLibraries;
}

/**
 * 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 generate the Javadoc.
 */
@Incubating @Inject
public JavaToolChain getToolChain() {
    // Implementation is generated
    throw new UnsupportedOperationException();
}

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

@Incubating
public void setOutputDirectory(File outputDirectory) {
    this.outputDirectory = outputDirectory;
}

@Incubating
public void setPreserveOrder(boolean preserveOrder) {
    this.preserveOrder = preserveOrder;
}

/**
 * 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://docs.groovy-lang.org/latest/html/documentation/#compilation-customizers">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;
}

/**
 * The module specific language Level to use for this module.
 * When {@code null}, the module will inherit the language level from the idea project.
 * <p>
 * The Idea module language level is based on the {@code sourceCompatibility} settings for the associated Gradle project.
 */
@Incubating
public IdeaLanguageLevel getLanguageLevel() {
    return languageLevel;
}

/**
 * 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);

/**
 * The character set used to encode the manifest content.
 * Defaults to UTF-8.
 * You can change this property but it is not recommended as JVMs expect manifests content to be encoded using UTF-8.
 *
 * @return the character set used to encode the manifest content
 * @since 2.14
 */
@Input
@Incubating
public String getManifestContentCharset() {
    return manifestContentCharset;
}

/**
 * The vcs for the project.
 * <p>
 * Values are the same as used in IDEA's “Version Control” preference window (e.g. 'Git', 'Subversion').
 * <p>
 * See the examples in the docs for {@link IdeaProject}.
 */
@Incubating
public String getVcs() {
    return vcs;
}