public interface TransformOutputProvider

The output of a transform.

There is no direct access to a location to write. Instead, Transforms can ask to get the location for given scopes, content-types and a format.


Public methods

abstract void

Delete all content.

abstract File
    String name,
    Set<QualifiedContent.ContentType> types,
    Set<Object> scopes,
    Format format

This method is deprecated.

Public methods


abstract void deleteAll()

Delete all content. This is useful when running in non-incremental mode


if deleting the output failed.


abstract File getContentLocation(
    String name,
    Set<QualifiedContent.ContentType> types,
    Set<Object> scopes,
    Format format

Returns the location of content for a given set of Scopes, Content Types, and Format.

If the format is DIRECTORY then the result is the file location of the directory. If the format is JAR then the result is a file representing the jar to create.

Non of the directories or files are created by querying this method, and there is no checks regarding the existence of content in this location.

In case of incremental processing of removed files, it is safe to query the method to get the location of the files to removed.

String name

a unique name for the content. For a given set of scopes/types/format it must be unique.

Set<QualifiedContent.ContentType> types

the content types associated with this content.

Set<Object> scopes

the scopes associated with this content.

Format format

the format of the content.


the location of the content.