xevent.java

一款即时通讯软件

/*
 *   License
 *
 * The contents of this file are subject to the Jabber Open Source License
 * Version 1.0 (the "License").  You may not copy or use this file, in either
 * source code or executable form, except in compliance with the License.  You
 * may obtain a copy of the License at http://www.jabber.com/license/ or at
 * http://www.opensource.org/.  
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied.  See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 *   Copyrights
 *
 * Portions created by or assigned to Jabber.com, Inc. are 
 * Copyright (c) 2000 Jabber.com, Inc.  All Rights Reserved.  Contact
 * information for Jabber.com, Inc. is available at http://www.jabber.com/.
 *
 * Portions Copyright (c) 1999-2000 David Waite 
 *
 *   Acknowledgements
 * 
 * Special thanks to the Jabber Open Source Contributors for their
 * suggestions and support of Jabber.
 * 
 *   Changes
 *
 * @author  David Waite <a href="mailto:[e-mail]">
 *                      <i>&lt;[e-mail]&gt;</i></a>
 *
 * @author  $Author: chris $
 * @version $Revision: 1.1 $
 *
 * j.komzak
 * Changed into XEvent
 */

package edu.ou.kmi.buddyspace.xml;

/*
 * XEvent.java
 *
 * Project: BuddySpace
 * (C) Copyright Knowledge Media Institute 2003
 *
 *
 * Created on 22 October 2003, 11:05
 */

import java.util.Vector;
import java.util.Enumeration;
import org.jabber.jabberbeans.*;
import org.jabber.jabberbeans.Extension.*;

/**
 * <code>XEvent</code> contains &lt;x xmlns='jabber:x:event'&gt tag.
 *
 * @author Jiri Komzak, Knowledge Media Institute, Open University, United Kingdom
 */
public class XEvent
    extends XMLData
    implements MessageExtension
{
    /** offline */
    private boolean offline = false;
    /** delivered */
    private boolean delivered = false;
    /** composing */
    private boolean composing = false;
    /** displayed */
    private boolean displayed = false;
    /** id */
    private String id = null;
    
    /**
     * Creates a new <code>XEvent</code> instance, based on the builder
     * state.
     *
     * @param builder an <code>XEventBuilder</code> value
     * @exception InstantiationException if malformed or insufficient data is
     * in the builder.
     */
    public XEvent(XEventBuilder builder)
        throws InstantiationException
    {
        offline = builder.isOffline();
        delivered = builder.isDelivered();
        composing = builder.isComposing();
        displayed = builder.isDisplayed();
        id = builder.getID();
    }
    
    
    /**
     * returns if the offline flag is present.
     */
    public boolean isOffline() {
        return offline;
    }
    
    
    /**
     * returns if the delivered flag is present.
     */
    public boolean isDelivered() {
        return delivered;
    }
    
    
    /**
     * returns if the displayed flag is present.
     */
    public boolean isDisplayed() {
        return displayed;
    }
    
    
    /**
     * returns if the composing flag is present.
     */
    public boolean isComposing() {
        return composing;
    }
    
    
    /**
     * returns the id in the object.
     */
    public String getID() {
        return id;
    }
    
    
    /**
     * <code>appendItem</code> converts this packet to XML. 
     * It then appends it to a StringBuffer.
     *
     * @param retval The <code>StringBuffer</code> to append to
     */
    public void appendItem(StringBuffer retval)
    {
	retval.append("<x xmlns='jabber:x:event'>");
        
        if (offline)
            retval.append("<offline/>");
        if (delivered)
            retval.append("<delivered/>");
        if (displayed)
            retval.append("<displayed/>");
        if (composing)
            retval.append("<composing/>");
        if (id != null)
            retval.append("<id>" + id + "</id>");
        
        retval.append("</x>");
    }
}