Package com.onemillionworlds.tasks

Class AssetConstants

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.onemillionworlds.tasks.AssetConstants
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Generation is cheap; quicker to regenerate than to fetch from a cache") public abstract class AssetConstants extends org.gradle.api.DefaultTask

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ASSETS_FILE_NAME
     
    static final String
    FLAT_FILE_CONTEXT_CHANGE
     

    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
    AssetConstants()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createTypedMaterials()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getAssetFlatFiles()
    Asset flat files (e.g.
    org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile>
    getDestinationFile()
     
    org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile>
    getDestinationFlatFile()
     
    abstract org.gradle.api.provider.Property<String>
    getFullyQualifiedAssetsClass()
    If present, use this as the class name for the Assets constants class
    abstract org.gradle.api.provider.Property<String>
    getJarFilterRegex()
    If present use this as a regex to determine if a jar should be fully searched for assets.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputResourcesRoot()
    If present, the assets are output as a flat file into this directory.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputSourcesRoot()
    If present, the assets are output as a java class into this directory.
    abstract org.gradle.api.provider.Property<String>
    getProjectName()
    The name of the project owning this task, used as the context in the flat file.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getResourceDirectories()
    The local resource directories to search for assets.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getRuntimeClasspath()
    The classpath whose jars will be searched when a jarFilterRegex is set.
    abstract org.gradle.api.provider.Property<String>
    getWithinJarFileRegex()
    If present, use this regex to filter the files within the jars, only those that match will be included

    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, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, 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

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

  • Constructor Details

    • AssetConstants

      public AssetConstants()

  • Method Details

    • getFullyQualifiedAssetsClass

      @Optional @Input public abstract org.gradle.api.provider.Property<String> getFullyQualifiedAssetsClass()
      If present, use this as the class name for the Assets constants class

    • getJarFilterRegex

      @Optional @Input public abstract org.gradle.api.provider.Property<String> getJarFilterRegex()
      If present use this as a regex to determine if a jar should be fully searched for assets. (This means going through every file in the jar, not using the flat file that helpful libraries may leave in the jar)

    • getWithinJarFileRegex

      @Optional @Input public abstract org.gradle.api.provider.Property<String> getWithinJarFileRegex()
      If present, use this regex to filter the files within the jars, only those that match will be included

    • getResourceDirectories

      @InputFiles @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getResourceDirectories()
      The local resource directories to search for assets. By default, the plugin sets this to the main resource directories.

    • getAssetFlatFiles

      @InputFiles @PathSensitive(NONE) public abstract org.gradle.api.file.ConfigurableFileCollection getAssetFlatFiles()
      Asset flat files (e.g. produced by the assetsFile task of other modules) whose assets should be included

    • getProjectName

      @Optional @Input public abstract org.gradle.api.provider.Property<String> getProjectName()
      The name of the project owning this task, used as the context in the flat file. By default, the plugin sets this to the project name.

    • getRuntimeClasspath

      @InputFiles @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.ConfigurableFileCollection getRuntimeClasspath()
      The classpath whose jars will be searched when a jarFilterRegex is set. When registering this task manually (rather than via the typedMaterials extension) this should be set to the runtimeClasspath configuration.

      Jar names are significant (they are used for filtering and as the context), so this is NAME_ONLY rather than a @Classpath

    • getOutputSourcesRoot

      @Optional @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputSourcesRoot()
      If present, the assets are output as a java class into this directory. It should not be shared with any other task.

    • getOutputResourcesRoot

      @Optional @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputResourcesRoot()
      If present, the assets are output as a flat file into this directory. It should not be shared with any other task.

    • createTypedMaterials

      public void createTypedMaterials()

    • getDestinationFile

      @Internal public org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> getDestinationFile()

    • getDestinationFlatFile

      @Internal public org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> getDestinationFlatFile()