com.yahoo.bullet.pubsub

Class Metadata

java.lang.Object

com.yahoo.bullet.pubsub.Metadata

All Implemented Interfaces:

Serializable

public class Metadata
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Signal

Constructor Summary

Constructors

Constructor and Description
Metadata() Default constructor that creates an empty instance of metadata.
Metadata(Metadata.Signal signal, Serializable object) Allows you to create an instance with a Metadata.Signal and a Serializable object.

Method Summary

Modifier and Type	Method and Description
Metadata	copy() Returns a copy of the current metadata.
Serializable	getContent() Returns the Serializable content in this metadata.
boolean	hasContent() Check if Metadata has content.
boolean	hasSignal() Check if Metadata has signal.
boolean	hasSignal(Metadata.Signal signal) Check if Metadata has the given signal.
void	setContent(Serializable content) Set a serializable content for this metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metadata

public Metadata()

Default constructor that creates an empty instance of metadata.

Metadata

public Metadata(Metadata.Signal signal,
                Serializable object)

Allows you to create an instance with a Metadata.Signal and a Serializable object.

Parameters:

signal - The signal to set.

object - The object that is the metadata.

Method Detail

copy

public Metadata copy()

Returns a copy of the current metadata. Subclasses should override this method.

Returns:

A copy of this Metadata.

setContent

public void setContent(Serializable content)

Set a serializable content for this metadata.

Parameters:

content - The content for this metadata.

getContent

public Serializable getContent()

Returns the Serializable content in this metadata.

Returns:

The serializable content or null.

hasContent

public boolean hasContent()

Check if Metadata has content.

Returns:

true if Metadata has content.

hasSignal

public boolean hasSignal()

Check if Metadata has signal.

Returns:

true if message has signal

hasSignal

public boolean hasSignal(Metadata.Signal signal)

Check if Metadata has the given signal.

Parameters:

signal - The signal to check against.

Returns:

true if message has signal