Spec-Zone .ru спецификации, руководства, описания, API

javax.jms
Интерфейс BytesMessage

Все Суперинтерфейсы:

Сообщение

public interface BytesMessage
расширяет сообщение

A BytesMessage объект используется, чтобы отправить сообщение, содержащее поток неинтерпретируемых байтов. Это наследовалось от Message взаимодействуйте через интерфейс и добавляет текст сообщения байтов. Получатель сообщения предоставляет интерпретацию байтов.

BytesMessage методы базируются в значительной степени на найденных в java.io.DataInputStream и java.io.DataOutputStream.

Этот тип сообщения для клиентского кодирования существующих форматов сообщения. Если возможный, один из других типов сообщения самоопределения должен использоваться вместо этого.

Хотя API JMS позволяет использование свойств сообщения с сообщениями байта, они обычно не используются, так как включение свойств может влиять на формат.

Типы примитивов могут быть записаны, явно используя методы для каждого типа. Они могут также быть записаны в общем как объекты. Например, звонок BytesMessage.writeInt(6) эквивалентно BytesMessage.writeObject(new Integer(6)). Обе формы обеспечиваются, потому что явная форма удобна для статического программирования, и объектная форма необходима, когда типы не известны во время компиляции.

Когда сообщение сначала создается, и когда clearBody вызывается, тело сообщения находится в режиме только для записи. После первого звонка reset был сделан, текст сообщения находится в режиме только для чтения. После того, как сообщение было отправлено, клиент, который передался, оно может сохранить и изменить это, не влияя на сообщение, которое было отправлено. Тот же самый объект сообщения может быть отправлен многократно. Когда сообщение было получено, провайдер вызвал reset так, чтобы текст сообщения был в режиме только для чтения для клиента.

Если clearBody вызывается на сообщении в режиме только для чтения, текст сообщения очищается, и сообщение находится в режиме только для записи.

Если клиент пытается считать сообщение в режиме только для записи, a MessageNotReadableException бросается.

Если клиент пытается записать сообщение в режиме только для чтения, a MessageNotWriteableException бросается.

См. Также:

Session.createBytesMessage(), MapMessage, Message, ObjectMessage, StreamMessage, TextMessage

Полевая Сводка

Поля, наследованные от интерфейса javax.jms. Сообщение

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Сводка метода

long	getBodyLength() Получает число байтов текста сообщения, когда сообщение находится в режиме только для чтения.
boolean	readBoolean() Чтения a boolean от байтов передают поток.
byte	readByte() Читает подписанное 8-разрядное значение от байтов передают поток.
int	readBytes(byte[] value) Читает байтовый массив от байтов передают поток.
int	readBytes(byte[] value, int length) Читает часть байтов передают поток.
char	readChar() Читает значение символа Unicode от байтов передают поток.
double	readDouble() Чтения a double от байтов передают поток.
float	readFloat() Чтения a float от байтов передают поток.
int	readInt() Читает подписанное 32-разрядное целое число от байтов передают поток.
long	readLong() Читает подписанное 64-разрядное целое число от байтов передают поток.
short	readShort() Читает подписанное 16-разрядное число от байтов передают поток.
int	readUnsignedByte() Читает 8-разрядное число без знака от байтов передают поток.
int	readUnsignedShort() Читает 16-разрядное число без знака от байтов передают поток.
java.lang.String	readUTF() Читает строку, которая была закодирована, используя измененный формат UTF-8 от потока сообщения байтов.
void	reset() Помещает текст сообщения в режим только для чтения и репозиции поток байтов к началу.
void	writeBoolean(boolean value) Записи a boolean к байтам передают поток как 1-байтовое значение.
void	writeByte(byte value) Записи a byte к байтам передают поток как 1-байтовое значение.
void	writeBytes(byte[] value) Пишет, что байтовый массив к байтам передает поток.
void	writeBytes(byte[] value, int offset, int length) Пишет, что часть байтового массива к байтам передает поток.
void	writeChar(char value) Записи a char к байтам передают поток как 2-байтовое значение, высокий байт сначала.
void	writeDouble(double value) Преобразовывает double параметр a long использование doubleToLongBits метод в class Double, и затем записи это long оцените потоку сообщения байтов как 8-байтовое количество, высокий байт сначала.
void	writeFloat(float value) Преобразовывает float параметр int использование floatToIntBits метод в class Float, и затем записи это int оцените потоку сообщения байтов как 4-байтовое количество, высокий байт сначала.
void	writeInt(int value) Записи int к байтам передают поток как четыре байта, высокий байт сначала.
void	writeLong(long value) Записи a long к байтам передают поток как восемь байтов, высокий байт сначала.
void	writeObject(java.lang.Object value) Пишет, что объект к байтам передает поток.
void	writeShort(short value) Записи a short к байтам передают поток как два байта, высокий байт сначала.
void	writeUTF(java.lang.String value) Пишет, что строка к байтам передает поток, используя UTF-8, кодирующий машинно-независимым способом.

