xdatabuilder.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 XDataBuilder
 */

package edu.ou.kmi.buddyspace.xml;

/*
 * XDataBuilder.java
 *
 * Project: BuddySpace
 * (C) Copyright Knowledge Media Institute 2003
 *
 *
 * Created on 4 February 2003, 16:11
 */

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

/**
 * <code>XDataBuilder</code> is used to construct XData objects
 *
 * @author  Jiri Komzak, Knowledge Media Institute, Open University, United Kingdom
 */
public class XDataBuilder
    implements ExtensionBuilder
{
    /** Vector of field objects contained. */
    private Vector fields;
    /** Vector of item and reported objects contained. */
    private Vector items;
    
    private String type = null;
    private String title = null;
    private String instructions = null;

    /** Creates a new <code>XDataBuilder</code> instance. */
    public XDataBuilder()
    { reset(); }
    
    /**
     * <code>reset</code> the builder to a default state, so it can be reused.
     */
    public void reset() {
        fields = new Vector();
        items = new Vector();
        type = title = instructions = null;
    }
    
    public void setType(String newType) {
        type = newType;
    }
    
    public String getType() {
        return type;
    }

    public void setTitle(String newTitle) {
        title = newTitle;
    }
    
    public String getTitle() {
        return title;
    }

    public void setInstructions(String newInstructions) {
        instructions = newInstructions;
    }
    
    public String getInstructions() {
        return instructions;
    }

    /**
     * <code>addField</code> adds a new field object to the end of this
     * list.
     *
     * @param field an <code>XDataField</code> value
     */
    public void addField(XDataField field)
    {
        if (!fields.contains(field))
            fields.addElement(field);
    }

    /**
     * <code>getFields</code> returns the vector representing the field
     * objects associated with this object.
     *
     * @return a <code>Vector</code> value
     */
    public Vector getFields()
    { return fields; }
    
    /**
     * <code>addItem</code> adds a new item object to the end of this
     * list.
     *
     * @param item an <code>XDataItem</code> value
     */
    public void addItem(XDataItem item)
    {
        if (!items.contains(item))
            items.addElement(item);
    }

    /**
     * <code>getItems</code> returns the vector representing the item/reported
     * objects associated with this object.
     *
     * @return a <code>Vector</code> value
     */
    public Vector getItems()
    { return items; }

    /**
     * <code>build</code> a new XData object
     *
     * @return an <code>Extension</code> value
     * @exception InstantiationException if insufficient or incorrect data
     * was proviced.
     */
    public Extension build()
        throws InstantiationException
    { return new XData(this); }
}