com.facebook.spectrum

Class SpectrumResult

java.lang.Object

com.facebook.spectrum.SpectrumResult

public class SpectrumResult
extends java.lang.Object

A Result encapsulates information about the operation (e.g. the determined image format and size) as well as information about the applied rule.

Constructor Summary

Constructors

Constructor and Description
SpectrumResult(java.lang.String ruleName, ImageSpecification inputImageSpecification, ImageSpecification outputImageSpecification, long totalBytesRead, long totalBytesWritten)

Method Summary

Modifier and Type	Method and Description
ImageSpecification	getInputImageSpecification() Detected input image specification for the operation.
ImageSpecification	getOutputImageSpecification() Determined output image specification for the operation.
java.lang.String	getRuleName() Name of the rule which has performed the operation.
long	getTotalBytesRead() Total number of bytes that has been read from the underlying image source
long	getTotalBytesWritten() Total number of bytes that has been written to the image sink
boolean	isSuccessful() True iff a rule has been applied to fulfill the request
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpectrumResult

public SpectrumResult(@Nullable
                      java.lang.String ruleName,
                      @Nullable
                      ImageSpecification inputImageSpecification,
                      @Nullable
                      ImageSpecification outputImageSpecification,
                      long totalBytesRead,
                      long totalBytesWritten)

Method Detail

isSuccessful

public boolean isSuccessful()

True iff a rule has been applied to fulfill the request

getRuleName

@Nullable
public java.lang.String getRuleName()

Name of the rule which has performed the operation.

getInputImageSpecification

@Nullable
public ImageSpecification getInputImageSpecification()

Detected input image specification for the operation.

getOutputImageSpecification

@Nullable
public ImageSpecification getOutputImageSpecification()

Determined output image specification for the operation.

getTotalBytesRead

public long getTotalBytesRead()

Total number of bytes that has been read from the underlying image source

getTotalBytesWritten

public long getTotalBytesWritten()

Total number of bytes that has been written to the image sink

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object