com.facebook.spectrum.options

Class Options

java.lang.Object

com.facebook.spectrum.options.Options

Direct Known Subclasses:

DecodeOptions, EncodeOptions, TranscodeOptions, TransformOptions

@Immutable
public class Options
extends java.lang.Object

The Options object encapsulates all parameters for an operation. In most cases subclasses (DecodeOptions, TranscodeOptions, EncodeOptions, TransformOptions) should be used instead of this type directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Options.Builder<T extends Options.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
Configuration	configuration Options in the configuration object will override default and app-wide settings.
EncodeRequirement	encodeRequirement The EncodeRequirement to apply.
ImageMetadata	metadata Optional metadata to consider besides the ones provided by the encoded image.
ImagePixelSpecification	outputPixelSpecification If set, will dictate the pixel specification images should be converted to before being passed to the compressor.
Transformations	transformations Contains optional Transformations such as resize, cropping and rotation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Options(Options.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()
java.lang.String	toString(java.lang.String className)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

encodeRequirement

@Nullable
public final EncodeRequirement encodeRequirement

The EncodeRequirement to apply. Dictates the final image format. If none, bitmap is deduced.

transformations

public final Transformations transformations

Contains optional Transformations such as resize, cropping and rotation.

metadata

@Nullable
public final ImageMetadata metadata

Optional metadata to consider besides the ones provided by the encoded image.

configuration

@Nullable
public final Configuration configuration

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

outputPixelSpecification

@Nullable
public final ImagePixelSpecification outputPixelSpecification

If set, will dictate the pixel specification images should be converted to before being passed to the compressor. An exception will be thrown if the pixel specification doesn't fit the image format.

Constructor Detail

Options

protected Options(Options.Builder builder)

Method Detail

toString

public java.lang.String toString(java.lang.String className)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object