com.yahoo.bullet.pubsub

Class PubSubMessage

java.lang.Object

com.yahoo.bullet.pubsub.PubSubMessage

All Implemented Interfaces:

JSONFormatter, Serializable

public class PubSubMessage
extends Object
implements Serializable, JSONFormatter

The class of messages that can be understood by the PubSub package. The id should be set to the query ID generated by the web service for Bullet queries.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET
protected Object	content
protected String	id
protected Metadata	metadata

Fields inherited from interface com.yahoo.bullet.result.JSONFormatter

GSON, INVALID_DOUBLES

Constructor Summary

Constructors

Constructor and Description
PubSubMessage() Constructor for a message having no information.
PubSubMessage(String id, Metadata.Signal signal) Constructor for a message having only a Metadata.Signal.
PubSubMessage(String id, Serializable content) Constructor for a message having only content.
PubSubMessage(String id, Serializable content, Metadata.Signal signal) Constructor for a message having content and a Metadata.Signal.
PubSubMessage(String id, Serializable content, Metadata metadata) Constructor for a message having content and Metadata.

Method Summary

Modifier and Type	Method and Description
String	asJSON() Convert this object to a JSON string.
boolean	equals(Object other)
static PubSubMessage	fromJSON(String json) Converts a json representation back to an instance.
static PubSubMessage	fromJSON(String json, com.google.gson.Gson gson) Converts a JSON representation back to an instance using a specific Gson converter.
Serializable	getContent() Returns the Serializable content stored in the message.
byte[]	getContentAsByteArray() Returns the content stored in the message as a byte[].
Query	getContentAsQuery() Returns the content stored in the message as a Query.
String	getContentAsString() Returns the content stored in the message as a String.
boolean	hasContent() Check if message has content.
int	hashCode()
boolean	hasMetadata() Check if message has Metadata.
boolean	hasSignal() Check if the message has a Metadata.Signal.
boolean	hasSignal(Metadata.Signal signal) Check if message has a given Metadata.Signal.
void	setContent(Serializable content) Set a Serializable content for this message.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.bullet.result.JSONFormatter

asJSON, fromJSON

Field Detail

CHARSET

public static final Charset CHARSET

id

protected String id

content

protected Object content

metadata

protected Metadata metadata

Constructor Detail

PubSubMessage

public PubSubMessage()

Constructor for a message having no information. Used internally. Not recommended for use.

PubSubMessage

public PubSubMessage(String id,
                     Metadata.Signal signal)

Constructor for a message having only a Metadata.Signal.

Parameters:

id - The ID associated with the message.

signal - The signal only for the Metadata.

PubSubMessage

public PubSubMessage(String id,
                     Serializable content)

Constructor for a message having only content.

Parameters:

id - The ID associated with the message.

content - The content of the message.

PubSubMessage

public PubSubMessage(String id,
                     Serializable content,
                     Metadata.Signal signal)

Constructor for a message having content and a Metadata.Signal.

Parameters:

id - The ID associated with the message.

content - The content of the message.

signal - The Signal to be sent with the message.

PubSubMessage

public PubSubMessage(String id,
                     Serializable content,
                     Metadata metadata)

Constructor for a message having content and Metadata.

Parameters:

id - The ID associated with the message.

content - The content of the message.

metadata - The Metadata associated with the message.

Method Detail

hasContent

public boolean hasContent()

Check if message has content.

Returns:

true if message has content.

hasMetadata

public boolean hasMetadata()

Check if message has Metadata.

Returns:

true if message has Metadata.

hasSignal

public boolean hasSignal(Metadata.Signal signal)

Check if message has a given Metadata.Signal.

Parameters:

signal - The signal to check for.

Returns:

true if message has the given signal.

hasSignal

public boolean hasSignal()

Check if the message has a Metadata.Signal.

Returns:

true if message has a signal.

getContent

public Serializable getContent()

Returns the Serializable content stored in the message.

Returns:

The content stored.

getContentAsByteArray

public byte[] getContentAsByteArray()

Returns the content stored in the message as a byte[]. You should use this to read the byte[] back from the message if you provided it originally to the message as a byte[].

Returns:

The content stored as a byte[].

getContentAsString

public String getContentAsString()

Returns the content stored in the message as a String. You should use this to read the String back from the message if you provided it originally to the message as a String.

Returns:

The content stored as a String.

getContentAsQuery

public Query getContentAsQuery()

Returns the content stored in the message as a Query. You should use this to read the Query back if you originally provided to the message as a Serializable.

Returns:

The content stored as a Query.

setContent

public void setContent(Serializable content)

Set a Serializable content for this message.

Parameters:

content - The content for this message.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

asJSON

public String asJSON()

Description copied from interface: JSONFormatter

Convert this object to a JSON string.

Specified by:

asJSON in interface JSONFormatter

Returns:

The JSON representation of this.

fromJSON

public static PubSubMessage fromJSON(String json)

Converts a json representation back to an instance. Is the inverse of asJSON().

Parameters:

json - The string representation of the JSON.

Returns:

An instance of this class.

fromJSON

public static PubSubMessage fromJSON(String json,
                                     com.google.gson.Gson gson)

Converts a JSON representation back to an instance using a specific Gson converter. Is the inverse of asJSON().

Parameters:

json - The string representation of the JSON.

gson - The Gson converter to use.

Returns:

An instance of this class.