Package org.filestack.transforms

Class ImageTransform

java.lang.Object

org.filestack.transforms.Transform

org.filestack.transforms.ImageTransform

public class ImageTransform
extends Transform

Transform subclass for image transformations.

Field Summary

Fields inherited from class org.filestack.transforms.Transform

cdnService, config, isExternal, source, tasks

Constructor Summary

Constructors

Constructor	Description
ImageTransform(Config config, CdnService cdnService, String source, boolean isExternal)

Method Summary

Modifier and Type	Method	Description
ImageTransform	addTask(ImageTransformTask task)	Add a new transformation to the chain.
com.google.gson.JsonObject	debug()	Debugs the transformation as built so far, returning explanations of any issues.
io.reactivex.Single<com.google.gson.JsonObject>	debugAsync()	Async, observable version of debug().
FileLink	store()	Stores the result of a transformation into a new file.
FileLink	store(StorageOptions storageOptions)	Stores the result of a transformation into a new file.
io.reactivex.Single<FileLink>	storeAsync()	Async, observable version of store().
io.reactivex.Single<FileLink>	storeAsync(StorageOptions storageOptions)	Async, observable version of store(StorageOptions).

Methods inherited from class org.filestack.transforms.Transform

getContent, getContentAsync, getContentJson, getContentJsonAsync, url

Methods inherited from class java.lang.Object

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

Constructor Details

ImageTransform

public ImageTransform(Config config,
 CdnService cdnService,
 String source,
 boolean isExternal)

Method Details

debug

public com.google.gson.JsonObject debug()
                                 throws IOException

Debugs the transformation as built so far, returning explanations of any issues.

Returns:

JSON report for transformation

Throws:

HttpException - on error response fro\m backend

IOException - on network failure

See Also:

store

public FileLink store()
               throws IOException

Stores the result of a transformation into a new file. Uses default storage options.

Returns:

new FileLink pointing to the file

Throws:

HttpException - on error response from backend

IOException - on network failure

See Also:

store

public FileLink store(@Nullable
 StorageOptions storageOptions)
               throws IOException

Stores the result of a transformation into a new file.

Parameters:

storageOptions - configure where and how your file is stored

Returns:

new FileLink pointing to the file

Throws:

HttpException - on error response from backend

IOException - on network failure

See Also:

addTask

public ImageTransform addTask(ImageTransformTask task)

Add a new transformation to the chain. Tasks are executed in the order they are added.

Parameters:

task - any of the available ImageTransformTask subclasses

debugAsync

public io.reactivex.Single<com.google.gson.JsonObject> debugAsync()

Async, observable version of debug(). Same exceptions are passed through observable.

storeAsync

public io.reactivex.Single<FileLink> storeAsync()

Async, observable version of store(). Same exceptions are passed through observable.

storeAsync

public io.reactivex.Single<FileLink> storeAsync(@Nullable
 StorageOptions storageOptions)

Async, observable version of store(StorageOptions). Same exceptions are passed through observable.