Методы, наследованные от интерфейса javax.jms. Сообщение

acknowledge, clearBody, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Деталь метода

getBodyLength

long getBodyLength()
                   throws JMSException

Получает число байтов текста сообщения, когда сообщение находится в режиме только для чтения. Возвращенное значение может использоваться, чтобы выделить байтовый массив. Возвращенное значение является всей длиной текста сообщения, независимо от того, где указатель для того, чтобы считать сообщение в настоящий момент располагается.

Возвраты:

число байтов в сообщении

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageNotReadableException - если сообщение находится в режиме только для записи.

С тех пор:

1.1

readBoolean

boolean readBoolean()
                    throws JMSException

Чтения a boolean от байтов передают поток.

Возвраты:

boolean значение читало

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readByte

byte readByte()
              throws JMSException

Читает подписанное 8-разрядное значение от байтов передают поток.

Возвраты:

следующий байт от байтов передает поток как подписанное 8-разрядное byte

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readUnsignedByte

int readUnsignedByte()
                     throws JMSException

Читает 8-разрядное число без знака от байтов передают поток.

Возвраты:

следующий байт от байтов передает поток, интерпретируемый как 8-разрядное число без знака

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readShort

short readShort()
                throws JMSException

Читает подписанное 16-разрядное число от байтов передают поток.

Возвраты:

следующие два байта от байтов передают поток, интерпретируемый как подписанное 16-разрядное число

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readUnsignedShort

int readUnsignedShort()
                      throws JMSException

Читает 16-разрядное число без знака от байтов передают поток.

Возвраты:

следующие два байта от байтов передают поток, интерпретируемый как 16-разрядное целое число без знака

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readChar

char readChar()
              throws JMSException

Читает значение символа Unicode от байтов передают поток.

Возвраты:

следующие два байта от байтов передают поток как символ Unicode

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readInt

int readInt()
            throws JMSException

Читает подписанное 32-разрядное целое число от байтов передают поток.

Возвраты:

следующие четыре байта от байтов передают поток, интерпретируемый как int

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readLong

long readLong()
              throws JMSException

Читает подписанное 64-разрядное целое число от байтов передают поток.

Возвраты:

следующие восемь байтов от байтов передают поток, интерпретируемый как a long

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readFloat

float readFloat()
                throws JMSException

Чтения a float от байтов передают поток.

Возвраты:

следующие четыре байта от байтов передают поток, интерпретируемый как a float

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readDouble

double readDouble()
                  throws JMSException

Чтения a double от байтов передают поток.

Возвраты:

следующие восемь байтов от байтов передают поток, интерпретируемый как a double

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readUTF

java.lang.String readUTF()
                         throws JMSException

Читает строку, которая была закодирована, используя измененный формат UTF-8 от потока сообщения байтов.

Для получения дополнительной информации по формату UTF-8 см. "Файловую систему Безопасный Формат Преобразования UCS (FSS_UTF)", Предварительная Спецификация X/Open, X/Open Company Ltd., Номер документа: P316. Эта информация также появляется в ISO/IEC 10646, Приложении P.

Возвраты:

строка Unicode от байтов передает поток

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageEOFException - если неожиданный конец потока байтов был достигнут.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readBytes

int readBytes(byte[] value)
              throws JMSException

Читает байтовый массив от байтов передают поток.

Если длина массива value меньше чем число байтов, остающихся быть считанными из потока, массив должен быть переполнен. Последующий вызов читает следующий инкремент и так далее.

Если число байтов, остающихся в потоке, является меньше чем длина массива value, байты должны быть считаны в массив. Возвращаемое значение общего количества чтения байтов будет меньше чем длина массива, указывая, что нет больше байтов, оставленных быть считанным из потока. Следующее чтение потока возвращается-1.

Параметры:

value - буфер, в который читаются данные

Возвраты:

общее количество чтения байтов в буфер, или-1, если нет больше данных, потому что конец потока был достигнут

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageNotReadableException - если сообщение находится в режиме только для записи.

readBytes

int readBytes(byte[] value,
              int length)
              throws JMSException

Читает часть байтов передают поток.

