Groovy (groovy 2.4.4 API)

org.codehaus.groovy.ant.Groovy

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Methods Summary

Methods
Type	Name and description
`protected void`	`addClassPathes(GroovyClassLoader classLoader)` Adds the class paths (if any)
`void`	`addFileset(FileSet set)` Adds a set of files (nested fileset attribute).
`void`	`addText(String txt)` Set an inline command to execute.
`Commandline.Argument`	`createArg()`
`Path`	`createClasspath()` Returns a new path element that can be configured.
`protected void`	`execGroovy(String txt, PrintStream out)` Exec the statement.
`void`	`execute()` Load the file and then execute it
`Path`	`getClasspath()` Gets the classpath.
`static void`	`main(String[] args)`
`protected void`	`printResults(PrintStream out)` print any results in the statement.
`protected void`	`runStatements(Reader reader, PrintStream out)` Read in lines and execute them.
`void`	`setAppend(boolean append)` Whether output should be appended to or overwrite an existing file.
`void`	`setClasspath(Path classpath)` Sets the classpath for loading.
`void`	`setClasspathRef(Reference ref)` Set the classpath for loading using the classpath reference.
`void`	`setConfigscript(String configscript)` Sets the configuration script for the groovy compiler configuration.
`void`	`setContextClassLoader(boolean contextClassLoader)` Setting to true will cause the contextClassLoader to be set with the classLoader of the shell used to run the script.
`void`	`setFork(boolean fork)` Should the script be executed using a forked process.
`void`	`setIncludeAntRuntime(boolean includeAntRuntime)` Should the system classpath be included on the classpath when forking.
`void`	`setIndy(boolean indy)` Sets the indy flag to enable or disable invokedynamic
`void`	`setOutput(File output)` Set the output file; optional, defaults to the Ant log.
`void`	`setScriptBaseClass(String scriptBaseClass)` Set the script base class name
`void`	`setSrc(File srcFile)` Set the name of the file to be run.
`void`	`setStacktrace(boolean stacktrace)` Enable compiler to report stack trace information if a problem occurs during compilation.
`void`	`setUseGroovyShell(boolean useGroovyShell)` Should a new GroovyShell be used when forking.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Java`	setOutput, setDir, getCommandLine, setArgs, setClasspath, setAppend, setFork, setTimeout, getSysProperties, setJar, handleInput, setMaxmemory, executeJava, createPermissions, createArg, setResultProperty, setJvmargs, setJvm, setFailonerror, setInputString, setLogError, setOutputproperty, setErrorProperty, setJVMVersion, addEnv, addAssertions, addConfiguredRedirector, createJvmarg, setClassname, createClasspath, setClasspathRef, setSpawn, addSysproperty, addSyspropertyset, setCloneVm, createBootclasspath, clearArgs, setNewenvironment, execute, setError, setInput, getTaskName, setTaskName, getOwningTarget, getTaskType, setTaskType, setOwningTarget, getRuntimeConfigurableWrapper, setRuntimeConfigurableWrapper, maybeConfigure, perform, bindToOwner, reconfigure, log, log, log, log, init, setProject, setLocation, getDescription, getProject, setDescription, clone, getLocation, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
`class Task`	`getTaskName, setTaskName, getOwningTarget, getTaskType, setTaskType, setOwningTarget, getRuntimeConfigurableWrapper, setRuntimeConfigurableWrapper, maybeConfigure, perform, bindToOwner, reconfigure, execute, log, log, log, log, init, setProject, setLocation, getDescription, getProject, setDescription, clone, getLocation, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - protected void addClassPathes(GroovyClassLoader classLoader)
    
    Adds the class paths (if any)
    Parameters:
    classLoader - the classloader to configure
  - public void addFileset(FileSet set)
    
    Adds a set of files (nested fileset attribute).
    Parameters:
    set - the fileset representing source files
  - public void addText(String txt)
    
    Set an inline command to execute. NB: Properties are not expanded in this text.
    Parameters:
    txt - the inline groovy commands to execute
  - public Commandline.Argument createArg()
  - public Path createClasspath()
    
    Returns a new path element that can be configured. Gets called for instance by Ant when it encounters a nested <classpath> element.
    Returns:
    the resulting created path
  - protected void execGroovy(String txt, PrintStream out)
    
    Exec the statement.
    Parameters:
    txt - the groovy source to exec
    out - not used?
  - public void execute()
    
    Load the file and then execute it
  - public Path getClasspath()
    
    Gets the classpath.
    Returns:
    Returns a Path
  - public static void main(String[] args)
  - protected void printResults(PrintStream out)
    
    print any results in the statement.
    Parameters:
    out - the output PrintStream to print to
  - protected void runStatements(Reader reader, PrintStream out)
    
    Read in lines and execute them.
    throws:
    java.io.IOException if something goes wrong
    
    Parameters:
    reader - the reader from which to get the groovy source to exec
    out - the outputstream to use
  - public void setAppend(boolean append)
    
    Whether output should be appended to or overwrite an existing file. Defaults to false.
    Parameters:
    append - set to true to append
  - public void setClasspath(Path classpath)
    
    Sets the classpath for loading.
    Parameters:
    classpath - The classpath to set
  - public void setClasspathRef(Reference ref)
    
    Set the classpath for loading using the classpath reference.
    Parameters:
    ref - the refid to use
  - public void setConfigscript(String configscript)
    
    Sets the configuration script for the groovy compiler configuration.
    Parameters:
    configscript - path to the configuration script
  - public void setContextClassLoader(boolean contextClassLoader)
    
    Setting to true will cause the contextClassLoader to be set with the classLoader of the shell used to run the script. Not used if fork is true. Not allowed when running from Maven but in that case the context classLoader is set appropriately for Maven.
    Parameters:
    contextClassLoader - set to true to set the context classloader
  - public void setFork(boolean fork)
    
    Should the script be executed using a forked process. Defaults to false.
    Parameters:
    fork - true if the script should be executed in a forked process
  - public void setIncludeAntRuntime(boolean includeAntRuntime)
    
    Should the system classpath be included on the classpath when forking. Defaults to true.
    Parameters:
    includeAntRuntime - true if the system classpath should be on the classpath
  - public void setIndy(boolean indy)
    
    Sets the indy flag to enable or disable invokedynamic
    Parameters:
    indy - true means invokedynamic support is active
  - public void setOutput(File output)
    
    Set the output file; optional, defaults to the Ant log.
    Parameters:
    output - the output file
  - public void setScriptBaseClass(String scriptBaseClass)
    
    Set the script base class name
    Parameters:
    scriptBaseClass - the name of the base class for scripts
  - public void setSrc(File srcFile)
    
    Set the name of the file to be run. The folder of the file is automatically added to the classpath. Required unless statements are enclosed in the build file
    Parameters:
    srcFile - the file containing the groovy script to execute
  - public void setStacktrace(boolean stacktrace)
    
    Enable compiler to report stack trace information if a problem occurs during compilation.
    Parameters:
    stacktrace - set to true to enable stacktrace reporting
  - public void setUseGroovyShell(boolean useGroovyShell)
    
    Should a new GroovyShell be used when forking. Special variables won't be available but you don't need Ant in the classpath.
    Parameters:
    useGroovyShell - true if GroovyShell should be used to run the script directly

Summary:
Method

| Detail:
Method

[Java] Class Groovy

Methods Summary

Inherited Methods Summary

Method Detail

protected void addClassPathes(GroovyClassLoader classLoader)

public void addFileset(FileSet set)

public void addText(String txt)

public Commandline.Argument createArg()

public Path createClasspath()

protected void execGroovy(String txt, PrintStream out)

public void execute()

public Path getClasspath()

public static void main(String[] args)

protected void printResults(PrintStream out)

protected void runStatements(Reader reader, PrintStream out)

public void setAppend(boolean append)

public void setClasspath(Path classpath)

public void setClasspathRef(Reference ref)

public void setConfigscript(String configscript)

public void setContextClassLoader(boolean contextClassLoader)

public void setFork(boolean fork)

public void setIncludeAntRuntime(boolean includeAntRuntime)

public void setIndy(boolean indy)

public void setOutput(File output)

public void setScriptBaseClass(String scriptBaseClass)

public void setSrc(File srcFile)

public void setStacktrace(boolean stacktrace)

public void setUseGroovyShell(boolean useGroovyShell)