Message (jzmq-api 0.2.0-SNAPSHOT API)

java.lang.Object
- org.zeromq.api.Message

All Implemented Interfaces:

Iterable<Message.Frame>

Direct Known Subclasses:

RoutedMessage
```
public class Message
extends Object
implements Iterable<Message.Frame>
```
Message containing frames for sending data via a socket.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.Frame` Represents a single frame of data within a message.
`static class`	`Message.FrameBuilder` Builder for constructing efficient binary representations of multi-value data frames using a dynamically sized buffer.

Field Summary

Fields
Modifier and Type	Field and Description
`static Charset`	`CHARSET` Default charset, to be customized by the application, or set via property.
`static Message.Frame`	`EMPTY_FRAME` A handy reference to an empty `Message.Frame`.

Constructor Summary

Constructors
Constructor and Description
`Message()` Construct an empty message.
`Message(byte[] firstFrame)` Construct a message with a single `byte[]` frame.
`Message(int firstFrame)` Construct a message with a single `int` frame.
`Message(List<Message.Frame> frames)` Construct a message with the given frames.
`Message(long firstFrame)` Construct a message with a single `long` frame.
`Message(Message.Frame firstFrame)` Construct a message with a single frame.
`Message(Message message)` Construct a message by cloning the given message's frames.
`Message(String firstFrame)` Construct a message with a single String frame.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`addBuffer(ByteBuffer frame)` Add a frame containing bytes in the given Buffer to the end of the list.
`Message`	`addByte(byte frame)` Add a frame containing a `byte` to the end of the list.
`Message`	`addBytes(byte[] frame)` Add a frame containing the given bytes to the end of the list.
`Message`	`addClobs(List<String> strings)` Add a frame containing a List of String values to the end of the list.
`Message`	`addEmptyFrame()` Add an empty frame to the end of the list.
`Message`	`addFrame(Message.Frame frame)` Add a frame to the end of the list.
`Message`	`addFrames(List<Message.Frame> frames)` Add the given frames to the end of the list.
`Message`	`addFrames(Message payload)` Add all frames from the given Message to the end of the list.
`Message`	`addInt(int frame)` Add a frame containing an `int` value to the end of the list.
`Message`	`addLong(long frame)` Add a frame containing a `long` value to the end of the list.
`Message`	`addMap(Map<String,String> map)` Add a frame containing a Map of String pairs to the end of the list.
`Message`	`addShort(short frame)` Add a frame containing a `short` value to the end of the list.
`Message`	`addString(String frame)` Add a frame containing a String value to the end of the list.
`Message`	`addStrings(List<String> strings)` Add a frame containing a List of String values to the end of the list.
`protected StringBuilder`	`dump(StringBuilder sb)` Dump the message in human readable format.
`Message.Frame`	`getFirstFrame()` Return the first frame in the list.
`List<Message.Frame>`	`getFrames()` Return a copy of the list of frames contained in this message.
`boolean`	`isEmpty()` Returns `true` if this message contains no frames.
`boolean`	`isMissing()` An alias for `isEmpty()`.
`Iterator<Message.Frame>`	`iterator()` Returns an iterator over the frames in this message.
`byte`	`popByte()` Remove a frame from the beginning of the list and convert to a `byte`.
`byte[]`	`popBytes()` Remove a frame from the beginning of the list and convert to a `byte[]`.
`List<String>`	`popClobs()` Remove a frame containing a List of String values from the beginning of the list.
`Message.Frame`	`popFrame()` Remove a frame from the beginning of the list.
`int`	`popInt()` Remove a frame from the beginning of the list and convert to an `int`.
`long`	`popLong()` Remove a frame from the beginning of the list and convert to a `long`.
`Map<String,String>`	`popMap()` Remove a frame containing a Map of String pairs from the beginning of the list.
`short`	`popShort()` Remove a frame from the beginning of the list and convert to a `short`.
`String`	`popString()` Remove a frame containing a String value from the beginning of the list.
`List<String>`	`popStrings()` Remove a frame containing a List of String values from the beginning of the list.
`Message`	`pushBuffer(ByteBuffer frame)` Add a frame containing bytes in the given Buffer to the beginning of the list.
`Message`	`pushByte(byte frame)` Add a frame containing a `byte` to the beginning of the list.
`Message`	`pushBytes(byte[] frame)` Add a frame containing the given bytes to the beginning of the list.
`Message`	`pushClobs(List<String> strings)` Add a frame containing a List of String values to the beginning of the list.
`Message`	`pushFrame(Message.Frame frame)` Add a frame to the beginning of the list.
`Message`	`pushFrames(List<Message.Frame> frames)` Add frames to the beginning of the list, in reverse order, such that the elements are in the same order as in the original List.
`Message`	`pushFrames(Message payload)` Add frames to the beginning of the list, in reverse order, such that the elements are in the same order as in the original Message.
`Message`	`pushInt(int frame)` Add a frame containing an `int` value to the beginning of the list.
`Message`	`pushLong(long frame)` Add a frame containing a `long` value to the beginning of the list.
`Message`	`pushMap(Map<String,String> map)` Add a frame containing a Map of String pairs to the beginning of the list.
`Message`	`pushShort(short frame)` Add a frame containing a `short` value to the beginning of the list.
`Message`	`pushString(String frame)` Add a frame containing a String value to the beginning of the list.
`Message`	`pushStrings(List<String> strings)` Add a frame containing a List of String values to the beginning of the list.
`int`	`size()` Returns the number of frames in this message.
`String`	`toString()` Convert the message to a string, for use in debugging.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - CHARSET
```
public static Charset CHARSET
```
    Default charset, to be customized by the application, or set via property.
  - EMPTY_FRAME
```
public static final Message.Frame EMPTY_FRAME
```
    A handy reference to an empty Message.Frame.
- Constructor Detail
  - Message
```
public Message()
```
    Construct an empty message.
  - Message
```
public Message(String firstFrame)
```
    Construct a message with a single String frame.
    
    Parameters:
    
    firstFrame - The first frame in the new message
  - Message
```
public Message(byte[] firstFrame)
```
    Construct a message with a single byte[] frame.
    
    Parameters:
    
    firstFrame - The first frame in the new message
  - Message
```
public Message(int firstFrame)
```
    Construct a message with a single int frame.
    
    Parameters:
    
    firstFrame - The first frame in the new message
  - Message
```
public Message(long firstFrame)
```
    Construct a message with a single long frame.
    
    Parameters:
    
    firstFrame - The first frame in the new message
  - Message
```
public Message(Message.Frame firstFrame)
```
    Construct a message with a single frame.
    
    Parameters:
    
    firstFrame - The first frame in the new message
  - Message
```
public Message(List<Message.Frame> frames)
```
    Construct a message with the given frames.
    
    Parameters:
    
    frames - The initial list of frames to populate the message
  - Message
```
public Message(Message message)
```
    Construct a message by cloning the given message's frames.
    
    Parameters:
    
    message - The original message to clone
- Method Detail
  - getFrames
```
public List<Message.Frame> getFrames()
```
    Return a copy of the list of frames contained in this message.
    
    Returns:
    
    The frames of this message
  - addFrame
```
public Message addFrame(Message.Frame frame)
```
    Add a frame to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - addEmptyFrame
```
public Message addEmptyFrame()
```
    Add an empty frame to the end of the list.
    
    Returns:
    
    This Message, for method chaining
  - getFirstFrame
```
public Message.Frame getFirstFrame()
```
    Return the first frame in the list.
    
    Returns:
    
    The first frame
  - pushFrame
```
public Message pushFrame(Message.Frame frame)
```
    Add a frame to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popFrame
```
public Message.Frame popFrame()
```
    Remove a frame from the beginning of the list.
    
    Returns:
    
    The first frame
  - addString
```
public Message addString(String frame)
```
    Add a frame containing a String value to the end of the list.
    
    Parameters:
    
    frame - The frame to be added, as a String
    
    Returns:
    
    This Message, for method chaining
  - pushString
```
public Message pushString(String frame)
```
    Add a frame containing a String value to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added, as a String
    
    Returns:
    
    This Message, for method chaining
  - popString
```
public String popString()
```
    Remove a frame containing a String value from the beginning of the list.
    
    Returns:
    
    The first frame, as a String
  - addStrings
```
public Message addStrings(List<String> strings)
```
    Add a frame containing a List of String values to the end of the list.
    
    Parameters:
    
    strings - The frame to be added, as a List of Strings
    
    Returns:
    
    This Message, for method chaining
  - pushStrings
```
public Message pushStrings(List<String> strings)
```
    Add a frame containing a List of String values to the beginning of the list.
    
    Parameters:
    
    strings - The frame to be added, as a List of Strings
    
    Returns:
    
    This Message, for method chaining
  - popStrings
```
public List<String> popStrings()
```
    Remove a frame containing a List of String values from the beginning of the list.
    
    Returns:
    
    The first frame, as a list of Strings
  - addClobs
```
public Message addClobs(List<String> strings)
```
    Add a frame containing a List of String values to the end of the list.
    
    Parameters:
    
    strings - The frame to be added, as a List of Strings
    
    Returns:
    
    This Message, for method chaining
  - pushClobs
```
public Message pushClobs(List<String> strings)
```
    Add a frame containing a List of String values to the beginning of the list.
    
    Parameters:
    
    strings - The frame to be added, as a List of Strings
    
    Returns:
    
    This Message, for method chaining
  - popClobs
```
public List<String> popClobs()
```
    Remove a frame containing a List of String values from the beginning of the list.
    
    Returns:
    
    The first frame, as a list of Strings
  - addMap
```
public Message addMap(Map<String,String> map)
```
    Add a frame containing a Map of String pairs to the end of the list.
    
    Parameters:
    
    map - The frame to be added, as a Map
    
    Returns:
    
    This Message, for method chaining
  - pushMap
```
public Message pushMap(Map<String,String> map)
```
    Add a frame containing a Map of String pairs to the beginning of the list.
    
    Parameters:
    
    map - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popMap
```
public Map<String,String> popMap()
```
    Remove a frame containing a Map of String pairs from the beginning of the list.
    
    Returns:
    
    The first frame, as a Map
  - addInt
```
public Message addInt(int frame)
```
    Add a frame containing an int value to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushInt
```
public Message pushInt(int frame)
```
    Add a frame containing an int value to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popInt
```
public int popInt()
```
    Remove a frame from the beginning of the list and convert to an int.
    
    Returns:
    
    The first frame, as an integer
  - addLong
```
public Message addLong(long frame)
```
    Add a frame containing a long value to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushLong
```
public Message pushLong(long frame)
```
    Add a frame containing a long value to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popLong
```
public long popLong()
```
    Remove a frame from the beginning of the list and convert to a long.
    
    Returns:
    
    The first frame, as a long
  - addShort
```
public Message addShort(short frame)
```
    Add a frame containing a short value to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushShort
```
public Message pushShort(short frame)
```
    Add a frame containing a short value to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popShort
```
public short popShort()
```
    Remove a frame from the beginning of the list and convert to a short.
    
    Returns:
    
    The first frame, as a short
  - addByte
```
public Message addByte(byte frame)
```
    Add a frame containing a byte to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushByte
```
public Message pushByte(byte frame)
```
    Add a frame containing a byte to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popByte
```
public byte popByte()
```
    Remove a frame from the beginning of the list and convert to a byte.
    
    Returns:
    
    The first frame, as a byte
  - addBuffer
```
public Message addBuffer(ByteBuffer frame)
```
    Add a frame containing bytes in the given Buffer to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushBuffer
```
public Message pushBuffer(ByteBuffer frame)
```
    Add a frame containing bytes in the given Buffer to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - addBytes
```
public Message addBytes(byte[] frame)
```
    Add a frame containing the given bytes to the end of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - pushBytes
```
public Message pushBytes(byte[] frame)
```
    Add a frame containing the given bytes to the beginning of the list.
    
    Parameters:
    
    frame - The frame to be added
    
    Returns:
    
    This Message, for method chaining
  - popBytes
```
public byte[] popBytes()
```
    Remove a frame from the beginning of the list and convert to a byte[].
    
    Returns:
    
    The first frame, as a byte array
  - addFrames
```
public Message addFrames(List<Message.Frame> frames)
```
    Add the given frames to the end of the list.
    
    Parameters:
    
    frames - The frames to be added
    
    Returns:
    
    This Message, for method chaining
  - addFrames
```
public Message addFrames(Message payload)
```
    Add all frames from the given Message to the end of the list.
    
    Parameters:
    
    payload - The original message, containing frames to be added
    
    Returns:
    
    This Message, for method chaining
  - pushFrames
```
public Message pushFrames(List<Message.Frame> frames)
```
    Add frames to the beginning of the list, in reverse order, such that the elements are in the same order as in the original List.
    
    Parameters:
    
    frames - The frames to be added
    
    Returns:
    
    This Message, for method chaining
  - pushFrames
```
public Message pushFrames(Message payload)
```
    Add frames to the beginning of the list, in reverse order, such that the elements are in the same order as in the original Message.
    
    Parameters:
    
    payload - The original message, containing frames to be added
    
    Returns:
    
    This Message, for method chaining
  - isMissing
```
public boolean isMissing()
```
    An alias for isEmpty().
    
    Returns:
    
    true if the message is empty, false otherwise
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this message contains no frames.
    
    Returns:
    
    true if the message is empty, false otherwise
  - size
```
public int size()
```
    Returns the number of frames in this message.
    
    Returns:
    
    The number of frames in this message
  - iterator
```
public Iterator<Message.Frame> iterator()
```
    Returns an iterator over the frames in this message.
    
    Specified by:
    
    iterator in interface Iterable<Message.Frame>
    
    Returns:
    
    An iterator over the frames in this message
  - dump
```
protected StringBuilder dump(StringBuilder sb)
```
    Dump the message in human readable format.
    This should only be used for debugging and tracing, inefficient in handling large messages.
    
    Parameters:
    
    sb - The StringBuilder
    
    Returns:
    
    A StringBuilder with the message in human readable format
  - toString
```
public String toString()
```
    Convert the message to a string, for use in debugging.
    
    Overrides:
    
    toString in class Object

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

CHARSET

EMPTY_FRAME

Constructor Detail

Message

Message

Message

Message

Message

Message

Message

Message

Method Detail

getFrames

addFrame

addEmptyFrame

getFirstFrame

pushFrame

popFrame

addString

pushString

popString

addStrings

pushStrings

popStrings

addClobs

pushClobs

popClobs

addMap

pushMap

popMap

addInt

pushInt

popInt

addLong

pushLong

popLong

addShort

pushShort

popShort

addByte

pushByte

popByte

addBuffer

pushBuffer

addBytes

pushBytes

popBytes

addFrames

addFrames

pushFrames

pushFrames

isMissing

isEmpty

size

iterator

dump

toString