org.gridgain.grid.events

Class GridEventAdapter

java.lang.Object

org.gridgain.grid.events.GridEventAdapter

All Implemented Interfaces:

Serializable, Comparable<GridEvent>, GridEvent

Direct Known Subclasses:

GridAuthenticationEvent, GridAuthorizationEvent, GridCacheEvent, GridCachePreloadingEvent, GridCheckpointEvent, GridDeploymentEvent, GridDiscoveryEvent, GridGgfsEvent, GridJobEvent, GridLicenseEvent, GridSecureSessionEvent, GridSwapSpaceEvent, GridTaskEvent

public class GridEventAdapter
extends Object
implements GridEvent

Base adapter for the events. All events (including user-defined ones) should extend this adapter as it provides necessary plumbing implementation details.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridEventAdapter() No-arg constructor.
GridEventAdapter(GridNode node, String msg, int type) Creates event based with given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(GridEvent o)
boolean	equals(Object o)
int	hashCode()
GridUuid	id() Gets globally unique ID of this event.
long	localOrder() Gets locally unique ID that is atomically incremented for each event.
String	message() Gets optional message for this event.
void	message(String msg) Sets optional event message.
String	name() Gets event type name.
GridNode	node() Node where event occurred and was recorded
void	node(GridNode node) Sets node where even is occurred (i.e.
String	shortDisplay() Gets a shortened version of toString() result.
long	timestamp() Gets event timestamp.
String	toString()
int	type() Gets type of this event.
void	type(int type) Sets event type.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridEventAdapter

public GridEventAdapter()

No-arg constructor.

GridEventAdapter

public GridEventAdapter(GridNode node,
                String msg,
                int type)

Creates event based with given parameters.

Parameters:

msg - Optional message.

type - Event type.

Method Detail

compareTo

public int compareTo(GridEvent o)

Specified by:

compareTo in interface Comparable<GridEvent>

id

public GridUuid id()

Gets globally unique ID of this event.

Specified by:

id in interface GridEvent

Returns:

Globally unique ID of this event.

See Also:

GridEvent.localOrder()

localOrder

public long localOrder()

Gets locally unique ID that is atomically incremented for each event. Unlike global GridEvent.id() this local ID can be used for ordering events on this node.

Note that for performance considerations GridGain doesn't order events globally.

Specified by:

localOrder in interface GridEvent

Returns:

Locally unique ID that is atomically incremented for each new event.

See Also:

GridEvent.id()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

node

public void node(GridNode node)

Sets node where even is occurred (i.e. node local to the event).

Parameters:

node - Node.

message

public void message(@Nullable
           String msg)

Sets optional event message.

Parameters:

msg - Optional event message.

type

public void type(int type)

Sets event type.

Parameters:

type - Event type.

node

public GridNode node()

Node where event occurred and was recorded

Specified by:

node in interface GridEvent

Returns:

node where event occured and was recorded.

message

@Nullable
public String message()

Gets optional message for this event.

Specified by:

message in interface GridEvent

Returns:

Optional (can be null) message for this event.

type

public int type()

Gets type of this event. All system event types are defined in GridEventType.

NOTE: all types in range from 1 to 1000 are reserved for internal GridGain events and should not be used by user-defined events.

Specified by:

type in interface GridEvent

Returns:

Event's type.

See Also:

GridEventType

timestamp

public long timestamp()

Gets event timestamp. Timestamp is local to the node on which this event was produced. Note that more than one event can be generated with the same timestamp. For ordering purposes use GridEvent.localOrder() instead.

Specified by:

timestamp in interface GridEvent

Returns:

Event timestamp.

name

public String name()

Gets event type name.

Specified by:

name in interface GridEvent

Returns:

Event type name.

shortDisplay

public String shortDisplay()

Gets a shortened version of toString() result. Suitable for humans to read.

Specified by:

shortDisplay in interface GridEvent

Returns:

Shortened version of toString() result.

toString

public String toString()

Overrides:

toString in class Object