Package org.docstr.gradle.plugins.gwt

Class AbstractGwtActionTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
    Direct Known Subclasses:
    AbstractGwtTask, GwtSuperDev
    public abstract class AbstractGwtActionTask
extends org.gradle.api.DefaultTask
    Base class for all GWT related tasks.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        org.gradle.api.Task.Namer

    • Field Summary

      • Fields inherited from interface org.gradle.api.Task

        TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractGwtActionTask​(java.lang.String main)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract void addArgs()
      Called directly before executing this task.
      protected void argIfEnabled​(java.lang.Boolean condition, java.lang.String arg)  
      protected void argIfSet​(java.lang.String arg, java.lang.Object value)  
      protected void argOnOff​(java.lang.Boolean condition, java.lang.String onArg, java.lang.String offArg)  
      protected void args​(java.lang.Object... args)  
      protected void dirArgIfSet​(java.lang.String arg, java.io.File dir)  
      void exec()  
      org.gradle.api.file.FileCollection getClasspath()  
      java.util.List<java.lang.String> getExtraJvmArgs()  
      java.lang.String getGwtVersion()  
      java.lang.Boolean getIncremental()  
      GwtJsInteropExportsOptions getJsInteropExports()  
      JsInteropMode getJsInteropMode()  
      LogLevel getLogLevel()  
      java.lang.String getMaxHeapSize()  
      MethodNameDisplayMode getMethodNameDisplayMode()  
      java.lang.String getMinHeapSize()  
      java.util.List<java.lang.String> getModules()  
      java.lang.String getSourceLevel()  
      org.gradle.api.file.FileCollection getSrc()  
      boolean isDebug()  
      protected boolean isDevTask()
      If true the task instance is treated as being a development related task.
      boolean isUseToolchain()  
      protected void jvmArgs​(java.lang.Object... args)  
      protected boolean prependSrcToClasspath()
      If true this causes that the src is prepended to the classpath.
      void setClasspath​(org.gradle.api.file.FileCollection classpath)
      Sets the classpath for the spawned java process.
      void setDebug​(boolean debug)
      If set to true this enables debugging for the spawned java process.
      void setExtraJvmArgs​(java.util.List<java.lang.String> extraJvmArgs)  
      void setGwtVersion​(java.lang.String gwtVersion)  
      void setIncremental​(java.lang.Boolean incremental)  
      void setJsInteropExports​(GwtJsInteropExportsOptions jsInteropExports)  
      void setJsInteropMode​(JsInteropMode jsInteropMode)  
      void setLogLevel​(LogLevel logLevel)
      Sets the LogLevel for this task.
      void setMaxHeapSize​(java.lang.String maxHeapSize)
      Sets the maximum heap size for the spawned java process.
      void setMethodNameDisplayMode​(MethodNameDisplayMode methodNameDisplayMode)
      If set, this causes the "-XmethodNameDisplayMode" (added in GWT 2.7/2.8) parameter to be added.
      void setMinHeapSize​(java.lang.String minHeapSize)
      Sets the minimum heap size for the spawned java process.
      void setModules​(java.util.List<java.lang.String> modules)
      Sets the GWT modules (fully qualified names) to be used by this task.
      void setSourceLevel​(java.lang.String sourceLevel)  
      void setSrc​(org.gradle.api.file.FileCollection src)
      Sets the source directories used by this task instance.
      void setUseToolchain​(boolean useToolchain)  

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.gradle.api.Task

        getConvention

    • Constructor Detail

      • AbstractGwtActionTask

        public AbstractGwtActionTask​(java.lang.String main)

    • Method Detail

      • exec

        public void exec()

      • prependSrcToClasspath

        protected boolean prependSrcToClasspath()
        If true this causes that the src is prepended to the classpath. This is set to false for Super Dev Mode as the source is given to it as extra parameter.
        Returns:
        true if src should be prepended to the classpath, false otherwise.

      • getGwtVersion

        @Optional
@Input
public java.lang.String getGwtVersion()

      • setGwtVersion

        public void setGwtVersion​(java.lang.String gwtVersion)

      • getModules

        @Input
