net.officefloor.plugin.comet.internal
Class CometEvent

java.lang.Object
  net.officefloor.plugin.comet.internal.CometEvent

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CometEvent
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

Comet event.

Author:

Daniel Sagenschneider

Field Summary

static long

NO_SEQUENCE_NUMBER Value indicating no sequence number.

Constructor Summary

CometEvent()
Default constructor required for IsSerializable.

CometEvent(long sequenceNumber, String listenerTypeName, Object data, Object matchKey)
Initiate for specifying the sequence number.

CometEvent(String listenerTypeName, Object data, Object matchKey)
Initiate for publishing without a sequence number.

Method Summary

Object	getData() Obtains the data of this CometEvent.
String	getListenerTypeName() Obtains the listener type name.
Object	getMatchKey() Obtains the match key.
long	getSequenceNumber() Obtains the sequence number for this CometEvent.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SEQUENCE_NUMBER

public static final long NO_SEQUENCE_NUMBER

Value indicating no sequence number.

See Also:

Constant Field Values

Constructor Detail

CometEvent

public CometEvent(String listenerTypeName,
                  Object data,
                  Object matchKey)

Initiate for publishing without a sequence number. Sequence number to be assigned.

Parameters:

listenerTypeName - Listener type name.

data - Data.

matchKey - Match key. May be null.

CometEvent

public CometEvent(long sequenceNumber,
                  String listenerTypeName,
                  Object data,
                  Object matchKey)

Initiate for specifying the sequence number.

Parameters:

sequenceNumber - Sequence number for this CometEvent.

listenerTypeName - Listener type name.

data - Data.

matchKey - Match key. May be null.

CometEvent

public CometEvent()

Default constructor required for IsSerializable.

Method Detail

getSequenceNumber

public long getSequenceNumber()

Obtains the sequence number for this CometEvent.

Returns:

Sequence number for this CometEvent.

getListenerTypeName

public String getListenerTypeName()

Obtains the listener type name.

Returns:

Listener type name.

getData

public Object getData()

Obtains the data of this CometEvent.

Returns:

Data.

getMatchKey

public Object getMatchKey()

Obtains the match key.

Returns:

Match key. May be null.