com.jivesoftware.base.event
Class JivePropertyEvent

java.lang.Object
  com.jivesoftware.base.event.JivePropertyEvent

All Implemented Interfaces:

JiveEvent

public class JivePropertyEvent
extends java.lang.Object
implements JiveEvent

An event for JiveProperty changes Certain event types will populate the params Map with additional objects as outlined below:

Event Type	Extra Params
PROPERTY_ADDED	none
PROPERTY_REMOVED	REMOVED_VALUES => list of values (excluding event param value)
PROPERTY_MODIFIED	PARAM_MODIFIED_OLD_VALUE -> original value value

Field Summary

static java.lang.String	PARAM_MODIFIED_OLD_VALUE Param map value for modified values on a PROPERTY_MODIFIED event
static java.lang.String	PARAM_REMOVED_VALUES Param map value for removed values on a PROPERTY_REMOVED event
static int	PROPERTY_ADDED A new property was added
static int	PROPERTY_MODIFIED A property was modified.
static int	PROPERTY_REMOVED A property was removed.

Constructor Summary

JivePropertyEvent(int eventType, java.lang.String name, java.lang.String value, java.util.Map<java.lang.String,? extends java.lang.Object> params)
Creates a new jive property event.

Method Summary

java.util.Date	getDate() Returns the date the event was created
int	getEventType() Returns an integer value for the type of event this is
java.lang.String	getName() Returns the name of the jive property
java.util.Map<java.lang.String,? extends java.lang.Object>	getParams() Returns any extra parameters associated with event
java.lang.String	getValue() Returns the value of the jive property

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ADDED

public static final int PROPERTY_ADDED

A new property was added

See Also:

Constant Field Values

PROPERTY_REMOVED

public static final int PROPERTY_REMOVED

A property was removed.

See Also:

Constant Field Values

PROPERTY_MODIFIED

public static final int PROPERTY_MODIFIED

A property was modified.

See Also:

Constant Field Values

PARAM_REMOVED_VALUES

public static final java.lang.String PARAM_REMOVED_VALUES

Param map value for removed values on a PROPERTY_REMOVED event

See Also:

Constant Field Values

PARAM_MODIFIED_OLD_VALUE

public static final java.lang.String PARAM_MODIFIED_OLD_VALUE

Param map value for modified values on a PROPERTY_MODIFIED event

See Also:

Constant Field Values

Constructor Detail

JivePropertyEvent

public JivePropertyEvent(int eventType,
                         java.lang.String name,
                         java.lang.String value,
                         java.util.Map<java.lang.String,? extends java.lang.Object> params)

Creates a new jive property event.

Parameters:

name - the jive property

value - the value of the jive property

eventType - the type of the message event.

Method Detail

getEventType

public int getEventType()

Returns an integer value for the type of event this is

Specified by:

getEventType in interface JiveEvent

Returns:

type of event

getDate

public java.util.Date getDate()

Returns the date the event was created

Specified by:

getDate in interface JiveEvent

Returns:

the date the event was created

getParams

public java.util.Map<java.lang.String,? extends java.lang.Object> getParams()

Returns any extra parameters associated with event

Specified by:

getParams in interface JiveEvent

Returns:

any extra parameters associated with event

getName

public java.lang.String getName()

Returns the name of the jive property

Returns:

the name of the jive property

getValue

public java.lang.String getValue()

Returns the value of the jive property

Returns:

the value of the jive property