Package org.craftercms.studio.api.v1.asset.processing

Interface AssetProcessorPipeline

All Known Implementing Classes:

AssetProcessorPipelineImpl

public interface AssetProcessorPipeline

Represents a pipeline of AssetProcessors.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
List<Asset>	processAsset(ProcessorPipelineConfiguration config, Asset input)	Processes the asset, only if there's a match with ProcessorPipelineConfiguration.getInputPathPattern().

Method Detail

processAsset

List<Asset> processAsset(ProcessorPipelineConfiguration config,
                         Asset input)
                  throws AssetProcessingException

Processes the asset, only if there's a match with ProcessorPipelineConfiguration.getInputPathPattern(). If there's no match, an empty list is returned. Multiple outputs can be returned depending whether or not the processors of the pipeline have an output different than their input.

Parameters:

config - the configuration to use for the pipeline execution

input - the input of the pipeline

Returns:

the outputs, or an empty list if the input was not processed

Throws:

AssetProcessingException - if an error occurs