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

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

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

Сообщение

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

A MapMessage объект используется, чтобы отправить ряд пар значение-имя. Имена String объекты, и значения являются примитивными типами данных в языке программирования Java. У имен должно быть значение, которое не является нулем, и не пустой строкой. К записям можно получить доступ последовательно или в произвольном порядке по имени. Порядок записей неопределен. MapMessage наследовался от Message взаимодействуйте через интерфейс и добавляет текст сообщения, который содержит Карту.

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

Когда клиент получает a MapMessage, это находится в режиме только для чтения. Если клиент пытается записать в сообщение в этой точке, a MessageNotWriteableException бросается. Если clearBody вызывается, сообщение может теперь быть и считано из и записано.

MapMessage объекты поддерживают следующую таблицу преобразования. Отмеченные случаи должны поддерживаться. Неотмеченные случаи должны бросить a JMSException. String- к-примитивному преобразования могут бросить исключение на этапе выполнения если примитив valueOf() метод не принимает это как допустимое String представление примитива.

Значение, записанное как тип строки, может быть считано как тип столбца.

 |        | boolean byte short char int long float double String byte[]
 |----------------------------------------------------------------------
 |boolean |    X                                            X
 |byte    |          X     X         X   X                  X
 |short   |                X         X   X                  X
 |char    |                     X                           X
 |int     |                          X   X                  X
 |long    |                              X                  X
 |float   |                                    X     X      X
 |double  |                                          X      X
 |String  |    X     X     X         X   X     X     X      X
 |byte[]  |                                                        X
 |----------------------------------------------------------------------
 

Пытаясь считать нулевое значение, поскольку тип примитива должен быть обработан как вызов соответствия примитива valueOf(String) метод преобразования с нулевым значением. С тех пор char не поддерживает a String преобразование, пытаясь считать нулевое значение как a char должен бросить a NullPointerException.

См. Также:

Session.createMapMessage(), BytesMessage, Message, ObjectMessage, StreamMessage, TextMessage

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

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

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

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

boolean	getBoolean(java.lang.String name) Возвраты boolean значение с указанным именем.
byte	getByte(java.lang.String name) Возвраты byte значение с указанным именем.
byte[]	getBytes(java.lang.String name) Возвращает значение байтового массива с указанным именем.
char	getChar(java.lang.String name) Возвращает значение символа Unicode с указанным именем.
double	getDouble(java.lang.String name) Возвраты double значение с указанным именем.
float	getFloat(java.lang.String name) Возвраты float значение с указанным именем.
int	getInt(java.lang.String name) Возвраты int значение с указанным именем.
long	getLong(java.lang.String name) Возвраты long значение с указанным именем.
java.util.Enumeration	getMapNames() Возвраты Enumeration из всех имен в MapMessage объект.
java.lang.Object	getObject(java.lang.String name) Возвращает значение объекта с указанным именем.
short	getShort(java.lang.String name) Возвраты short значение с указанным именем.
java.lang.String	getString(java.lang.String name) Возвраты String значение с указанным именем.
boolean	itemExists(java.lang.String name) Указывает, существует ли элемент в этом MapMessage объект.
void	setBoolean(java.lang.String name, boolean value) Наборы a boolean значение с указанным именем в Карту.
void	setByte(java.lang.String name, byte value) Наборы a byte значение с указанным именем в Карту.
void	setBytes(java.lang.String name, byte[] value) Устанавливает значение байтового массива с указанным именем в Карту.
void	setBytes(java.lang.String name, byte[] value, int offset, int length) Устанавливает часть значения байтового массива с указанным именем в Карту.
void	setChar(java.lang.String name, char value) Устанавливает значение символа Unicode с указанным именем в Карту.
void	setDouble(java.lang.String name, double value) Наборы a double значение с указанным именем в Карту.
void	setFloat(java.lang.String name, float value) Наборы a float значение с указанным именем в Карту.
void	setInt(java.lang.String name, int value) Наборы int значение с указанным именем в Карту.
void	setLong(java.lang.String name, long value) Наборы a long значение с указанным именем в Карту.
void	setObject(java.lang.String name, java.lang.Object value) Устанавливает объектное значение с указанным именем в Карту.
void	setShort(java.lang.String name, short value) Наборы a short значение с указанным именем в Карту.
void	setString(java.lang.String name, java.lang.String value) Наборы a String значение с указанным именем в Карту.

Методы, наследованные от интерфейса 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

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

getBoolean

boolean getBoolean(java.lang.String name)
                   throws JMSException

Возвраты boolean значение с указанным именем.

Параметры:

name - имя boolean

Возвраты:

boolean значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getByte

byte getByte(java.lang.String name)
             throws JMSException

Возвраты byte значение с указанным именем.

Параметры:

name - имя byte

Возвраты:

byte значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getShort

short getShort(java.lang.String name)
               throws JMSException

Возвраты short значение с указанным именем.

Параметры:

name - имя short

Возвраты:

short значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getChar

char getChar(java.lang.String name)
             throws JMSException

Возвращает значение символа Unicode с указанным именем.

Параметры:

name - имя символа Unicode

Возвраты:

значение символа Unicode с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getInt

