org.gradle.openapi.external

Class ExternalUtility

java.lang.Object

org.gradle.openapi.external.ExternalUtility

public class ExternalUtility
extends java.lang.Object

Utility functions required by the OpenAPI

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
ExternalUtility()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	dumpConstructors(java.lang.Class classInQuestion)
static java.lang.String	dumpMethods(java.lang.Class classInQuestion)
static java.lang.ClassLoader	getGradleClassloader(java.lang.ClassLoader parentClassLoader, java.io.File gradleHomeDirectory, boolean showDebugInfo) Call this to get a classloader that has loaded gradle.
static java.io.File	getGradleJar(java.io.File gradleHomeDirectory) This locates the gradle jar.
static java.lang.Object	invokeStaticMethod(java.lang.Class classToInvoke, java.lang.String methodName, java.lang.Class[] argumentsClasses, java.lang.Object... argumentValues) This wraps up invoking a static method into a single call.
static java.lang.Class	loadGradleClass(java.lang.String classToLoad, java.lang.ClassLoader parentClassLoader, java.io.File gradleHomeDirectory, boolean showDebugInfo) This attempts to load the a class from the specified gradle home directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalUtility

public ExternalUtility()

Method Detail

getGradleClassloader

public static java.lang.ClassLoader getGradleClassloader(java.lang.ClassLoader parentClassLoader,
                                         java.io.File gradleHomeDirectory,
                                         boolean showDebugInfo)
                                                  throws java.lang.Exception

Call this to get a classloader that has loaded gradle.

Parameters:

parentClassLoader - Your classloader. Probably the classloader of whatever class is calling this.

gradleHomeDirectory - the root directory of a gradle installation

showDebugInfo - true to show some additional information that may be helpful diagnosing problems is this fails

Returns:

a classloader that has loaded gradle and all of its dependencies.

Throws:

java.lang.Exception

getGradleJar

public static java.io.File getGradleJar(java.io.File gradleHomeDirectory)

This locates the gradle jar. We do NOT want the gradle-wrapper jar.

Parameters:

gradleHomeDirectory - the root directory of a gradle installation. We're expecting this to have a child directory named 'lib'.

Returns:

the gradle jar file. Null if we didn't find it.

dumpConstructors

public static java.lang.String dumpConstructors(java.lang.Class classInQuestion)

dumpMethods

public static java.lang.String dumpMethods(java.lang.Class classInQuestion)

loadGradleClass

public static java.lang.Class loadGradleClass(java.lang.String classToLoad,
                              java.lang.ClassLoader parentClassLoader,
                              java.io.File gradleHomeDirectory,
                              boolean showDebugInfo)
                                       throws java.lang.Exception

This attempts to load the a class from the specified gradle home directory.

Parameters:

classToLoad - the full path to the class to load

parentClassLoader - Your classloader. Probably the classloader of whatever class is calling this.

gradleHomeDirectory - the root directory of a gradle installation

showDebugInfo - true to show some additional information that may be helpful diagnosing problems is this fails

Throws:

java.lang.Exception

invokeStaticMethod

public static java.lang.Object invokeStaticMethod(java.lang.Class classToInvoke,
                                  java.lang.String methodName,
                                  java.lang.Class[] argumentsClasses,
                                  java.lang.Object... argumentValues)
                                           throws java.lang.Exception

This wraps up invoking a static method into a single call.

Parameters:

classToInvoke - the class that has the method

methodName - the name of the method to invoke

argumentsClasses - the classes of the arguments (we can't determine this from the argumentValues because they can be of class A, but implement class B and B is be the argument type of the method in question

argumentValues - the values of the arguments.

Returns:

the return value of invoking the method.

Throws:

java.lang.Exception