Package com.ss.android.ugc.bytex.common

Interface TransformConfiguration

  • public interface TransformConfiguration

    • Method Summary

      All Methods Instance Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default boolean consumesFeatureJars()  
      default java.util.Set<com.android.build.api.transform.QualifiedContent.ContentType> getInputTypes()
      Returns the type(s) of data that is consumed by the Transform.
      default java.util.Set<com.android.build.api.transform.QualifiedContent.ContentType> getOutputTypes()
      Returns the type(s) of data that is generated by the Transform.
      default java.util.Map<java.lang.String,​java.lang.Object> getParameterInputs()
      Returns a map of non-file input parameters using a unique identifier as the map key.
      default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getReferencedScopes()
      Deprecated.
      default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getReferencedScopes​(com.android.build.gradle.internal.scope.VariantScope variantScope)
      Returns the referenced scope(s) for the Transform.
      default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getScopes()
      Deprecated.
      default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getScopes​(com.android.build.gradle.internal.scope.VariantScope variantScope)
      Returns the scope(s) of the Transform.
      default java.util.Collection<java.io.File> getSecondaryDirectoryOutputs()
      Returns a list of additional (out of streams) directory(ies) that this Transform creates.
      default java.util.Collection<java.io.File> getSecondaryFileInputs()
      Deprecated.
      replaced by getSecondaryFiles()
      default java.util.Collection<java.io.File> getSecondaryFileOutputs()
      Returns a list of additional (out of streams) file(s) that this Transform creates.
      default java.util.Collection<com.android.build.api.transform.SecondaryFile> getSecondaryFiles()
      Returns a list of additional file(s) that this Transform needs to run.
      default boolean isIncremental()  

    • Method Detail

      • getInputTypes

        @NonNull
default java.util.Set<com.android.build.api.transform.QualifiedContent.ContentType> getInputTypes()
        Returns the type(s) of data that is consumed by the Transform. This may be more than one type. This must be of type QualifiedContent.DefaultContentType

      • getOutputTypes

        @NonNull
default java.util.Set<com.android.build.api.transform.QualifiedContent.ContentType> getOutputTypes()
        Returns the type(s) of data that is generated by the Transform. This may be more than one type.

        The default implementation returns getInputTypes().

        This must be of type QualifiedContent.DefaultContentType

      • getScopes

        @NonNull
default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getScopes​(@Nullable
                                                                                                com.android.build.gradle.internal.scope.VariantScope variantScope)
        Returns the scope(s) of the Transform. This indicates which scopes the handle consumes.

      • getScopes

        @NonNull
@Deprecated
default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getScopes()
        Deprecated.
        Returns the scope(s) of the Transform. This indicates which scopes the handle consumes.

      • getReferencedScopes

        @NonNull
default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getReferencedScopes​(@Nullable
                                                                                                          com.android.build.gradle.internal.scope.VariantScope variantScope)
        Returns the referenced scope(s) for the Transform. These scopes are not consumed by the Transform. They are provided as inputs, but are still available as inputs for other Transforms to consume.

        The default implementation returns an empty Set.

      • getReferencedScopes

        @NonNull
@Deprecated
default java.util.Set<? super com.android.build.api.transform.QualifiedContent.Scope> getReferencedScopes()
        Deprecated.
        Returns the referenced scope(s) for the Transform. These scopes are not consumed by the Transform. They are provided as inputs, but are still available as inputs for other Transforms to consume.

        The default implementation returns an empty Set.

      • getSecondaryFileInputs

        @Deprecated
@NonNull
default java.util.Collection<java.io.File> getSecondaryFileInputs()
        Deprecated.
        replaced by getSecondaryFiles()
        Returns a list of additional file(s) that this Transform needs to run. Preferably, use getSecondaryFiles() API which allow eah secondary file to indicate if changes can be handled incrementally or not. This API will treat all additional file change as a non incremental event.

        Changes to files returned in this list will trigger a new execution of the Transform even if the qualified-content inputs haven't been touched.

        Any changes to these files will trigger a non incremental execution.

        The default implementation returns an empty collection.

      • getSecondaryFiles

        @NonNull
default java.util.Collection<com.android.build.api.transform.SecondaryFile> getSecondaryFiles()
        Returns a list of additional file(s) that this Transform needs to run.

        Changes to files returned in this list will trigger a new execution of the Transform even if the qualified-content inputs haven't been touched.

        Each secondary input has the ability to be declared as necessitating a non incremental execution in case of change. This Transform can therefore declare which secondary file changes it supports in incremental mode.

        The default implementation returns an empty collection.

      • getSecondaryFileOutputs

        @NonNull
default java.util.Collection<java.io.File> getSecondaryFileOutputs()
        Returns a list of additional (out of streams) file(s) that this Transform creates.

        These File instances can only represent files, not directories. For directories, use getSecondaryDirectoryOutputs()

        Changes to files returned in this list will trigger a new execution of the Transform even if the qualified-content inputs haven't been touched.

        Changes to these output files force a non incremental execution.

        The default implementation returns an empty collection.

      • getSecondaryDirectoryOutputs

        @NonNull
default java.util.Collection<java.io.File> getSecondaryDirectoryOutputs()
        Returns a list of additional (out of streams) directory(ies) that this Transform creates.

        These File instances can only represent directories. For files, use getSecondaryFileOutputs()

        Changes to directories returned in this list will trigger a new execution of the Transform even if the qualified-content inputs haven't been touched.

        Changes to these output directories force a non incremental execution.

        The default implementation returns an empty collection.

      • getParameterInputs

        @NonNull
default java.util.Map<java.lang.String,​java.lang.Object> getParameterInputs()
        Returns a map of non-file input parameters using a unique identifier as the map key.

        Changes to values returned in this map will trigger a new execution of the Transform even if the content inputs haven't been touched.

        Changes to these values force a non incremental execution.

        The default implementation returns an empty Map.

      • isIncremental

        default boolean isIncremental()

      • consumesFeatureJars

        default boolean consumesFeatureJars()