Class MapMessageTestImpl

java.lang.Object
com.sun.ts.tests.jms.common.MessageTestImpl
com.sun.ts.tests.jms.common.MapMessageTestImpl
All Implemented Interfaces:
jakarta.jms.MapMessage, jakarta.jms.Message

public class MapMessageTestImpl extends MessageTestImpl implements jakarta.jms.MapMessage
Class Declaration.
  • Constructor Details

    • MapMessageTestImpl

      public MapMessageTestImpl()
      Class Constructor.
  • Method Details

    • getBoolean

      public boolean getBoolean(String name) throws jakarta.jms.JMSException
      Return the boolean value with the given name.
      Specified by:
      getBoolean in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the boolean
      Returns:
      the boolean value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getByte

      public byte getByte(String name) throws jakarta.jms.JMSException
      Return the byte value with the given name.
      Specified by:
      getByte in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the byte
      Returns:
      the byte value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getShort

      public short getShort(String name) throws jakarta.jms.JMSException
      Return the short value with the given name.
      Specified by:
      getShort in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the short
      Returns:
      the short value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getChar

      public char getChar(String name) throws jakarta.jms.JMSException
      Return the Unicode character value with the given name.
      Specified by:
      getChar in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the Unicode character
      Returns:
      the Unicode character value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getInt

      public int getInt(String name) throws jakarta.jms.JMSException
      Return the integer value with the given name.
      Specified by:
      getInt in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the integer
      Returns:
      the integer value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getLong

      public long getLong(String name) throws jakarta.jms.JMSException
      Return the long value with the given name.
      Specified by:
      getLong in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the long
      Returns:
      the long value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getFloat

      public float getFloat(String name) throws jakarta.jms.JMSException
      Return the float value with the given name.
      Specified by:
      getFloat in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the float
      Returns:
      the float value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getDouble

      public double getDouble(String name) throws jakarta.jms.JMSException
      Return the double value with the given name.
      Specified by:
      getDouble in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the double
      Returns:
      the double value with the given name.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getString

      public String getString(String name) throws jakarta.jms.JMSException
      Return the String value with the given name.
      Specified by:
      getString in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the String
      Returns:
      the String value with the given name. If there is no item by this name, a null value is returned.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getBytes

      public byte[] getBytes(String name) throws jakarta.jms.JMSException
      Return the byte array value with the given name.
      Specified by:
      getBytes in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the byte array
      Returns:
      the byte array value with the given name. If there is no item by this name, a null value is returned.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if this type conversion is invalid.
    • getObject

      public Object getObject(String name) throws jakarta.jms.JMSException
      Return the Java object value with the given name. Note that this method can be used to return in objectified format, an object that had been stored in the Map with the equivalent setObject method call, or it's equivalent primitive set method.
      Specified by:
      getObject in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the Java object
      Returns:
      the Java object value with the given name, in objectified format (ie. if it set as an int, then a Integer is returned). If there is no item by this name, a null value is returned.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
    • getMapNames

      public Enumeration getMapNames() throws jakarta.jms.JMSException
      Return an Enumeration of all the Map message's names.
      Specified by:
      getMapNames in interface jakarta.jms.MapMessage
      Returns:
      an enumeration of all the names in this Map message.
      Throws:
      jakarta.jms.JMSException - if JMS fails to read message due to some internal JMS error.
    • setBoolean

      public void setBoolean(String name, boolean value) throws jakarta.jms.JMSException
      Set a boolean value with the given name, into the Map.
      Specified by:
      setBoolean in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the boolean
      value - the boolean value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setByte

      public void setByte(String name, byte value) throws jakarta.jms.JMSException
      Set a byte value with the given name, into the Map.
      Specified by:
      setByte in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the byte
      value - the byte value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setShort

      public void setShort(String name, short value) throws jakarta.jms.JMSException
      Set a short value with the given name, into the Map.
      Specified by:
      setShort in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the short
      value - the short value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setChar

      public void setChar(String name, char value) throws jakarta.jms.JMSException
      Set a Unicode character value with the given name, into the Map.
      Specified by:
      setChar in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the Unicode character
      value - the Unicode character value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setInt

      public void setInt(String name, int value) throws jakarta.jms.JMSException
      Set an integer value with the given name, into the Map.
      Specified by:
      setInt in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the integer
      value - the integer value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setLong

      public void setLong(String name, long value) throws jakarta.jms.JMSException
      Set a long value with the given name, into the Map.
      Specified by:
      setLong in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the long
      value - the long value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setFloat

      public void setFloat(String name, float value) throws jakarta.jms.JMSException
      Set a float value with the given name, into the Map.
      Specified by:
      setFloat in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the float
      value - the float value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setDouble

      public void setDouble(String name, double value) throws jakarta.jms.JMSException
      Set a double value with the given name, into the Map.
      Specified by:
      setDouble in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the double
      value - the double value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setString

      public void setString(String name, String value) throws jakarta.jms.JMSException
      Set a String value with the given name, into the Map.
      Specified by:
      setString in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the String
      value - the String value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setBytes

      public void setBytes(String name, byte[] value) throws jakarta.jms.JMSException
      Set a byte array value with the given name, into the Map.
      Specified by:
      setBytes in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the byte array
      value - the byte array value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setBytes

      public void setBytes(String name, byte[] value, int offset, int length) throws jakarta.jms.JMSException
      Set a portion of the byte array value with the given name, into the Map.
      Specified by:
      setBytes in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the byte array
      value - the byte array value to set in the Map.
      offset - the initial offset within the byte array.
      length - the number of bytes to use.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • setObject

      public void setObject(String name, Object value) throws jakarta.jms.JMSException
      Set a Java object value with the given name, into the Map. Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.
      Specified by:
      setObject in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the Java object
      value - the Java object value to set in the Map.
      Throws:
      jakarta.jms.JMSException - if JMS fails to write message due to some internal JMS error.
      jakarta.jms.MessageFormatException - if object is invalid
      jakarta.jms.MessageNotWriteableException - if message in read-only mode.
    • itemExists

      public boolean itemExists(String name) throws jakarta.jms.JMSException
      Check if an item exists in this MapMessage.
      Specified by:
      itemExists in interface jakarta.jms.MapMessage
      Parameters:
      name - the name of the item to test
      Returns:
      true if the item does exist.
      Throws:
      jakarta.jms.JMSException - if a JMS error occurs.