Project JXTA

net.jxta.protocol
Class ModuleClassAdvertisement

java.lang.Object
  |
  +--net.jxta.document.Advertisement
        |
        +--net.jxta.protocol.ModuleClassAdvertisement
All Implemented Interfaces:
java.lang.Cloneable

public abstract class ModuleClassAdvertisement
extends Advertisement
implements java.lang.Cloneable

A ModuleClassAdvertisement describes a module class. Its main purpose is to formally document the existence of a module class.

See Also:
ModuleClassID

Constructor Summary
ModuleClassAdvertisement()
           
 
Method Summary
 java.lang.Object clone()
          Clone this ModuleClassAdvertisement
static java.lang.String getAdvertisementType()
          returns the advertisement type
 java.lang.String getDescription()
          returns the keywords/description associated with this class
 ID getID()
          returns a unique ID for that advertisement (for indexing purposes).
 ModuleClassID getModuleClassID()
          returns the id of the class
 java.lang.String getName()
          returns the name of the class
 void setDescription(java.lang.String description)
          sets the description associated with this class
 void setModuleClassID(ModuleClassID id)
          sets the id of the class
 void setName(java.lang.String name)
          sets the name of the class
 
Methods inherited from class net.jxta.document.Advertisement
getDocument
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModuleClassAdvertisement

public ModuleClassAdvertisement()
Method Detail

getAdvertisementType

public static java.lang.String getAdvertisementType()
returns the advertisement type
Returns:
string type
Since:
JXTA 1.0

clone

public java.lang.Object clone()
Clone this ModuleClassAdvertisement
Overrides:
clone in class Advertisement
Returns:
Object an object of class ModuleClassAdvertisement that is a deep-enough copy of this one.

getName

public java.lang.String getName()
returns the name of the class
Returns:
String name of the class
Since:
JXTA 1.0

setName

public void setName(java.lang.String name)
sets the name of the class
Parameters:
name - name of the class to be set
Since:
JXTA 1.0

getDescription

public java.lang.String getDescription()
returns the keywords/description associated with this class
Returns:
String keywords/description associated with the class
Since:
JXTA 1.0

setDescription

public void setDescription(java.lang.String description)
sets the description associated with this class
Parameters:
description -  
Since:
JXTA 1.0

getModuleClassID

public ModuleClassID getModuleClassID()
returns the id of the class
Returns:
ModuleClassID the class id
Since:
JXTA 1.0

setModuleClassID

public void setModuleClassID(ModuleClassID id)
sets the id of the class
Parameters:
id - The id of the class
Since:
JXTA 1.0

getID

public ID getID()
returns a unique ID for that advertisement (for indexing purposes). The classID uniquely identifies this adv.
Overrides:
getID in class Advertisement
Returns:
ID the class ID as a basic ID.
Since:
JXTA 1.0

Project JXTA