Interface JmsProperties
-
- All Known Implementing Classes:
ImmutableJmsProperties
,IncomingJmsMessageMetadata
,JmsPropertiesBuilder.OutgoingJmsProperties
public interface JmsProperties
Structure 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 JmsPropertiesBuilder
builder()
Creates a builder object to create JMS Propertiesboolean
getBooleanProperty(String name)
Returns the value of theboolean
property with the specified name.byte
getByteProperty(String name)
Returns the value of thebyte
property with the specified name.double
getDoubleProperty(String name)
Returns the value of thedouble
property with the specified name.float
getFloatProperty(String name)
Returns the value of thefloat
property with the specified name.int
getIntProperty(String name)
Returns the value of theint
property with the specified name.long
getLongProperty(String name)
Returns the value of thelong
property with the specified name.Object
getObjectProperty(String name)
Returns the value of the Java object property with the specified name.Enumeration<String>
getPropertyNames()
Returns anEnumeration
of all the property names.short
getShortProperty(String name)
Returns the value of theshort
property with the specified name.String
getStringProperty(String name)
Returns the value of theString
property with the specified name.boolean
propertyExists(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 theboolean
property with the specified name.- Parameters:
name
- the name of theboolean
property- Returns:
- the
boolean
property value for the specified name
-
getByteProperty
byte getByteProperty(String name)
Returns the value of thebyte
property with the specified name.- Parameters:
name
- the name of thebyte
property- Returns:
- the
byte
property value for the specified name
-
getShortProperty
short getShortProperty(String name)
Returns the value of theshort
property with the specified name.- Parameters:
name
- the name of theshort
property- Returns:
- the
short
property value for the specified name
-
getIntProperty
int getIntProperty(String name)
Returns the value of theint
property with the specified name.- Parameters:
name
- the name of theint
property- Returns:
- the
int
property value for the specified name
-
getLongProperty
long getLongProperty(String name)
Returns the value of thelong
property with the specified name.- Parameters:
name
- the name of thelong
property- Returns:
- the
long
property value for the specified name
-
getFloatProperty
float getFloatProperty(String name)
Returns the value of thefloat
property with the specified name.- Parameters:
name
- the name of thefloat
property- Returns:
- the
float
property value for the specified name
-
getDoubleProperty
double getDoubleProperty(String name)
Returns the value of thedouble
property with the specified name.- Parameters:
name
- the name of thedouble
property- Returns:
- the
double
property value for the specified name
-
getStringProperty
String getStringProperty(String name)
Returns the value of theString
property with the specified name.- Parameters:
name
- the name of theString
property- Returns:
- the
String
property 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
setObjectProperty
method call, or its equivalent primitivesettypeProperty
method.- 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
, anInteger
is returned); if there is no property by this name, a null value is returned
-
getPropertyNames
Enumeration<String> getPropertyNames()
Returns anEnumeration
of 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
-
-