ContactPresenceStatusChangeEvent.java

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.service.protocol.event;

import java.beans.*;

import net.java.sip.communicator.service.protocol.*;

/**
 * Instances of this class represent a  change in the status of a particular
 * contact.
 * @author Emil Ivov
 */
public class ContactPresenceStatusChangeEvent extends PropertyChangeEvent
{
    private ProtocolProviderService sourceProvider = null;
    private ContactGroup parentGroup = null;


    /**
     * Creates an event instance indicating that the specified source contact
     * has changed status from <tt>oldValue</tt> to <tt>newValue</tt>.
     * @param source the provider that generated the event
     * @param sourceProvider the protocol provider that the contact belongs to.
     * @param parentGroup the group containing the contact that caused this
     * event (to be set as null in cases where groups are not supported);
     * @param oldValue the status the source countact was in before enetering
     * the new state.
     * @param newValue the status the source contact is currently in.
     */
    public ContactPresenceStatusChangeEvent(
                                Contact source,
                                ProtocolProviderService sourceProvider,
                                ContactGroup parentGroup,
                                PresenceStatus oldValue,
                                PresenceStatus newValue)
    {
        super( source,
               ContactPresenceStatusChangeEvent.class.getName(),
               oldValue,
               newValue);
        this.sourceProvider = sourceProvider;
        this.parentGroup = parentGroup;
    }

    /**
     * Returns the provider that the source contact belongs to.
     * @return the provider that the source contact belongs to.
     */
    public ProtocolProviderService getSourceProvider()
    {
        return sourceProvider;
    }

    /**
     * Returns the provider that the source contact belongs to.
     * @return the provider that the source contact belongs to.
     */
    public Contact getSourceContact()
    {
        return (Contact)getSource();
    }

    /**
     * Returns the status of the provider before this event took place.
     * @return a PresenceStatus instance indicating the event the source
     * provider was in before it entered its new state.
     */
    public PresenceStatus getOldStatus()
    {
        return (PresenceStatus)super.getOldValue();
    }

    /**
     * Returns the status of the provider after this event took place.
     * (i.e. at the time the event is being dispatched).
     * @return a PresenceStatus instance indicating the event the source
     * provider is in after the status change occurred.
     */
    public PresenceStatus getNewStatus()
    {
        return (PresenceStatus)super.getNewValue();
    }

    /**
     * Returns (if applicable) the group containing the contact that cause this
     * event. In the case of a non persistent presence operation set this
     * field is null.
     * @return the ContactGroup (if there is one) containing the contact that
     * caused the event.
     */
    public ContactGroup getParentGroup()
    {
        return parentGroup;
    }

    /**
     * Returns a String representation of this ContactPresenceStatusChangeEvent
     *
     * @return  A a String representation of this
     * ContactPresenceStatusChangeEvent.
     */
    public String toString()
    {
        StringBuffer buff
            = new StringBuffer("ContactPresenceStatusChangeEvent-[ ContactID=");
        buff.append(getSourceContact().getAddress());
        if(getParentGroup() != null)
            buff.append(", ParentGroup").append(getParentGroup().getGroupName());
        return buff.append(", OldStatus=").append(getOldStatus())
            .append(", NewStatus=").append(getNewStatus()).append("]").toString();
    }

}