int getInt(java.lang.String name)
           throws JMSException

Возвраты int значение с указанным именем.

Параметры:

name - имя int

Возвраты:

int значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getLong

long getLong(java.lang.String name)
             throws JMSException

Возвраты long значение с указанным именем.

Параметры:

name - имя long

Возвраты:

long значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getFloat

float getFloat(java.lang.String name)
               throws JMSException

Возвраты float значение с указанным именем.

Параметры:

name - имя float

Возвраты:

float значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getDouble

double getDouble(java.lang.String name)
                 throws JMSException

Возвраты double значение с указанным именем.

Параметры:

name - имя double

Возвраты:

double значение с указанным именем

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getString

java.lang.String getString(java.lang.String name)
                           throws JMSException

Возвраты String значение с указанным именем.

Параметры:

name - имя String

Возвраты:

String значение с указанным именем; если нет никакого элемента этим именем, нулевое значение возвращается

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getBytes

byte[] getBytes(java.lang.String name)
                throws JMSException

Возвращает значение байтового массива с указанным именем.

Параметры:

name - имя байтового массива

Возвраты:

копия байтового массива оценивает с указанным именем; если нет никакого элемента этим именем, нулевое значение возвращается.

Броски:

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

MessageFormatException - если это преобразование типов недопустимо.

getObject

java.lang.Object getObject(java.lang.String name)
                           throws JMSException

Возвращает значение объекта с указанным именем.

Этот метод может использоваться, чтобы возвратиться, в воплощенном формате, объекте в языке программирования Java ("объект Java"), который был сохранен в Карте с эквивалентом setObject вызов метода, или его эквивалентный примитив settype метод.

Отметьте, что значения байта возвращаются как byte[], нет Byte[].

Параметры:

name - имя объекта Java

Возвраты:

копия Java возражает значению с указанным именем в воплощенном формате (например, если объект был установлен как int, Integer возвращается); если нет никакого элемента этим именем, нулевое значение возвращается

Броски:

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

getMapNames

java.util.Enumeration getMapNames()
                                  throws JMSException

Возвраты Enumeration из всех имен в MapMessage объект.

Возвраты:

перечисление всех имен в этом MapMessage

Броски:

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

setBoolean

void setBoolean(java.lang.String name,
                boolean value)
                throws JMSException

Наборы a boolean значение с указанным именем в Карту.

Параметры:

name - имя boolean

value - boolean значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setByte

void setByte(java.lang.String name,
             byte value)
             throws JMSException

Наборы a byte значение с указанным именем в Карту.

Параметры:

name - имя byte

value - byte значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setShort

void setShort(java.lang.String name,
              short value)
              throws JMSException

Наборы a short значение с указанным именем в Карту.

Параметры:

name - имя short

value - short значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setChar

void setChar(java.lang.String name,
             char value)
             throws JMSException

Устанавливает значение символа Unicode с указанным именем в Карту.

Параметры:

name - имя символа Unicode

value - значение символа Unicode, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setInt

void setInt(java.lang.String name,
            int value)
            throws JMSException

Наборы int значение с указанным именем в Карту.

Параметры:

name - имя int

value - int значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setLong

void setLong(java.lang.String name,
             long value)
             throws JMSException

Наборы a long значение с указанным именем в Карту.

Параметры:

name - имя long

value - long значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setFloat

void setFloat(java.lang.String name,
              float value)
              throws JMSException

Наборы a float значение с указанным именем в Карту.

Параметры:

name - имя float

value - float значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setDouble

void setDouble(java.lang.String name,
               double value)
               throws JMSException

Наборы a double значение с указанным именем в Карту.

Параметры:

name - имя double

value - double значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setString

void setString(java.lang.String name,
               java.lang.String value)
               throws JMSException

Наборы a String значение с указанным именем в Карту.

Параметры:

name - имя String

value - String значение, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setBytes

void setBytes(java.lang.String name,
              byte[] value)
              throws JMSException

Устанавливает значение байтового массива с указанным именем в Карту.

Параметры:

name - имя байтового массива

value - значение байтового массива, чтобы установить в Карте; массив копируется так, чтобы значение для name не будет изменен будущими модификациями

Броски:

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

java.lang.NullPointerException - если имя является нулем, или если имя является пустой строкой.

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

setBytes

void setBytes(java.lang.String name,
              byte[] value,
              int offset,
              int length)
              throws JMSException

Устанавливает часть значения байтового массива с указанным именем в Карту.

Параметры:

name - имя байтового массива

value - значение байтового массива, чтобы установить в Карте

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

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

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

setObject

void setObject(java.lang.String name,
               java.lang.Object value)
               throws JMSException

Устанавливает объектное значение с указанным именем в Карту.

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

Параметры:

name - имя объекта Java

value - значение объекта Java, чтобы установить в Карте

Броски:

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

IllegalArgumentException - если имя является нулем или если имя является пустой строкой.

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

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

itemExists

boolean itemExists(java.lang.String name)
                   throws JMSException

Указывает, существует ли элемент в этом MapMessage объект.

Параметры:

name - имя элемента, чтобы протестировать

Возвраты:

истина, если элемент существует

Броски:

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