com.facebook.spectrum.options

Class Options.Builder<T extends Options.Builder<T>>

java.lang.Object

com.facebook.spectrum.options.Options.Builder<T>

Direct Known Subclasses:

DecodeOptions.Builder, EncodeOptions.Builder, TranscodeOptions.Builder, TransformOptions.Builder

Enclosing class:

Options

public abstract static class Options.Builder<T extends Options.Builder<T>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration
protected CropRequirement	cropRequirement
protected EncodeRequirement	encodeRequirement
protected ImageMetadata	metadata
protected ImagePixelSpecification	outputPixelSpecification
protected ResizeRequirement	resizeRequirement
protected RotateRequirement	rotateRequirement

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
abstract Options	build()
T	configuration(Configuration configuration) Options in the configuration object will override default and app-wide settings.
T	crop(CropRequirement cropRequirement) The crop requirement to apply.
T	cropAbsoluteToOrigin(int left, int top, int right, int bottom, boolean mustBeExact) The crop requirement to apply.
T	cropRelativeToOrigin(float left, float top, float right, float bottom, boolean mustBeExact) The crop requirement to apply.
T	resize(ResizeRequirement.Mode mode, ImageSize targetSize) The resize requirement to apply.
T	resize(ResizeRequirement.Mode mode, int sideLength) The resize requirement to apply.
T	resize(ResizeRequirement resizeRequirement) The resize requirement to apply.
T	rotate(int degrees) The rotates the image by the given amount of degrees.
T	rotate(int degrees, boolean flipHorizontally, boolean flipVertically, boolean forceUpOrientation) The rotate requirement to apply.
T	rotate(RotateRequirement rotateRequirement) The rotate requirement to apply.

Methods inherited from class java.lang.Object

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

Field Detail

encodeRequirement

@Nullable
protected EncodeRequirement encodeRequirement

resizeRequirement

@Nullable
protected ResizeRequirement resizeRequirement

rotateRequirement

@Nullable
protected RotateRequirement rotateRequirement

cropRequirement

@Nullable
protected CropRequirement cropRequirement

metadata

@Nullable
protected ImageMetadata metadata

configuration

@Nullable
protected Configuration configuration

outputPixelSpecification

@Nullable
protected ImagePixelSpecification outputPixelSpecification

Constructor Detail

Builder

protected Builder()

Method Detail

configuration

public T configuration(Configuration configuration)

Options in the configuration object will override default and app-wide settings.

resize

public T resize(ResizeRequirement resizeRequirement)

The resize requirement to apply.

resize

public T resize(ResizeRequirement.Mode mode,
                ImageSize targetSize)

The resize requirement to apply. See ResizeRequirement.ResizeRequirement(ResizeRequirement.Mode, ImageSize)

resize

public T resize(ResizeRequirement.Mode mode,
                int sideLength)

The resize requirement to apply. See ResizeRequirement.ResizeRequirement(ResizeRequirement.Mode, int)

crop

public T crop(CropRequirement cropRequirement)

The crop requirement to apply.

cropAbsoluteToOrigin

public T cropAbsoluteToOrigin(int left,
                              int top,
                              int right,
                              int bottom,
                              boolean mustBeExact)

The crop requirement to apply. See CropRequirement.makeAbsoluteToOrigin(int, int, int, int, boolean)

cropRelativeToOrigin

public T cropRelativeToOrigin(float left,
                              float top,
                              float right,
                              float bottom,
                              boolean mustBeExact)

The crop requirement to apply. See CropRequirement.makeRelativeToOrigin(float, float, float, float, boolean)

rotate

public T rotate(RotateRequirement rotateRequirement)

The rotate requirement to apply.

rotate

public T rotate(int degrees,
                boolean flipHorizontally,
                boolean flipVertically,
                boolean forceUpOrientation)

The rotate requirement to apply. See RotateRequirement.RotateRequirement(int, boolean, boolean, boolean)

rotate

public T rotate(int degrees)

The rotates the image by the given amount of degrees. See RotateRequirement.RotateRequirement(int)

build

public abstract Options build()