Groovy Documentation

Deprecated API


Interfaces
ConventionValue
      A ConventionValue can be assigned to a org.gradle.api.internal.IConventionAware task.
EclipseTask
      Deprecated because Gradle tasks are not associated with Eclipse projects.
TestLogging
      Configures logging of the test execution, e.g. whether the std err / out should be eagerly shown.

Classes
AntJavadoc
      @deprecated No replacement
CodeQualityPlugin
      A plugin which measures and enforces code quality for Java and Groovy projects.
Compile
      Compiles Java source files.
Directory
      Creates a directory.
GradleLauncher
     
RefreshOptions
      The options supplied by a user to refresh dependencies and other external resources.
ReportingBasePluginConvention
     
SigningPluginConvention
      @deprecated Use SigningExtension

Enums
CacheUsage
     

Exceptions
IllegalOperationAtExecutionTimeException
      A IllegalOperationAtExecutionTimeException is thrown if you try to trigger an operation at runtime, which is only allowed at configuration time.

Methods
AbstractCopyTask#getDefaultSource()
      Returns the default source for this task.
ArtifactRepositoryContainer#add(DependencyResolver resolver)
      Adds a repository to this container, at the end of the repository sequence.
ArtifactRepositoryContainer#add(DependencyResolver resolver, Closure configureClosure)
      Adds a repository to this container, at the end of the repository sequence.
ArtifactRepositoryContainer#addAfter(Object userDescription, String previousResolver)
      Adds a resolver to this container, after the given resolver.
ArtifactRepositoryContainer#addAfter(Object userDescription, String previousResolver, Closure configureClosure)
      Adds a resolver to this container, after the given resolver.
ArtifactRepositoryContainer#addBefore(Object userDescription, String nextResolver)
      Adds a resolver to this container, before the given resolver.
ArtifactRepositoryContainer#addBefore(Object userDescription, String nextResolver, Closure configureClosure)
      Adds a resolver to this container, before the given resolver.
ArtifactRepositoryContainer#addFirst(Object userDescription)
      Adds a resolver to this container, at the start of the resolver sequence.
ArtifactRepositoryContainer#addFirst(Object userDescription, Closure configureClosure)
      Adds a resolver to this container, at the start of the resolver sequence.
ArtifactRepositoryContainer#addLast(Object userDescription)
      Adds a repository to this container, at the end of the repository sequence.
ArtifactRepositoryContainer#addLast(Object userDescription, Closure configureClosure)
      Adds a resolver to this container, at the end of the resolver sequence.
ArtifactRepositoryContainer#getResolvers()
      Returns the resolvers in this container, in sequence.
CacheUsage#fromString(String usagestr)
     
Checkstyle#getProperties()
      The properties available for use in the configuration file.
Checkstyle#getResultFile()
      Returns the destination file for the XML report.
Checkstyle#setProperties(Map properties)
      The properties available for use in the configuration file.
Checkstyle#setResultFile(File file)
      @deprecated Use reports.xml.destination instead.
CodeNarc#getReportFile()
      The file to write the report to.
CodeNarc#getReportFormat()
      The format type of the CodeNarc report.