public java.util.List<java.lang.String> getModules()

      • setModules

        public void setModules​(java.util.List<java.lang.String> modules)
        Sets the GWT modules (fully qualified names) to be used by this task.
        Parameters:
        modules - GWT modules to be set for this task

      • args

        protected void args​(java.lang.Object... args)

      • jvmArgs

        protected void jvmArgs​(java.lang.Object... args)

      • argIfEnabled

        protected void argIfEnabled​(java.lang.Boolean condition,
                            java.lang.String arg)

      • argOnOff

        protected void argOnOff​(java.lang.Boolean condition,
                        java.lang.String onArg,
                        java.lang.String offArg)

      • dirArgIfSet

        protected void dirArgIfSet​(java.lang.String arg,
                           java.io.File dir)

      • argIfSet

        protected void argIfSet​(java.lang.String arg,
                        java.lang.Object value)

      • addArgs

        protected abstract void addArgs()
        Called directly before executing this task. Subclasses are expected to add all args/javaArgs needed for the execution.

      • isDevTask

        @Input
protected boolean isDevTask()
        If true the task instance is treated as being a development related task. Development related tasks will have the devModules set by default.
        Returns:
        true if the task is development related, false otherwise.

      • getSrc

        @InputFiles
@PathSensitive(RELATIVE)
public org.gradle.api.file.FileCollection getSrc()

      • setSrc

        public void setSrc​(org.gradle.api.file.FileCollection src)
        Sets the source directories used by this task instance. These source directories are used by GWT to read java source files from.
        Parameters:
        src - source directories to set

      • getClasspath

        @Classpath
public org.gradle.api.file.FileCollection getClasspath()

      • setClasspath

        public void setClasspath​(org.gradle.api.file.FileCollection classpath)
        Sets the classpath for the spawned java process.
        Parameters:
        classpath - the classpath to set

      • getMinHeapSize

        @Input
public java.lang.String getMinHeapSize()

      • setMinHeapSize

        public void setMinHeapSize​(java.lang.String minHeapSize)
        Sets the minimum heap size for the spawned java process.
        Parameters:
        minHeapSize - the minimum heap size to set

      • getMaxHeapSize

        @Input
public java.lang.String getMaxHeapSize()

      • setMaxHeapSize

        public void setMaxHeapSize​(java.lang.String maxHeapSize)
        Sets the maximum heap size for the spawned java process.
        Parameters:
        maxHeapSize - the maximum heap size to set

      • getExtraJvmArgs

        @Input
public java.util.List<java.lang.String> getExtraJvmArgs()

      • setExtraJvmArgs

        public void setExtraJvmArgs​(java.util.List<java.lang.String> extraJvmArgs)

      • isDebug

        @Input
public boolean isDebug()

      • isUseToolchain

        @Input
public boolean isUseToolchain()

      • setUseToolchain

        public void setUseToolchain​(boolean useToolchain)

      • setDebug

        public void setDebug​(boolean debug)
        If set to true this enables debugging for the spawned java process.
        Parameters:
        debug - true to enable debugging, false otherwise.

      • getLogLevel

        @Optional
@Input
public LogLevel getLogLevel()

      • setLogLevel

        public void setLogLevel​(LogLevel logLevel)
        Sets the LogLevel for this task.
        Parameters:
        logLevel - the log level to set

      • getSourceLevel

        @Optional
@Input
public java.lang.String getSourceLevel()

      • setSourceLevel

        public void setSourceLevel​(java.lang.String sourceLevel)

      • getIncremental

        @Optional
@Input
public java.lang.Boolean getIncremental()

      • setIncremental

        public void setIncremental​(java.lang.Boolean incremental)

      • getJsInteropMode

        @Optional
@Input
public JsInteropMode getJsInteropMode()

      • setJsInteropMode

        public void setJsInteropMode​(JsInteropMode jsInteropMode)

      • setMethodNameDisplayMode

        public void setMethodNameDisplayMode​(MethodNameDisplayMode methodNameDisplayMode)
        If set, this causes the "-XmethodNameDisplayMode" (added in GWT 2.7/2.8) parameter to be added.
        Parameters:
        methodNameDisplayMode - The method name display mode specified.