com.facebook.spectrum.requirements

Class EncodeRequirement

java.lang.Object

com.facebook.spectrum.requirements.EncodeRequirement

@Immutable
public class EncodeRequirement
extends java.lang.Object

Defines how an image should be encoded. This includes the EncodedImageFormat, the EncodeRequirement.Mode, and the quality level.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodeRequirement.Mode

Field Summary

Fields

Modifier and Type	Field and Description
EncodedImageFormat	format The format of the target encoded image.
EncodeRequirement.Mode	mode The compression mode.
int	quality The quality used to encode the image.
static int	QUALITY_MAX
static int	QUALITY_MIN
static int	QUALITY_UNSET

Constructor Summary

Constructors

Constructor and Description
EncodeRequirement(EncodedImageFormat format) Creates a new EncodeRequirement for the given EncodedImageFormat.
EncodeRequirement(EncodedImageFormat format, EncodeRequirement.Mode mode) Creates a new EncodeRequirement for the given EncodedImageFormat and EncodeRequirement.Mode.
EncodeRequirement(EncodedImageFormat format, int quality) Creates a new EncodeRequirement for the given EncodedImageFormat and quality.
EncodeRequirement(EncodedImageFormat format, int quality, EncodeRequirement.Mode mode) Creates a new EncodeRequirement for the given EncodedImageFormat, EncodeRequirement.Mode, and quality.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

QUALITY_UNSET

public static final int QUALITY_UNSET

See Also:

Constant Field Values

QUALITY_MIN

public static final int QUALITY_MIN

See Also:

Constant Field Values

QUALITY_MAX

public static final int QUALITY_MAX

See Also:

Constant Field Values

format

public final EncodedImageFormat format

The format of the target encoded image.

quality

public final int quality

The quality used to encode the image. Must be within the range of [1, 100]. 0 is considered unset and a default value for the format is used.

mode

public final EncodeRequirement.Mode mode

The compression mode.

Constructor Detail

EncodeRequirement

public EncodeRequirement(EncodedImageFormat format)

Creates a new EncodeRequirement for the given EncodedImageFormat. The result is either EncodeRequirement.Mode.LOSSLESS or EncodeRequirement.Mode.LOSSY. A default quality parameter will be used.

EncodeRequirement

public EncodeRequirement(EncodedImageFormat format,
                         EncodeRequirement.Mode mode)

Creates a new EncodeRequirement for the given EncodedImageFormat and EncodeRequirement.Mode. A default quality parameter will be used.

EncodeRequirement

public EncodeRequirement(EncodedImageFormat format,
                         int quality)

Creates a new EncodeRequirement for the given EncodedImageFormat and quality. The result is either EncodeRequirement.Mode.LOSSLESS or EncodeRequirement.Mode.LOSSY.

EncodeRequirement

public EncodeRequirement(EncodedImageFormat format,
                         int quality,
                         EncodeRequirement.Mode mode)

Creates a new EncodeRequirement for the given EncodedImageFormat, EncodeRequirement.Mode, and quality.

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object