com.microsoft.azure.storage.file

Class FileOutputStream

java.lang.Object

java.io.OutputStream

com.microsoft.azure.storage.file.FileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FileOutputStream
extends OutputStream

The class is an append-only stream for writing into storage.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileOutputStream(CloudFile parentFile, long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Initializes a new instance of the FileOutputStream class.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] data) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] data, int offset, int length) Writes length bytes from the specified byte array starting at offset to this output stream.
void	write(InputStream sourceStream, long writeLength) Writes all data from the InputStream to the File.
void	write(int byteVal) Writes the specified byte to this output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileOutputStream

@DoesServiceRequest
protected FileOutputStream(CloudFile parentFile,
                                               long length,
                                               AccessCondition accessCondition,
                                               FileRequestOptions options,
                                               OperationContext opContext)
                                        throws StorageException

Initializes a new instance of the FileOutputStream class.

Parameters:

parentFile - A CloudFile object which represents the file that this stream is associated with.

length - A long which represents the length of the file in bytes.

accessCondition - An AccessCondition object which represents the access conditions for the file.

options - A FileRequestOptions object which specifies any additional options for the request.

opContext - An OperationContext object which is used to track the execution of the operation

Throws:

StorageException - An exception representing any error which occurred during the operation.

Method Detail

close

@DoesServiceRequest
public void close()
                               throws IOException

Closes this output stream and releases any system resources associated with this stream. If any data remains in the buffer it is committed to the service.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException - If an I/O error occurs.

flush

@DoesServiceRequest
public void flush()
                               throws IOException

Flushes this output stream and forces any buffered output bytes to be written out. If any data remains in the buffer it is committed to the service.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException - If an I/O error occurs.

write

@DoesServiceRequest
public void write(byte[] data)
                               throws IOException

Writes b.length bytes from the specified byte array to this output stream.

Overrides:

write in class OutputStream

Parameters:

data - A byte array which represents the data to write.

Throws:

IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

@DoesServiceRequest
public void write(byte[] data,
                                      int offset,
                                      int length)
                               throws IOException

Writes length bytes from the specified byte array starting at offset to this output stream.

Overrides:

write in class OutputStream

Parameters:

data - A byte array which represents the data to write.

offset - An int which represents the start offset in the data.

length - An int which represents the number of bytes to write.

Throws:

IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

@DoesServiceRequest
public void write(InputStream sourceStream,
                                      long writeLength)
                               throws IOException,
                                      StorageException

Writes all data from the InputStream to the File.

Parameters:

sourceStream - An InputStream object which species the data to write to the File.

Throws:

IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

StorageException - An exception representing any error which occurred during the operation.

write

@DoesServiceRequest
public void write(int byteVal)
                               throws IOException

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

write in class OutputStream

Parameters:

byteVal - An int which represents the bye value to write.

Throws:

IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.