net.sergeych.boss

Class Boss.Writer

java.lang.Object

net.sergeych.boss.Boss.Writer

Enclosing class:

Boss

public static class Boss.Writer
extends java.lang.Object

BOSS serializer. Serialized object trees or, in stream mode, could be used to seralize a stream of objects.

Constructor Summary

Constructors

Constructor and Description
Writer()
Writer(java.io.OutputStream outputStream) Creates writer to write to the output stream.
Writer(java.io.OutputStream outputStream, BiSerializer biSerializer) Creates writer to write to the output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
java.io.OutputStream	getOut()
void	setStreamMode() Turn encoder to stream mode (e.g.
byte[]	toByteArray() Return packed bytes.
Boss.Writer	write(java.lang.Object... objects) Serialize one or more objects.
Boss.Writer	writeObject(java.lang.Object obj) Serialize single object known to boss (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

Writer

public Writer(java.io.OutputStream outputStream,
              BiSerializer biSerializer)

Creates writer to write to the output stream. Upon creation writer is alwais in tree mode.

Parameters:

outputStream - See setStreamMode()

Writer

public Writer(java.io.OutputStream outputStream)

Creates writer to write to the output stream. Upon creation writer is alwais in tree mode.

Parameters:

outputStream - See setStreamMode()

Writer

public Writer()

Method Detail

setStreamMode

public void setStreamMode()
                   throws java.io.IOException

Turn encoder to stream mode (e.g. no cache). In stram mode the protocol do not never cache nor remember references, so restored object tree will not correspond to sources as all shared nodes will be copied. Stream mode is used in large streams to avoid unlimited cache growths.

Stream more pushes the special record to the stream so the decoder Reader will know the more. Before entering stream mode it is theoretically possible to write some cached trees, but this feature is yet untested.

Throws:

java.io.IOException

write

public Boss.Writer write(java.lang.Object... objects)
                  throws java.io.IOException

Serialize one or more objects. Objects will be serialized one by one, so corresponding number of read()'s is necessary to retrieve them all.

Parameters:

objects - any number of Objects known to BOSS

Returns:

this Writer instance

Throws:

java.io.IOException

writeObject

public Boss.Writer writeObject(java.lang.Object obj)
                        throws java.io.IOException

Serialize single object known to boss (e.g. integers, strings, byte[] arrays or Bytes class instances, Date instances, arrays, ArrayList, HashMap

Parameters:

obj - the root object to encode

Returns:

this instance to allow chaining calls

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getOut

public java.io.OutputStream getOut()

toByteArray

public byte[] toByteArray()

Return packed bytes. Works only if the underlying OutputStream was a ByteArrayOutputStream. The default constructor Writer.Writer() does so.

Returns:

boss-packed data