TransformInvocation

interface TransformInvocation


An invocation object used to pass of pertinent information for a transform call.

Summary

Public functions

Context

Returns the context in which the transform is run.

(Mutable)Collection<TransformInput!>

Returns the inputs/outputs of the transform.

TransformOutputProvider?

Returns the output provider allowing to create content.

(Mutable)Collection<TransformInput!>

Returns the referenced-only inputs which are not consumed by this transformation.

(Mutable)Collection<SecondaryInput!>

Returns the list of secondary file changes since last.

Boolean

Indicates whether the transform execution is incremental.

Public functions

getContext

fun getContext(): Context

Returns the context in which the transform is run.

Returns
Context

the context in which the transform is run.

getInputs

fun getInputs(): (Mutable)Collection<TransformInput!>

Returns the inputs/outputs of the transform.

Returns
(Mutable)Collection<TransformInput!>

the inputs/outputs of the transform.

getOutputProvider

fun getOutputProvider(): TransformOutputProvider?

Returns the output provider allowing to create content.

Returns
TransformOutputProvider?

he output provider allowing to create content.

getReferencedInputs

fun getReferencedInputs(): (Mutable)Collection<TransformInput!>

Returns the referenced-only inputs which are not consumed by this transformation.

Returns
(Mutable)Collection<TransformInput!>

the referenced-only inputs.

getSecondaryInputs

fun getSecondaryInputs(): (Mutable)Collection<SecondaryInput!>

Returns the list of secondary file changes since last. Only secondary files that this transform can handle incrementally will be part of this change set.

Returns
(Mutable)Collection<SecondaryInput!>

the list of changes impacting a SecondaryInput

isIncremental

fun isIncremental(): Boolean

Indicates whether the transform execution is incremental.

Returns
Boolean

true for an incremental invocation, false otherwise.