com.facebook.spectrum

Class EncodedImageSink

java.lang.Object

com.facebook.spectrum.EncodedImageSink

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class EncodedImageSink
extends java.lang.Object
implements java.io.Closeable

Abstraction for any encoded output

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying OutputStream if the EncodedImageSink owns it.
static EncodedImageSink	from(java.io.File file) Creates an EncodedImageSink for the given file.
static EncodedImageSink	from(java.io.OutputStream outputStream) Creates an EncodedImageSink for the given OutputStream.
static EncodedImageSink	from(java.lang.String filePath) Creates an EncodedImageSink for the given file.
java.io.OutputStream	getOutputStream() Returns the underlying OutputStream
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static EncodedImageSink from(java.io.File file)
                             throws java.io.FileNotFoundException

Creates an EncodedImageSink for the given file.

Parameters:

file - The file to write to

Throws:

java.io.FileNotFoundException - If the file cannot be created

from

public static EncodedImageSink from(java.lang.String filePath)
                             throws java.io.FileNotFoundException

Creates an EncodedImageSink for the given file.

Parameters:

filePath - The file to write to

Throws:

java.io.FileNotFoundException - If the file cannot be created

from

public static EncodedImageSink from(java.io.OutputStream outputStream)

Creates an EncodedImageSink for the given OutputStream.

Parameters:

outputStream - to write to; the caller keeps ownership of the OutputStream and is responsible to properly close it.

getOutputStream

public java.io.OutputStream getOutputStream()

Returns the underlying OutputStream

close

public void close()
           throws java.io.IOException

Closes the underlying OutputStream if the EncodedImageSink owns it.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object