Package com.cloudinary.android.preprocess

Class PreprocessChain<T>

java.lang.Object

com.cloudinary.android.preprocess.PreprocessChain<T>

Type Parameters:

T - The type of the resource to execute the processing on (e.g. Bitmap)

public abstract class PreprocessChain<T>
extends java.lang.Object

A preprocess chain to run on resource before uploading. Pass an instance of a populated chain to UploadRequest.preprocess(PreprocessChain). The processing steps will run by the order in which they were added to the chain. Note: The best practice is to use a concrete subclass rather than extend this class. A chain can be used for manipulating and/or validating resources before starting the upload.

Constructor Summary

Constructors

Constructor	Description
PreprocessChain()

Method Summary

Modifier and Type	Method	Description
PreprocessChain<T>	addStep(Preprocess<T> step)	Add a preprocessing step to the chain
java.lang.String	execute(android.content.Context context, Payload payload)	Execute the processing chain.
protected abstract ResourceDecoder<T>	getDefaultDecoder()
protected abstract ResourceEncoder<T>	getDefaultEncoder()
boolean	isEmpty()	Checks if this chain is an empty chain (NOP chain).
PreprocessChain<T>	loadWith(ResourceDecoder<T> decoder)	Set a decoder to decode the resource
PreprocessChain<T>	saveWith(ResourceEncoder<T> encoder)	Set an encoder to encode the resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PreprocessChain

public PreprocessChain()

Method Details

getDefaultEncoder

protected abstract ResourceEncoder<T> getDefaultEncoder()

getDefaultDecoder

protected abstract ResourceDecoder<T> getDefaultDecoder()

loadWith

public PreprocessChain<T> loadWith(ResourceDecoder<T> decoder)

Set a decoder to decode the resource

Parameters:

decoder - The decoder to use

Returns:

itself for chaining.

saveWith

public PreprocessChain<T> saveWith(ResourceEncoder<T> encoder)

Set an encoder to encode the resource

Parameters:

encoder - The encoder to use

Returns:

itself for chaining.

addStep

public PreprocessChain<T> addStep(Preprocess<T> step)

Add a preprocessing step to the chain

Parameters:

step - Preprocess step

Returns:

itself for chaining.

execute

public java.lang.String execute(android.content.Context context, Payload payload) throws PayloadNotFoundException, PreprocessException

Execute the processing chain. this is for INTERNAL use by the upload request itself. Do not call this directly.

Parameters:

context - Android context

payload - Payload to run the chain on

Returns:

A filepath of the end result of the chain

Throws:

PayloadNotFoundException - if the payload is not found

PayloadDecodeException - if the payload is found but cannot be decoded

ResourceCreationException - if the processing is done but the result cannot be saved.

PreprocessException

isEmpty

public boolean isEmpty()

Checks if this chain is an empty chain (NOP chain).

Returns:

True if it's empty.