Message.Frame (jzmq-api 0.2.0-SNAPSHOT API)

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

Enclosing class:

Message
```
public static class Message.Frame
extends Object
```
Represents a single frame of data within a message. Instances of this class are immutable, except via the underlying ByteBuffer.

Constructor Summary

Constructors
Constructor and Description
`Frame(byte[] data)` Construct a frame with the given bytes.
`Frame(String data)` Construct a frame with the given String, using the configured `Charset`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`byte[]`	`getBlob()` Returns a byte array encoded into the buffer as an int and bytes.
`byte`	`getByte()` Returns the next `byte` of data from the buffer.
`byte[]`	`getBytes()` Returns a byte array encoded into the buffer as a byte and bytes.
`String`	`getChars()` Deprecated. Use `getString()` instead.
`String`	`getClob()` Returns a String value encoded into the buffer as a short and bytes using the default character set.
`List<String>`	`getClobs()` Returns a list String values encoded into the buffer as a short and a sequence of strings using the default character set.
`byte[]`	`getData()` Returns the data contained in this frame, as bytes.
`int`	`getInt()` Returns the next 4 bytes of data, as a `int`.
`long`	`getLong()` Returns the next 8 bytes of data, as a `long`.
`Map<String,String>`	`getMap()` Returns a list String values encoded into the buffer as an int and a sequence of pairs of strings using the default character set.
`short`	`getShort()` Returns the next 2 bytes of data, as a `short`.
`String`	`getString()` Returns a String value encoded into the buffer as a byte and bytes using the default character set.
`List<String>`	`getStrings()` Returns a list String values encoded into the buffer as a short and a sequence of strings using the default character set.
`int`	`hashCode()`
`boolean`	`isBlank()` Returns true if the buffer contains no data.
`static Message.Frame`	`of(byte value)` Create a frame containing a single `byte` value.
`static Message.Frame`	`of(byte[] value)` Create a frame containing a single `byte[]` value.
`static Message.Frame`	`of(ByteBuffer buffer)` Create a frame containing the given buffer.
`static Message.Frame`	`of(int value)` Create a frame containing a single `int` value.
`static Message.Frame`	`of(List<String> values)` Create a frame containing a single List of String values.
`static Message.Frame`	`of(long value)` Create a frame containing a single `long` value.
`static Message.Frame`	`of(Map<String,String> values)` Create a frame containing a single Map of String pairs.
`static Message.Frame`	`of(short value)` Create a frame containing a single `short` value.
`static Message.Frame`	`of(String value)` Create a frame containing a single String value.
`int`	`size()` Returns the size of the underlying byte array.
`String`	`toString()` Convert the data to a string using the configured `Charset`.

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

- Constructor Detail
  - Frame
```
public Frame(String data)
```
    Construct a frame with the given String, using the configured Charset.
    
    Parameters:
    
    data - The String data
    
    See Also:
    
    Message.CHARSET
  - Frame
```
public Frame(byte[] data)
```
    Construct a frame with the given bytes.
    
    Parameters:
    
    data - The data
- Method Detail
  - getData
```
public byte[] getData()
```
    Returns the data contained in this frame, as bytes.
    
    Returns:
    
    The frame's data
  - size
```
public int size()
```
    Returns the size of the underlying byte array.
    
    Returns:
    
    The frame's size
  - getString
```
public String getString()
```
    Returns a String value encoded into the buffer as a byte and bytes using the default character set.
    
    Returns:
    
    The frame, as a String
    
    See Also:
    
    Message.CHARSET
  - getByte
```
public byte getByte()
```
    Returns the next byte of data from the buffer.
    
    Returns:
    
    The next byte of data
  - getShort
```
public short getShort()
```
    Returns the next 2 bytes of data, as a short.
    
    Returns:
    
    The next 2 bytes, as a short
  - getInt
```
public int getInt()
```
    Returns the next 4 bytes of data, as a int.
    
    Returns:
    
    The next 4 bytes, as an int
  - getLong
```
public long getLong()
```
    Returns the next 8 bytes of data, as a long.
    
    Returns:
    
    The next 8 bytes, as a long
  - getBytes
```
public byte[] getBytes()
```
    Returns a byte array encoded into the buffer as a byte and bytes.
    
    Returns:
    
    A byte array
  - getChars
```
@Deprecated
public String getChars()
```
    Deprecated. Use getString() instead.
    
    Returns a String value encoded into the buffer as a byte and bytes using the default character set.
    
    Returns:
    
    A String value
  - getStrings
```
public List<String> getStrings()
```
    Returns a list String values encoded into the buffer as a short and a sequence of strings using the default character set.
    
    Returns:
    
    A list of strings
    
    See Also:
    
    getString()
  - getBlob
```
public byte[] getBlob()
```
    Returns a byte array encoded into the buffer as an int and bytes.
    
    Returns:
    
    A byte array
  - getClob
```
public String getClob()
```
    Returns a String value encoded into the buffer as a short and bytes using the default character set.
    
    Returns:
    
    A String value
  - getClobs
```
public List<String> getClobs()
```
    Returns a list String values encoded into the buffer as a short and a sequence of strings using the default character set.
    
    Returns:
    
    A list of strings
    
    See Also:
    
    getClob()
  - getMap
```
public Map<String,String> getMap()
```
    Returns a list String values encoded into the buffer as an int and a sequence of pairs of strings using the default character set.
    
    Returns:
    
    A list of strings
    
    See Also:
    
    getString(), getClob()
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Convert the data to a string using the configured Charset.
    
    Overrides:
    
    toString in class Object
  - isBlank
```
public boolean isBlank()
```
    Returns true if the buffer contains no data.
    
    Returns:
    
    true if the frame contains no data, false otherwise
  - of
```
public static Message.Frame of(byte value)
```
    Create a frame containing a single byte value.
    
    Parameters:
    
    value - The byte value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(short value)
```
    Create a frame containing a single short value.
    
    Parameters:
    
    value - The short value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(int value)
```
    Create a frame containing a single int value.
    
    Parameters:
    
    value - The int value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(long value)
```
    Create a frame containing a single long value.
    
    Parameters:
    
    value - The long value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(String value)
```
    Create a frame containing a single String value.
    
    Parameters:
    
    value - The String value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(byte[] value)
```
    Create a frame containing a single byte[] value.
    
    Parameters:
    
    value - The byte[] value
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(List<String> values)
```
    Create a frame containing a single List of String values.
    
    Parameters:
    
    values - The List of String values
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(Map<String,String> values)
```
    Create a frame containing a single Map of String pairs.
    
    Parameters:
    
    values - The Map of String pairs
    
    Returns:
    
    A new Frame
  - of
```
public static Message.Frame of(ByteBuffer buffer)
```
    Create a frame containing the given buffer.
    
    Parameters:
    
    buffer - The buffer
    
    Returns:
    
    A new Frame

Class Message.Frame

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Frame

Frame

Method Detail

getData

size

getString

getByte

getShort

getInt

getLong

getBytes

getChars

getStrings

getBlob

getClob

getClobs

getMap

equals

hashCode

toString

isBlank

of

of

of

of

of

of

of

of

of