TopicMessage (Diffusion)

All Superinterfaces:

DataMessage, Message

All Known Subinterfaces:

AttachableTopicMessage

Deprecated.
since 6.2
Messages only remain to support one-way messaging which is deprecated at this release. This interface will be removed in a future release.
```
@Deprecated
public interface TopicMessage
extends DataMessage
```
The interface for data messages that are created for a specific topic.

Field Summary
- Fields inherited from interface com.pushtechnology.diffusion.api.message.Message
  EMPTY_FIELD, EMPTY_FIELD_CHAR, EMPTY_FIELD_STRING, FIELD_DELIMITER, FIELD_DELIMITER_CHAR, FIELD_DELIMITER_STRING, FIELD_MU, LIST_DELIMITER, LIST_DELIMITER_CHAR, LIST_DELIMITER_STRING, MESSAGE_SEPARATOR, MESSAGE_SEPARATOR_CHAR, RECORD_DELIMITER, RECORD_DELIMITER_CHAR, RECORD_DELIMITER_STRING, RECORD_MU

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`TopicMessage`	`duplicate()` Deprecated. Creates an exact duplicate of the message.
`String`	`getTopicName()` Deprecated. Returns the message topic name.
`boolean`	`isDelta()` Deprecated. since 6.2 Delta messages are no longer exposed to the Publisher API therefore this would always return false. This will be removed in a future release.
`boolean`	`isFetchReply()` Deprecated. since 6.2 This is a redundant method which always returns false. This will be removed in a future release.
`boolean`	`isFor(String topicPattern)` Deprecated. Indicates whether the message is for a named topic or topic selector.
`boolean`	`isForTopic(String topicName)` Deprecated. Indicates whether the message is for a named topic.
`boolean`	`isTopicLoad()` Deprecated. since 6.2 All messages exposed to the Publisher API are now load messages therefore this would always return true. This will be removed in a future release.

Methods inherited from interface com.pushtechnology.diffusion.api.message.DataMessage
asByteBuffer, asBytes, asFields, asRecords, asString, getCharset, getInputStream, getReader, hasRemaining, length, nextByte, nextBytes, nextField, nextRecord, remaining, rewind

Methods inherited from interface com.pushtechnology.diffusion.api.message.Message
getHeader, getHeaders, isTopicMessage, setHeaders, setHeaders, size, toString

- Method Detail
  - getTopicName
```
String getTopicName()
```
    Deprecated.
    
    Returns the message topic name.
    
    Returns:
    
    the message topic name.
  - isFor
```
boolean isFor(String topicPattern)
```
    Deprecated.
    
    Indicates whether the message is for a named topic or topic selector.
    If it is known that the argument is a full topic name then use of isForTopic(String) is more efficient.
    
    Parameters:
    
    topicPattern - a full topic name or topic selector pattern.
    
    Returns:
    
    true if the message topic matches the supplied pattern.
  - isForTopic
```
boolean isForTopic(String topicName)
```
    Deprecated.
    
    Indicates whether the message is for a named topic.
    
    Parameters:
    
    topicName - a full topic name.
    
    Returns:
    
    true if the message topic is equal to the supplied topic name.
  - isTopicLoad
```
@Deprecated
boolean isTopicLoad()
```
    Deprecated. since 6.2
    All messages exposed to the Publisher API are now load messages therefore this would always return true. This will be removed in a future release.
    
    Returns true if a Topic Load message.
    
    Returns:
    
    true if a Topic Load message, otherwise false.
  - isFetchReply
```
@Deprecated
boolean isFetchReply()
```
    Deprecated. since 6.2
    This is a redundant method which always returns false. This will be removed in a future release.
    
    Is this message a response to a 'fetch' request?
    
    Returns:
    
    true if this message is a response to a 'fetch' request.
  - isDelta
```
@Deprecated
boolean isDelta()
```
    Deprecated. since 6.2
    Delta messages are no longer exposed to the Publisher API therefore this would always return false. This will be removed in a future release.
    
    Returns true if a delta message.
    
    Returns:
    
    true if a delta message, otherwise false.
  - duplicate
```
TopicMessage duplicate()
                throws MessageException
```
    Deprecated.
    
    Creates an exact duplicate of the message.
    
    Returns:
    
    a duplicate of the message.
    
    Throws:
    
    MessageException - if unable to create a duplicate.

Interface TopicMessage

Field Summary

Fields inherited from interface com.pushtechnology.diffusion.api.message.Message

Method Summary

Methods inherited from interface com.pushtechnology.diffusion.api.message.DataMessage

Methods inherited from interface com.pushtechnology.diffusion.api.message.Message

Method Detail

getTopicName

isFor

isForTopic

isTopicLoad

isFetchReply

isDelta

duplicate