com.ibm.mq.jms

Class MQRoot

  1. java.lang.Object
  2. extended bycom.ibm.mq.jms.MQRoot
All implemented interfaces:
JmsPropertyContext, JmsReadablePropertyContext, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
Direct known subclasses:
MQConnection, MQConnectionMetaData, MQMessageConsumer, MQMessageProducer, MQQueueBrowser, MQSession
  1. public abstract class MQRoot
  2. extends java.lang.Object
  3. implements JmsPropertyContext
This is a root object for all the objects in the package com.ibm.mq.jms; it provides a common point to implement the JmsPropertyContext interface. The IBM JMS Extensions are implemented by the concrete classes in com.ibm.mq.jms, therefore all objects need to implement the property context interface.
See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>

Method Summary

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

Method Detail

setBatchProperties

  1. public void setBatchProperties( java.util.Map properties)
  2. 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

  1. public void setBooleanProperty( java.lang.String name,
  2. boolean value)
  3. 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

  1. public void setByteProperty(java.lang.String name,
  2. byte value)
  3. 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

  1. public void setBytesProperty(java.lang.String name,
  2. byte[] value)
  3. 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

  1. public void setCharProperty(java.lang.String name,
  2. char value)
  3. 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

  1. public void setDoubleProperty(java.lang.String name,
  2. double value)
  3. 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

  1. public void setFloatProperty(java.lang.String name,
  2. float value)
  3. 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

  1. public void setIntProperty(java.lang.String name,
  2. int value)
  3. 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

  1. public void setLongProperty(java.lang.String name,
  2. long value)
  3. 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

  1. public void setObjectProperty(java.lang.String name,
  2. java.lang.Object value)
  3. 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

  1. public void setShortProperty(java.lang.String name,
  2. short value)
  3. 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

  1. public void setStringProperty(java.lang.String name,
  2. java.lang.String value)
  3. 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

  1. public boolean getBooleanProperty( java.lang.String name)
  2. 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

  1. public byte getByteProperty(java.lang.String name)
  2. 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

  1. public byte[] getBytesProperty( java.lang.String name)
  2. 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

  1. public char getCharProperty(java.lang.String name)
  2. 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

  1. public double getDoubleProperty( java.lang.String name)
  2. 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

  1. public float getFloatProperty(java.lang.String name)
  2. 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

  1. public int getIntProperty(java.lang.String name)
  2. 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

  1. public long getLongProperty(java.lang.String name)
  2. 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

  1. public java.lang.Object getObjectProperty( java.lang.String name)
  2. 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

  1. public java.util.Enumeration<?> getPropertyNames( )
  2. 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

  1. public short getShortProperty(java.lang.String name)
  2. 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

  1. public java.lang.String getStringProperty( java.lang.String name)
  2. 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

  1. public boolean propertyExists(java.lang.String name)
  2. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. public java.lang.Object put(java.lang.String key,
  2. 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

  1. public void putAll(java.util.Map 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

  1. 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

  1. 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

  1. 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

  1. 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

hashCode

  1. public int hashCode()
Specified by:
hashCode in interface java.util.Map<java.lang.String,java.lang.Object>
Overrides:
hashCode in class java.lang.Object