org.zeromq.api

Class Message.FrameBuilder

java.lang.Object

org.zeromq.api.Message.FrameBuilder

Enclosing class:

Message

public static class Message.FrameBuilder
extends Object

Builder for constructing efficient binary representations of multi-value data frames using a dynamically sized buffer.

Constructor Summary

Constructors

Constructor and Description
FrameBuilder() Construct a builder with an initial buffer size of 32 bytes.
FrameBuilder(int capacity) Construct a builder with a given initial buffer size.

Method Summary

Modifier and Type	Method and Description
Message.Frame	build() Build a frame containing the data in the underlying buffer.
Message.FrameBuilder	putBlob(byte[] bytes) Put an array of bytes into the buffer as an int and bytes.
Message.FrameBuilder	putBlob(byte[] bytes, int offset, int length) Put an array of bytes into the buffer as an int and bytes.
Message.FrameBuilder	putByte(byte value) Put a byte of data into the buffer.
Message.FrameBuilder	putBytes(byte[] bytes) Put an array of bytes into the buffer as a byte and bytes.
Message.FrameBuilder	putBytes(byte[] bytes, int offset, int length) Put an array of bytes into the buffer as a byte and bytes.
Message.FrameBuilder	putClob(String value) Put an encoded String value into the buffer as an int and bytes using the default character set.
Message.FrameBuilder	putClobs(List<String> strings) Put a list of encoded String values into the buffer as an int and clobs using the default character set.
Message.FrameBuilder	putInt(int value) Put a int into the buffer.
Message.FrameBuilder	putLong(long value) Put a long into the buffer.
Message.FrameBuilder	putMap(Map<String,String> map)
Message.FrameBuilder	putShort(short value) Put a short into the buffer.
Message.FrameBuilder	putString(String value) Put an encoded String value into the buffer as a byte and string using the default character set.
Message.FrameBuilder	putStrings(List<String> strings) Put a list of encoded String values into the buffer as an int and strings using the default character set.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameBuilder

public FrameBuilder()

Construct a builder with an initial buffer size of 32 bytes.

FrameBuilder

public FrameBuilder(int capacity)

Construct a builder with a given initial buffer size.

Parameters:

capacity - The initial size of the buffer

Method Detail

putByte

public Message.FrameBuilder putByte(byte value)

Put a byte of data into the buffer.

Parameters:

value - A byte of data

Returns:

This builder, for method chaining

putShort

public Message.FrameBuilder putShort(short value)

Put a short into the buffer.

Parameters:

value - A short value

Returns:

This builder, for method chaining

putInt

public Message.FrameBuilder putInt(int value)

Put a int into the buffer.

Parameters:

value - An int value

Returns:

This builder, for method chaining

putLong

public Message.FrameBuilder putLong(long value)

Put a long into the buffer.

Parameters:

value - A long value

Returns:

This builder, for method chaining

putBytes

public Message.FrameBuilder putBytes(byte[] bytes)

Put an array of bytes into the buffer as a byte and bytes.

Parameters:

bytes - An array of bytes

Returns:

This builder, for method chaining

putBytes

public Message.FrameBuilder putBytes(byte[] bytes,
                                     int offset,
                                     int length)

Put an array of bytes into the buffer as a byte and bytes.

Parameters:

bytes - An array of bytes

offset - The offset within the array

length - The number of bytes to be read

Returns:

This builder, for method chaining

putString

public Message.FrameBuilder putString(String value)

Put an encoded String value into the buffer as a byte and string using the default character set.

Parameters:

value - A String value

Returns:

This builder, for method chaining

putStrings

public Message.FrameBuilder putStrings(List<String> strings)

Put a list of encoded String values into the buffer as an int and strings using the default character set.

Parameters:

strings - A List of String values

Returns:

This builder, for method chaining

putBlob

public Message.FrameBuilder putBlob(byte[] bytes)

Put an array of bytes into the buffer as an int and bytes.

Parameters:

bytes - An array of bytes

Returns:

This builder, for method chaining

putBlob

public Message.FrameBuilder putBlob(byte[] bytes,
                                    int offset,
                                    int length)

Put an array of bytes into the buffer as an int and bytes.

Parameters:

bytes - An array of bytes

offset - The offset within the array

length - The number of bytes to be read

Returns:

This builder, for method chaining

putClob

public Message.FrameBuilder putClob(String value)

Put an encoded String value into the buffer as an int and bytes using the default character set.

Parameters:

value - A String value

Returns:

This builder, for method chaining

putClobs

public Message.FrameBuilder putClobs(List<String> strings)

Put a list of encoded String values into the buffer as an int and clobs using the default character set.

Parameters:

strings - A List of String values

Returns:

This builder, for method chaining

putMap

public Message.FrameBuilder putMap(Map<String,String> map)

build

public Message.Frame build()

Build a frame containing the data in the underlying buffer.

Returns:

The new frame