io.storj

Class ObjectOutputStream

java.lang.Object

java.io.OutputStream

io.storj.ObjectOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class ObjectOutputStream
extends java.io.OutputStream

An OutputStream for writing data to an object stored on the Storj network.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this input stream and releases any system resources associated with the stream.
void	commit() Commits data to the store.
ObjectInfo	info() Returns the last information about the uploaded object.
void	setCustomMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Method updates custom metadata to be included with the object.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Method Detail

write

public void write(int b)
           throws java.io.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.

Subclasses of OutputStream must provide an implementation for this method.

If error occur upload is automatically aborted.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte.

Throws:

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

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

If error occur upload is automatically aborted.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

commit

public void commit()
            throws StorjException

Commits data to the store.

Throws:

StorjException - if an error occurs during committing object

info

public ObjectInfo info()
                throws StorjException

Returns the last information about the uploaded object.

Returns:

the object info

Throws:

StorjException - if an error occurs during retrieving info

setCustomMetadata

public void setCustomMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
                       throws StorjException

Method updates custom metadata to be included with the object.

Parameters:

metadata - the metadata map, if it is null, it won't be modified.

Throws:

StorjException - if an error occurs during setting custom metadata

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream.

If stream was not committed then upload is automatically aborted on close.

The close method of InputStream does nothing.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - if an I/O error occurs.