Если длина массива value меньше чем число байтов, остающихся быть считанными из потока, массив должен быть переполнен. Последующий вызов читает следующий инкремент и так далее.

Если число байтов, остающихся в потоке, является меньше чем длина массива value, байты должны быть считаны в массив. Возвращаемое значение общего количества чтения байтов будет меньше чем длина массива, указывая, что нет больше байтов, оставленных быть считанным из потока. Следующее чтение потока возвращается-1.

Если length отрицательно, или length больше чем длина массива value, тогда IndexOutOfBoundsException бросается. Никакие байты не будут считаны из потока для этого случая исключения.

Параметры:

value - буфер, в который читаются данные

length - число байтов, чтобы читать; должно быть меньше чем или равным value.length

Возвраты:

общее количество чтения байтов в буфер, или-1, если нет больше данных, потому что конец потока был достигнут

Броски:

JMSException - если провайдер JMS не в состоянии считать сообщение из-за некоторой внутренней ошибки.

MessageNotReadableException - если сообщение находится в режиме только для записи.

writeBoolean

void writeBoolean(boolean value)
                  throws JMSException

Записи a boolean к байтам передают поток как 1-байтовое значение. Значение true пишется как значение (byte)1; значение false пишется как значение (byte)0.

Параметры:

value - boolean значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeByte

void writeByte(byte value)
               throws JMSException

Записи a byte к байтам передают поток как 1-байтовое значение.

Параметры:

value - byte значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeShort

void writeShort(short value)
                throws JMSException

Записи a short к байтам передают поток как два байта, высокий байт сначала.

Параметры:

value - short быть записанным

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeChar

void writeChar(char value)
               throws JMSException

Записи a char к байтам передают поток как 2-байтовое значение, высокий байт сначала.

Параметры:

value - char значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeInt

void writeInt(int value)
              throws JMSException

Записи int к байтам передают поток как четыре байта, высокий байт сначала.

Параметры:

value - int быть записанным

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeLong

void writeLong(long value)
               throws JMSException

Записи a long к байтам передают поток как восемь байтов, высокий байт сначала.

Параметры:

value - long быть записанным

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeFloat

void writeFloat(float value)
                throws JMSException

Преобразовывает float параметр int использование floatToIntBits метод в class Float, и затем записи это int оцените потоку сообщения байтов как 4-байтовое количество, высокий байт сначала.

Параметры:

value - float значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeDouble

void writeDouble(double value)
                 throws JMSException

Преобразовывает double параметр a long использование doubleToLongBits метод в class Double, и затем записи это long оцените потоку сообщения байтов как 8-байтовое количество, высокий байт сначала.

Параметры:

value - double значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeUTF

void writeUTF(java.lang.String value)
              throws JMSException

Пишет, что строка к байтам передает поток, используя UTF-8, кодирующий машинно-независимым способом.

Для получения дополнительной информации по формату UTF-8 см. "Файловую систему Безопасный Формат Преобразования UCS (FSS_UTF)", Предварительная Спецификация X/Open, X/Open Company Ltd., Номер документа: P316. Эта информация также появляется в ISO/IEC 10646, Приложении P.

Параметры:

value - String значение, которое будет записано

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeBytes

void writeBytes(byte[] value)
                throws JMSException

Пишет, что байтовый массив к байтам передает поток.

Параметры:

value - байтовый массив, который будет записан

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeBytes

void writeBytes(byte[] value,
                int offset,
                int length)
                throws JMSException

Пишет, что часть байтового массива к байтам передает поток.

Параметры:

value - значение байтового массива, которое будет записано

offset - начальное смещение в пределах байтового массива

length - число байтов, чтобы использовать

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

writeObject

void writeObject(java.lang.Object value)
                 throws JMSException

Пишет, что объект к байтам передает поток.

Этот метод работает только на воплощенные примитивные объектные типы (Integer, Double, Long ...), String объекты, и байтовые массивы.

Параметры:

value - объект в языке программирования Java ("Java возражают") быть записанным; это не должен быть нуль

Броски:

JMSException - если провайдер JMS не в состоянии записать сообщение из-за некоторой внутренней ошибки.

MessageFormatException - если объект имеет недопустимый тип.

MessageNotWriteableException - если сообщение находится в режиме только для чтения.

java.lang.NullPointerException - если параметр value нуль.

сброс

void reset()
           throws JMSException

Помещает текст сообщения в режим только для чтения и репозиции поток байтов к началу.

Броски:

JMSException - если провайдер JMS не в состоянии сбросить сообщение из-за некоторой внутренней ошибки.

MessageFormatException - если у сообщения есть недопустимый формат.