io.ebean.enhance.ant.AntEnhanceTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean-agent Show documentation
There is a newer version: 15.8.0
package io.ebean.enhance.ant;

import io.ebean.enhance.Transformer;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;

import java.io.File;

/**
 * An ANT task that can enhance entity beans etc for use by Ebean.
 * 
 * You can use this ANT task as part of your build process to enhance entity
 * beans etc.
 * 
 * 
 * The parameters are:
 * 

 *  classSource This is the root directory where the .class files
 * are found. 
 *  packages A comma delimited list of packages that is searched for
 * classes that need to be enhanced. If the package ends with ** or * then all
 * subpackages are also searched. 
 *  transformArgs Arguments passed to the transformer. Typically a
 * debug level in the form of debug=1 etc. 
 * 
 * 
 *
 *  *
 * 	 <taskdef name="ebeanEnhance" classname="AntEnhanceTask" classpath="bin" />
 *
 *   <target name="enhance" depends="compile">
 *       <ebeanEnhance
 *            classSource="${bin.dir}"
 *            packages="com.avaje.ebean.meta.**, com.acme.myapp.entity.**"
 *            transformArgs="debug=1" />
 *   </target>
 *
 * 
 */
public class AntEnhanceTask extends Task {

  private String classpath;
  private String classSource;
  private String transformArgs;
  private String packages;

  @Override
  public void execute() throws BuildException {

//    StringBuilder extraClassPath = new StringBuilder();
//    extraClassPath.append(classSource);
//    if (classpath != null)
//    {
//      if (!extraClassPath.toString().endsWith(";"))
//      {
//        extraClassPath.append(";");
//      }
//      extraClassPath.append(classpath);
//    }
    Transformer t = new Transformer(null, transformArgs);//extraClassPath.toString(),

    ClassLoader cl = AntEnhanceTask.class.getClassLoader();
    OfflineFileTransform ft = new OfflineFileTransform(t, cl, classSource);
    ft.process(packages);
  }

  /**
   * the classpath used to search for e.g. inerited classes
   */
  public String getClasspath() {
    return classpath;
  }

  /**
   * the classpath used to search for e.g. inerited classes
   */
  public void setClasspath(String classpath) {
    this.classpath = classpath;
  }

  /**
   * Set the directory holding the class files we want to transform.
   */
  public void setClassSource(String source) {
    this.classSource = source;
  }

  /**
   * Set the arguments passed to the transformer.
   */
  public void setTransformArgs(String transformArgs) {
    this.transformArgs = transformArgs;
  }

  /**
   * Set the package name to search for classes to transform.
   * 
   * If the package name ends in "/**" then this recursively transforms all
   * sub packages as well.
   * 
   */
  public void setPackages(String packages) {
    this.packages = packages;
  }

}