sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/ModuleClassAdvertisement.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.protocol;
  58
  59
  60 import net.jxta.document.Element;
  61 import net.jxta.document.ExtendableAdvertisement;
  62 import net.jxta.document.MimeMediaType;
  63 import net.jxta.document.StructuredDocument;
  64 import net.jxta.document.StructuredDocumentFactory;
  65 import net.jxta.document.StructuredDocumentUtils;
  66 import net.jxta.id.ID;
  67 import net.jxta.platform.ModuleClassID;
  68
  69
  70 /**
  71  * Formally documents the existence of a module class (identified by the
  72  * {@link net.jxta.platform.ModuleClassID} and may provide additional
  73  * descriptive metadata about the Module Class.
  74  *
  75  * @see net.jxta.platform.ModuleClassID
  76  */
  77 public abstract class ModuleClassAdvertisement extends ExtendableAdvertisement implements Cloneable {
  78
  79     /**
  80      *  The module class id associated with the is advertisement.
  81      */
  82     private ModuleClassID id = null;
  83
  84     /**
  85      *  Informal, non-canonical name of module.
  86      */
  87     private String name = null;
  88
  89     /**
  90      *  Descriptive meta-data about this module.
  91      */
  92     private Element description = null;
  93
  94     /**
  95      *  Returns the identifying type of this Advertisement.
  96      *
  97      *  @return The type of advertisement.
  98      */
  99     public static String getAdvertisementType() {
 100         return "jxta:MCA";
 101     }
 102
 103     /**
 104      * {@inheritDoc}
 105      */
 106     @Override
 107     public final String getBaseAdvType() {
 108         return getAdvertisementType();
 109     }
 110
 111     /**
 112      * {@inheritDoc}
 113      */
 114     @Override
 115     public ModuleClassAdvertisement clone() {
 116         try {
 117             ModuleClassAdvertisement clone = (ModuleClassAdvertisement) super.clone();
 118
 119             clone.setModuleClassID(getModuleClassID());
 120             clone.setName(getName());
 121             clone.setDesc(description);
 122
 123             return clone;
 124         } catch (CloneNotSupportedException impossible) {
 125             throw new Error("Object.clone() threw CloneNotSupportedException", impossible);
 126         }
 127     }
 128
 129     /**
 130      * {@inheritDoc}
 131      */
 132     @Override
 133     public ID getID() {
 134         return id;
 135     }
 136
 137     /**
 138      * returns the name of the class
 139      *
 140      * @return String name of the class
 141      */
 142     public String getName() {
 143         return name;
 144     }
 145
 146     /**
 147      * sets the name of the class
 148      *
 149      * @param name name of the class to be set
 150      *
 151      */
 152     public void setName(String name) {
 153         this.name = name;
 154     }
 155
 156     /**
 157      * returns the description
 158      *
 159      * @return String the description
 160      */
 161     public String getDescription() {
 162         if (null != description) {
 163             return (String) description.getValue();
 164         } else {
 165             return null;
 166         }
 167     }
 168
 169     /**
 170      * sets the description
 171      *
 172      * @param description the description
 173      */
 174     public void setDescription(String description) {
 175
 176         if (null != description) {
 177             StructuredDocument newdoc = StructuredDocumentFactory.newStructuredDocument(MimeMediaType.XMLUTF8, "Desc", description);
 178
 179             setDesc(newdoc);
 180         } else {
 181             this.description = null;
 182         }
 183     }
 184
 185     /**
 186      * returns the description
 187      *
 188      * @return the description
 189      */
 190     public StructuredDocument getDesc() {
 191         if (null != description) {
 192             StructuredDocument newDoc = StructuredDocumentUtils.copyAsDocument(description);
 193
 194             return newDoc;
 195         } else {
 196             return null;
 197         }
 198     }
 199
 200     /**
 201      * sets the description
 202      *
 203      * @param desc the description
 204      */
 205     public void setDesc(Element desc) {
 206
 207         if (null != desc) {
 208             this.description = StructuredDocumentUtils.copyAsDocument(desc);
 209         } else {
 210             this.description = null;
 211         }
 212     }
 213
 214     /**
 215      * returns the id of the class
 216      *
 217      * @return ModuleClassID the class id
 218      */
 219     public ModuleClassID getModuleClassID() {
 220         return id;
 221     }
 222
 223     /**
 224      * sets the id of the class
 225      *
 226      * @param id The id of the class
 227      */
 228     public void setModuleClassID(ModuleClassID id) {
 229         this.id = id;
 230     }
 231 }