Jive API (3.0.13) Core Javadocs

com.jivesoftware.base.event
Class JivePropertyEvent

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

public class JivePropertyEvent
extends

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

Event Type Extra Params
ADDED none
REMOVED REMOVED_VALUES => list of values (excluding event param value)
MODIFIED PARAM_MODIFIED_OLD_VALUE -> original value value


Nested Class Summary
static class JivePropertyEvent.Entry
           
static class JivePropertyEvent.Type
           
 
Field Summary
static String PARAM_MODIFIED_OLD_VALUE
          Param map value for modified values on a PROPERTY_MODIFIED event
static String PARAM_REMOVED_VALUES
          Param map value for removed values on a PROPERTY_REMOVED event
 
Constructor Summary
JivePropertyEvent()
           
JivePropertyEvent(JivePropertyEvent.Type eventType, JivePropertyEvent.Entry entry, Map<String,? extends Object> params)
           
JivePropertyEvent(JivePropertyEvent.Type eventType, String name, String value, Map<String,? extends Object> params)
          Creates a new jive property event.
 
Method Summary
 String getName()
          Returns the name of the jive property
 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

PARAM_REMOVED_VALUES

public static final 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 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()

JivePropertyEvent

public JivePropertyEvent(JivePropertyEvent.Type eventType,
                         String name,
                         String value,
                         Map<String,? extends Object> params)
Creates a new jive property event.

Parameters:
eventType - the type of the message event.
name - name
value - value

JivePropertyEvent

public JivePropertyEvent(JivePropertyEvent.Type eventType,
                         JivePropertyEvent.Entry entry,
                         Map<String,? extends Object> params)
Method Detail

getName

public String getName()
Returns the name of the jive property

Returns:
the name of the jive property

getValue

public String getValue()
Returns the value of the jive property

Returns:
the value of the jive property

Jive Product Page

Copyright © 1999-2007 Jive Software.