Interface JmsProperties
-
- All Known Implementing Classes:
ImmutableJmsProperties,IncomingJmsMessageMetadata,JmsPropertiesBuilder.OutgoingJmsProperties
public interface JmsPropertiesStructure handling JMS Message properties. Instances of this interface must be immutable.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static JmsPropertiesBuilderbuilder()Creates a builder object to create JMS PropertiesbooleangetBooleanProperty(String name)Returns the value of thebooleanproperty with the specified name.bytegetByteProperty(String name)Returns the value of thebyteproperty with the specified name.doublegetDoubleProperty(String name)Returns the value of thedoubleproperty with the specified name.floatgetFloatProperty(String name)Returns the value of thefloatproperty with the specified name.intgetIntProperty(String name)Returns the value of theintproperty with the specified name.longgetLongProperty(String name)Returns the value of thelongproperty with the specified name.ObjectgetObjectProperty(String name)Returns the value of the Java object property with the specified name.Enumeration<String>getPropertyNames()Returns anEnumerationof all the property names.shortgetShortProperty(String name)Returns the value of theshortproperty with the specified name.StringgetStringProperty(String name)Returns the value of theStringproperty with the specified name.booleanpropertyExists(String name)Indicates whether a property value exists.
-
-
-
Method Detail
-
builder
static JmsPropertiesBuilder builder()
Creates a builder object to create JMS Properties- Returns:
- the builder.
-
propertyExists
boolean propertyExists(String name)
Indicates whether a property value exists.- Parameters:
name- the name of the property to test- Returns:
- true if the property exists
-
getBooleanProperty
boolean getBooleanProperty(String name)
Returns the value of thebooleanproperty with the specified name.- Parameters:
name- the name of thebooleanproperty- Returns:
- the
booleanproperty value for the specified name
-
getByteProperty
byte getByteProperty(String name)
Returns the value of thebyteproperty with the specified name.- Parameters:
name- the name of thebyteproperty- Returns:
- the
byteproperty value for the specified name
-
getShortProperty
short getShortProperty(String name)
Returns the value of theshortproperty with the specified name.- Parameters:
name- the name of theshortproperty- Returns:
- the
shortproperty value for the specified name
-
getIntProperty
int getIntProperty(String name)
Returns the value of theintproperty with the specified name.- Parameters:
name- the name of theintproperty- Returns:
- the
intproperty value for the specified name
-
getLongProperty
long getLongProperty(String name)
Returns the value of thelongproperty with the specified name.- Parameters:
name- the name of thelongproperty- Returns:
- the
longproperty value for the specified name
-
getFloatProperty
float getFloatProperty(String name)
Returns the value of thefloatproperty with the specified name.- Parameters:
name- the name of thefloatproperty- Returns:
- the
floatproperty value for the specified name
-
getDoubleProperty
double getDoubleProperty(String name)
Returns the value of thedoubleproperty with the specified name.- Parameters:
name- the name of thedoubleproperty- Returns:
- the
doubleproperty value for the specified name
-
getStringProperty
String getStringProperty(String name)
Returns the value of theStringproperty with the specified name.- Parameters:
name- the name of theStringproperty- Returns:
- the
Stringproperty value for the specified name; if there is no property by this name, a null value is returned
-
getObjectProperty
Object getObjectProperty(String name)
Returns the value of the Java object property with the specified name.This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent
setObjectPropertymethod call, or its equivalent primitivesettypePropertymethod.- Parameters:
name- the name of the Java object property- Returns:
- the Java object property value with the specified name, in objectified format (for example, if the property
was set as an
int, anIntegeris returned); if there is no property by this name, a null value is returned
-
getPropertyNames
Enumeration<String> getPropertyNames()
Returns anEnumerationof all the property names.Note that Jakarta Messaging standard header fields are not considered properties and are not returned in this enumeration.
- Returns:
- an enumeration of all the names of property values
-
-