com.google.protobuf

Class ByteString.Output

java.lang.Object

java.io.OutputStream

com.google.protobuf.ByteString.Output

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Enclosing class:

ByteString

public static final class ByteString.Output
extends OutputStream

Outputs to a ByteString instance. Call toByteString() to create the ByteString instance.

Method Summary

Modifier and Type	Method and Description
void	reset() Resets this stream, so that all currently accumulated output in the output stream is discarded.
int	size() Returns the current size of the output stream.
ByteString	toByteString() Creates a byte string.
String	toString() Returns a string representation of the object.
void	write(byte[] b, int offset, int length) 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.
void	writeTo(OutputStream out) Writes the complete contents of this byte array output stream to the specified output stream argument.

Methods inherited from class java.io.OutputStream

close, flush, write

Methods inherited from class java.lang.Object

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

Method Detail

reset

public void reset()

Resets this stream, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.

size

public int size()

Returns the current size of the output stream.

Returns:

the current size of the output stream

toByteString

public ByteString toByteString()

Creates a byte string. Its size is the current size of this output stream and its output has been copied to it.

Returns:

the current contents of this output stream, as a byte string.

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

write

public void write(byte[] b,
                  int offset,
                  int length)

Description copied from class: OutputStream

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.

Overrides:

write in class OutputStream

Parameters:

b - the data.

offset - the start offset in the data.

length - the number of bytes to write.

write

public void write(int b)

Description copied from class: OutputStream

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.

Specified by:

write in class OutputStream

Parameters:

b - the byte.

writeTo

public void writeTo(OutputStream out)
             throws IOException

Writes the complete contents of this byte array output stream to the specified output stream argument.

Parameters:

out - the output stream to which to write the data.

Throws:

IOException - if an I/O error occurs.