pipeadvertisement.java

jxme的一些相关程序,主要是手机上程序开发以及手机和计算机通信的一些程序资料,程序编译需要Ant支持

/*********************
 * $Id: PipeAdvertisement.java,v 1.19 2001/11/13 22:30:07 bondolo Exp $
 *
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 ********************
 */

package net.jxta.protocol;

import net.jxta.document.Advertisement;
import net.jxta.id.ID;
import net.jxta.pipe.PipeID;
import net.jxta.pipe.PipeService;

/**
 * This class defines the PipeServiceImpl Advertisement
 *
 * <p>The default behavior of this abstract class is to simple be a place
 * holder for the PipeServiceImpl Id and its name. No XML document is processed. That
 * has to be done in the class that implements PipeAdvertisement.  Pipes are
 * named with their XML advertisement. The generation of the PipeServiceImpl
 * Advertisements is let to the application. A Jxta PipeServiceImpl advertisement is
 * an XML document (non validated) which contains at least the following
 * structure (but can be extended).
 *
 * <pre>
 * &lt;?xml version="1.0"?&gt;
 * &lt;jxta:PipeAdvertisement;&gt;
 *   &lt;Id&gt; UUID &lt;/Id&gt;
 *   &lt;Type&gt; type of the pipe &lt;/Type&gt;
 *   &lt;Name&gt; optional symbolic name than can be used by
 *      any search engine &lt;/Name&gt;
 * &lt;/jxta:PipeAdvertisement;&gt;
 *</pre>
 *
 * <p>Note that other tags can be provided by the application for its own
 * profit. Those extra tags are not interpreted by the PipeService.
 *
 * <p>The UUID needs to be a unique String (unique in time and space).
 *
 * @version $Revision: 1.19 $
 * @since JXTA 1.0
 */

public abstract class PipeAdvertisement extends Advertisement
                                        implements Cloneable {
    
    private String name = null;
    private String type = PipeService.UnicastType;
    private ID pipeId = ID.nullID;

    /**
     * XML tag to store the PipeID
     **/
    public static final String IdTag = "Id";
    /**
     * XML tag to store the Pipe Type
     **/
    public static final String TypeTag = "Type";
    /**
     * XML tag to store the name of the Pipe
     **/
    public static final String NameTag = "Name";
    
    /**
     * get the pipe type
     *
     *  @return String  PipeAdvertisement type
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */
  
    public static String getAdvertisementType() {
	return "jxta:PipeAdvertisement" ;
    }
    
    /**
     * Clone this PipeAdvertisement
     *
     * @return Object an object of class PipeAdvertisement that is a
     * deep-enough copy of this one.
     * @version $Revision: 1.19 $
     * @since JXTA 1.0
     */
    public Object clone() {

        // All members are either immutable or never modified nor allowed to
        // be modified: all accessors return clones or immutable objects.
        // IDs are know to be immutable but that could change. Accessors
        // clone() them for safety; their clone method costs nothing.
        try {
            return super.clone();
        } catch (CloneNotSupportedException impossible) {
            return null;
        }
    }

    /**
     * get an ID for indexing purposes. The PipeID uniquely identifies this ADV.
     *
     *  @return ID The Pipe ID itself.
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */
  
    public ID getID () {
        if( pipeId.equals( ID.nullID ) )
            throw new IllegalStateException( "Pipe has no assigned ID" );
        
	return (ID) pipeId.clone();
    }

    
    /**
     * get the pipe id
     *
     *  @return ID PipeServiceImpl id
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */
  
    public ID getPipeID () {
	return (ID) pipeId.clone();
    }
  
    /**
     * set the pipe Id
     *
     *  @param id The PipeId to be set.
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */

    public void setPipeID (ID pipeId) {
        if( null == pipeId )
            throw new IllegalArgumentException( "pipeId may not be null" );
        
	this.pipeId = (ID) pipeId.clone();
    }
  

    /**
     * get the pipe type
     *
     *  @return String PipeService type
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */
  
    public String getType () {
	return type;
    }
  
    /**
     * set the pipe type
     *
     *  @param type The type to be set.
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */

    public void setType (String type) {
	this.type = type;
    }
  
    /**
     * get the symbolic name associated with the pipe
     *
     * @return String the name field.
     *
     * @version $Revision: 1.19 $
     * @since JXTA 1.0
     */

    public String getName() {
	return name;
    }
  
    /**
     * set the symbolic name associated with the pipe
     *
     *  @param n the name this pipe adv should have.
     *
     *  @version $Revision: 1.19 $
     *  @since JXTA 1.0
     */
  
    public void setName (String n) {
	name = n;
    }
  
}