CodeNarc#setReportFile(File reportFile)
      @deprecated Use {@code reports.
CodeNarc#setReportFormat(String reportFormat)
      @deprecated Use {@code reports.
CompileOptions#getCompiler()
      Returns the compiler to be used.
CompileOptions#getDebug()
      Deprecated.
CompileOptions#getFailOnError()
      Deprecated.
CompileOptions#getIncludeJavaRuntime()
      Tells whether the Java runtime should be put on the compile class path.
CompileOptions#getOptimize()
      Tells whether to produce optimized byte code.
CompileOptions#isIncludeJavaRuntime()
      Tells whether the Java runtime should be put on the compile class path.
CompileOptions#isOptimize()
      Tells whether to produce optimized byte code.
CompileOptions#isUseAnt()
      Tells whether to use the Ant javac task over Gradle's own Java compiler integration.
CompileOptions#setCompiler(String compiler)
      Sets the compiler to be used.
CompileOptions#setIncludeJavaRuntime(boolean includeJavaRuntime)
      Sets whether the Java runtime should be put on the compile class path.
CompileOptions#setOptimize(boolean optimize)
      Sets whether to produce optimized byte code.
CompileOptions#setUseAnt(boolean useAnt)
      Sets whether to use the Ant javac task over Gradle's own Java compiler integration.
Compression#getExtension()
     
ConfigurationContainer#add(String name)
      Adds a configuration with the given name.
ConfigurationContainer#add(String name, Closure configureClosure)
      Adds a configuration with the given name.
ExcludeRule#getExcludeArgs()
      Returns the arguments of an exclude rule.
ExtensionContainer#add(String name, Class type, Object constructionArguments)
      Deprecated.
GradleLauncher#createStartParameter(String commandLineArgs)
      Returns a StartParameter object out of command line syntax arguments.
GradleLauncher#newInstance(StartParameter startParameter)
      Returns a GradleLauncher instance based on the passed start parameter.
GradleLauncher#newInstance(String commandLineArgs)
      Returns a GradleLauncher instance based on the passed command line syntax arguments.
GroovyCompileOptions#isIncludeJavaRuntime()
      Tells whether the Java runtime should be put on the compile class path.
GroovyCompileOptions#isStacktrace()
      Tells whether to print a stack trace when the compiler hits a problem (like a compile error).
GroovyCompileOptions#isUseAnt()
      Tells whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration.
GroovyCompileOptions#setIncludeJavaRuntime(boolean includeJavaRuntime)
      Sets whether the Java runtime should be put on the compile class path.
GroovyCompileOptions#setStacktrace(boolean stacktrace)
      Sets whether to print a stack trace when the compiler hits a problem (like a compile error).
GroovyCompileOptions#setUseAnt(boolean useAnt)
      Sets whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration.
Project#childrenDependOnMe()
     
Project#dependsOn(String path)
     
Project#dependsOn(String path, boolean evaluateDependsOnProject)
     
Project#dependsOnChildren()
     
Project#dependsOnChildren(boolean evaluateDependsOnProject)
     
Project#fileTree(Closure closure)
     
ReportingBasePluginConvention#getApiDocTitle()
      Returns the title for API documentation for the project.
ReportingBasePluginConvention#getReportsDir()
      Returns the directory containing all reports for this project.
ReportingBasePluginConvention#getReportsDirName()
      Returns the name of the reports directory, relative to the project's build directory.
ReportingBasePluginConvention#setReportsDirName(String reportsDirName)
      Sets the name of the reports directory, relative to the project's build directory.
RepositoryHandler#mavenRepo(Map args)
      Adds a repository which is Maven compatible.
RepositoryHandler#mavenRepo(Map args, Closure configClosure)
      Adds a repository which is Maven compatible.
ResolvedArtifact#getResolvedDependency()
      Returns one of the dependencies which this artifact belongs to.
ScalaCompileOptions#getTargetCompatibility()
      Returns which backend is to be used.
ScalaCompileOptions#setTargetCompatibility(String targetCompatibility)
      Sets which backend is to be used.
Script#fileTree(Closure closure)
     
SigningPluginConvention#sign(PublishArtifact publishArtifacts)
      @deprecated Use SigningExtension.sign
SigningPluginConvention#sign(File files)
      @deprecated Use SigningExtension.sign
SigningPluginConvention#sign(String classifier, File files)
      @deprecated Use SigningExtension.sign
SigningPluginConvention#sign(Closure closure)
      @deprecated Use SigningExtension#sign(Closure)#sign(Closure) }
SigningPluginConvention#signPom(MavenDeployment mavenDeployment, Closure closure = null)
      @deprecated Use SigningExtension#signPom()#signPom()
SourceSetContainer#add(String name)
      Adds a source set with the given name.
SourceSetContainer#add(String name, Closure configureClosure)
      Adds a source set with the given name.
SourceTask#getDefaultSource()
      Returns the default source for this task, if any.
StartParameter#getCacheUsage()
      Returns the configured CacheUsage.
StartParameter#getMergedSystemProperties()
      Deprecated.
StartParameter#getRefreshOptions()
      Returns the refresh options used for the build.
StartParameter#isNoOpt()
      Returns task optimization disabled flag.
StartParameter#setCacheUsage(CacheUsage cacheUsage)
      Sets the Cache usage.
StartParameter#setNoOpt(boolean noOpt)
      Get task optimization disabled.
StartParameter#setRefreshOptions(RefreshOptions refreshOptions)
      Supplies the refresh options to use for the build.
StartParameter#useEmptySettingsScript()
      Deprecated.
TaskContainer#add(Map options)
     
TaskContainer#add(Map options, Closure configureClosure)
     
TaskContainer#add(String name, Closure configureClosure)
     
TaskContainer#add(String name)
     
TaskContainer#add(String name, Class type)
     
Test#disableTestReport()
      Disables the HTML test report.
Test#enableTestReport()
      Enables the HTML test report.
Test#getTestReportDir()
      Returns the root folder for the test reports.
Test#getTestResultsDir()
      Returns the root folder for the test results in XML format.
Test#isTestReport()
      Specifies whether the test HTML report should be generated.
Test#setTestReport(boolean testReport)
      Sets whether the test HTML report should be generated.
Test#setTestReportDir(File testReportDir)
      Sets the root folder for the test reports.
Test#setTestResultsDir(File testResultsDir)
      Sets the root folder for the test results.


Gradle API 1.8