com.ibm.mq.jms

Class MQRoot

  • java.lang.Object
    • com.ibm.mq.jms.MQRoot

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K,V>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void clear()
      Clears all properties
      boolean containsKey(java.lang.Object key)
      Ascertains whether the specified key exists in the properties map
      boolean containsValue(java.lang.Object value)
      Ascertains whether the specified value exists in the properties map
      java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
      The entry set of the properties map
      boolean equals(java.lang.Object o) 
      java.lang.Object get(java.lang.Object key)
      Gets the property associated with the specified key
      boolean getBooleanProperty(java.lang.String name)
      Gets the boolean property value with the given name.
      byte getByteProperty(java.lang.String name)
      Gets the byte property value with the given name.
      byte[] getBytesProperty(java.lang.String name)
      Gets the bytes property value with the given name.
      char getCharProperty(java.lang.String name)
      Gets the char property value with the given name.
      double getDoubleProperty(java.lang.String name)
      Gets the double property value with the given name.
      float getFloatProperty(java.lang.String name)
      Gets the float property value with the given name.
      int getIntProperty(java.lang.String name)
      Gets the int property value with the given name.
      long getLongProperty(java.lang.String name)
      Gets the long property value with the given name.
      java.lang.Object getObjectProperty(java.lang.String name)
      Gets the Object property value with the given name.
      java.util.Enumeration<java.lang.String> getPropertyNames()
      Gets all properties which have been set on a resource.
      short getShortProperty(java.lang.String name)
      Gets the short property value with the given name.
      java.lang.String getStringProperty(java.lang.String name)
      Gets the String property value with the given name.
      int hashCode() 
      boolean isEmpty()
      Indicates whether the properties map is empty
      java.util.Set<java.lang.String> keySet()
      Gets a Set of the property keys in the property map
      boolean propertyExists(java.lang.String name)
      Indicates whether a named property exists.
      java.lang.Object put(java.lang.String key, java.lang.Object value)
      Adds the specified key and value to the properties map
      void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> properties)
      Adds the properties in the specified map to the properties map
      java.lang.Object remove(java.lang.Object key)
      Removes the property associated with the specified key from the properties map.
      void setBatchProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
      Sets multiple property values passed in via a HashMap.
      void setBooleanProperty(java.lang.String name, boolean value)
      Sets a Boolean property value with the given name.
      void setByteProperty(java.lang.String name, byte value)
      Sets a byte property value with the given name.
      void setBytesProperty(java.lang.String name, byte[] value)
      Sets a bytes property value with the given name.
      void setCharProperty(java.lang.String name, char value)
      Sets a char property value with the given name.
      void setDoubleProperty(java.lang.String name, double value)
      Sets a double property value with the given name.
      void setFloatProperty(java.lang.String name, float value)
      Sets a float property value with the given name.
      void setIntProperty(java.lang.String name, int value)
      Sets an int property value with the given name.
      void setLongProperty(java.lang.String name, long value)
      Sets a long property value with the given name.
      void setObjectProperty(java.lang.String name, java.lang.Object value)
      Sets an Object property value with the given name.
      void setShortProperty(java.lang.String name, short value)
      Sets a short property value with the given name.
      void setStringProperty(java.lang.String name, java.lang.String value)
      Sets a String property value with the given name.
      int size()
      Gets the number of properties in the properties map.
      java.util.Collection<java.lang.Object> values()
      Gets the values of properties in the properties map.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Method Detail

      • setBatchProperties

        public void setBatchProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
                        throws javax.jms.JMSException
        Sets multiple property values passed in via a HashMap.
        Specified by:
        setBatchProperties in interface JmsPropertyContext
        Parameters:
        properties - the HashMap of properties.
        Throws:
        javax.jms.JMSException - if any property is marked read-only or if the proposed value is invalid for any property.

      • setBooleanProperty

        public void setBooleanProperty(java.lang.String name,
                               boolean value)
                        throws javax.jms.JMSException
        Sets a Boolean property value with the given name.
        Specified by:
        setBooleanProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the Boolean property.
        value - the Boolean property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setByteProperty

        public void setByteProperty(java.lang.String name,
                            byte value)
                     throws javax.jms.JMSException
        Sets a byte property value with the given name.
        Specified by:
        setByteProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the byte property.
        value - the byte property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setBytesProperty

        public void setBytesProperty(java.lang.String name,
                             byte[] value)
                      throws javax.jms.JMSException
        Sets a bytes property value with the given name.
        Specified by:
        setBytesProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the bytes property.
        value - the bytes property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setCharProperty

        public void setCharProperty(java.lang.String name,
                            char value)
                     throws javax.jms.JMSException
        Sets a char property value with the given name.
        Specified by:
        setCharProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the char property.
        value - the char property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setDoubleProperty

        public void setDoubleProperty(java.lang.String name,
                              double value)
                       throws javax.jms.JMSException
        Sets a double property value with the given name.
        Specified by:
        setDoubleProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the double property.
        value - the double property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setFloatProperty

        public void setFloatProperty(java.lang.String name,
                             float value)
                      throws javax.jms.JMSException
        Sets a float property value with the given name.
        Specified by:
        setFloatProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the float property.
        value - the float property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setIntProperty

        public void setIntProperty(java.lang.String name,
                           int value)
                    throws javax.jms.JMSException
        Sets an int property value with the given name.
        Specified by:
        setIntProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the int property.
        value - the int property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setLongProperty

        public void setLongProperty(java.lang.String name,
                            long value)
                     throws javax.jms.JMSException
        Sets a long property value with the given name.
        Specified by:
        setLongProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the long property.
        value - the long property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setObjectProperty

        public void setObjectProperty(java.lang.String name,
                              java.lang.Object value)
                       throws javax.jms.JMSException
        Sets an Object property value with the given name.
        Specified by:
        setObjectProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the Object property.
        value - the Object property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setShortProperty

        public void setShortProperty(java.lang.String name,
                             short value)
                      throws javax.jms.JMSException
        Sets a short property value with the given name.
        Specified by:
        setShortProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the short property.
        value - the short property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • setStringProperty

        public void setStringProperty(java.lang.String name,
                              java.lang.String value)
                       throws javax.jms.JMSException
        Sets a String property value with the given name.
        Specified by:
        setStringProperty in interface JmsPropertyContext
        Parameters:
        name - the name of the String property.
        value - the String property value to set.
        Throws:
        javax.jms.JMSException - if the property is marked read-only or if the proposed value is invalid for the property.

      • getBooleanProperty

        public boolean getBooleanProperty(java.lang.String name)
                           throws javax.jms.JMSException
        Gets the boolean property value with the given name.
        Specified by:
        getBooleanProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the boolean property value with the given name.
        Throws:
        javax.jms.JMSException

      • getByteProperty

        public byte getByteProperty(java.lang.String name)
                     throws javax.jms.JMSException
        Gets the byte property value with the given name.
        Specified by:
        getByteProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the byte property value with the given name.
        Throws:
        javax.jms.JMSException

      • getBytesProperty

        public byte[] getBytesProperty(java.lang.String name)
                        throws javax.jms.JMSException
        Gets the bytes property value with the given name.
        Specified by:
        getBytesProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the bytes property value with the given name.
        Throws:
        javax.jms.JMSException

      • getCharProperty

        public char getCharProperty(java.lang.String name)
                     throws javax.jms.JMSException
        Gets the char property value with the given name.
        Specified by:
        getCharProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the char property value with the given name.
        Throws:
        javax.jms.JMSException

      • getDoubleProperty

        public double getDoubleProperty(java.lang.String name)
                         throws javax.jms.JMSException
        Gets the double property value with the given name.
        Specified by:
        getDoubleProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the double property value with the given name.
        Throws:
        javax.jms.JMSException

      • getFloatProperty

        public float getFloatProperty(java.lang.String name)
                       throws javax.jms.JMSException
        Gets the float property value with the given name.
        Specified by:
        getFloatProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the float property value with the given name.
        Throws:
        javax.jms.JMSException

      • getIntProperty

        public int getIntProperty(java.lang.String name)
                   throws javax.jms.JMSException
        Gets the int property value with the given name.
        Specified by:
        getIntProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the int property value with the given name.
        Throws:
        javax.jms.JMSException

      • getLongProperty

        public long getLongProperty(java.lang.String name)
                     throws javax.jms.JMSException
        Gets the long property value with the given name.
        Specified by:
        getLongProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the long property value with the given name.
        Throws:
        javax.jms.JMSException

      • getObjectProperty

        public java.lang.Object getObjectProperty(java.lang.String name)
                                   throws javax.jms.JMSException
        Gets the Object property value with the given name.
        Specified by:
        getObjectProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the Object property value with the given name.
        Throws:
        javax.jms.JMSException

      • getPropertyNames

        public java.util.Enumeration<java.lang.String> getPropertyNames()
                                                         throws javax.jms.JMSException
        Gets all properties which have been set on a resource.
        Specified by:
        getPropertyNames in interface JmsReadablePropertyContext
        Returns:
        the Enumeration of all set properties.
        Throws:
        javax.jms.JMSException

      • getShortProperty

        public short getShortProperty(java.lang.String name)
                       throws javax.jms.JMSException
        Gets the short property value with the given name.
        Specified by:
        getShortProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the short property value with the given name.
        Throws:
        javax.jms.JMSException

      • getStringProperty

        public java.lang.String getStringProperty(java.lang.String name)
                                   throws javax.jms.JMSException
        Gets the String property value with the given name.
        Specified by:
        getStringProperty in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        the String property value with the given name.
        Throws:
        javax.jms.JMSException

      • propertyExists

        public boolean propertyExists(java.lang.String name)
                       throws javax.jms.JMSException
        Indicates whether a named property exists.
        Specified by:
        propertyExists in interface JmsReadablePropertyContext
        Parameters:
        name - the name of the property to be retrieved.
        Returns:
        true if the property exists, false if it does not.
        Throws:
        javax.jms.JMSException

      • clear

        public void clear()
        Clears all properties
        Specified by:
        clear in interface java.util.Map<java.lang.String,java.lang.Object>
        See Also:
        Map.clear()

      • containsKey

        public boolean containsKey(java.lang.Object key)
        Ascertains whether the specified key exists in the properties map
        Specified by:
        containsKey in interface java.util.Map<java.lang.String,java.lang.Object>
        Parameters:
        key - key to check
        Returns:
        boolean to indicate if the key exists
        See Also:
        Map.containsKey(java.lang.Object)

      • containsValue

        public boolean containsValue(java.lang.Object value)
        Ascertains whether the specified value exists in the properties map
        Specified by:
        containsValue in interface java.util.Map<java.lang.String,java.lang.Object>
        Parameters:
        value - value to check
        Returns:
        boolean to indicate if the value exists
        See Also:
        Map.containsKey(java.lang.Object)

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
        The entry set of the properties map
        Specified by:
        entrySet in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        the entry set
        See Also:
        Map.entrySet()

      • get

        public java.lang.Object get(java.lang.Object key)
        Gets the property associated with the specified key
        Specified by:
        get in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        the object
        See Also:
        Map.get(java.lang.Object)

      • isEmpty

        public boolean isEmpty()
        Indicates whether the properties map is empty
        Specified by:
        isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        true if the map is empty
        See Also:
        Map.isEmpty()

      • keySet

        public java.util.Set<java.lang.String> keySet()
        Gets a Set of the property keys in the property map
        Specified by:
        keySet in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        the Set of property keys
        See Also:
        Map.keySet()

      • put

        public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
        Adds the specified key and value to the properties map
        Specified by:
        put in interface java.util.Map<java.lang.String,java.lang.Object>
        Parameters:
        key - the key associated with the property
        value - the property value
        See Also:
        Map.put(java.lang.Object, java.lang.Object)

      • putAll

        public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> properties)
        Adds the properties in the specified map to the properties map
        Specified by:
        putAll in interface java.util.Map<java.lang.String,java.lang.Object>
        Parameters:
        properties - the map of properties to set
        See Also:
        Map.putAll(java.util.Map)

      • remove

        public java.lang.Object remove(java.lang.Object key)
        Removes the property associated with the specified key from the properties map.
        Specified by:
        remove in interface java.util.Map<java.lang.String,java.lang.Object>
        Parameters:
        key - the key associated with the property being removed
        See Also:
        Map.remove(java.lang.Object)

      • size

        public int size()
        Gets the number of properties in the properties map.
        Specified by:
        size in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        the number of properties
        See Also:
        Map.size()

      • values

        public java.util.Collection<java.lang.Object> values()
        Gets the values of properties in the properties map.
        Specified by:
        values in interface java.util.Map<java.lang.String,java.lang.Object>
        Returns:
        a collection of the property values
        See Also:
        Map.values()

      • equals

        public boolean equals(java.lang.Object o)
        Specified by:
        equals in interface java.util.Map<java.lang.String,java.lang.Object>
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map<java.lang.String,java.lang.Object>
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()
Skip navigation links
(c) Copyright IBM Corp. 2008, 2016. All Rights Reserved.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method