|
Project JXTA | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.jxta.document.Advertisement
net.jxta.document.ExtendableAdvertisement
net.jxta.protocol.PeerGroupAdvertisement
public abstract class PeerGroupAdvertisement
Describes a peer group and references additional information required for instantiating it. The PeerGroup method newGroup performs the task of instantiating a PeerGroup given its advertisement (provided the required subsequent documents can actually be found).
ModuleSpecID
,
ModuleImplAdvertisement
,
PeerGroup
Constructor Summary | |
---|---|
PeerGroupAdvertisement()
|
Method Summary | |
---|---|
Object |
clone()
Clone this PeerGroupAdvertisement |
static String |
getAdvertisementType()
Returns the identifying type of this Advertisement. |
String |
getBaseAdvType()
Returns the base type of this advertisement hierarchy. |
String |
getDescription()
returns the description |
ID |
getID()
Returns a unique ID for indexing purposes. |
ModuleSpecID |
getModuleSpecID()
Returns the id of the group spec that this uses. |
String |
getName()
returns the name of the group. |
PeerGroupID |
getPeerGroupID()
Returns the id of the group. |
StructuredDocument |
getServiceParam(ID key)
Returns the parameter element that matches the given key from the service parameters table. |
Hashtable |
getServiceParams()
Returns the sets of parameters for all services. |
void |
putServiceParam(ID key,
Element param)
Puts a service parameter in the service parameters table under the given key. |
StructuredDocument |
removeServiceParam(ID key)
Removes and returns the parameter element that matches the given key from the service parameters table. |
void |
setDescription(String description)
sets the description |
void |
setModuleSpecID(ModuleSpecID sid)
Sets the id of the group spec that this peer group uses. |
void |
setName(String name)
sets the name of the group. |
void |
setPeerGroupID(PeerGroupID gid)
Sets the id of the group. |
void |
setServiceParams(Hashtable params)
sets the sets of parameters for all services. |
Methods inherited from class net.jxta.document.ExtendableAdvertisement |
---|
getDocument, handleElement |
Methods inherited from class net.jxta.document.Advertisement |
---|
getAdvType, getIndexFields, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PeerGroupAdvertisement()
Method Detail |
---|
public static String getAdvertisementType()
public final String getBaseAdvType()
final
.
getBaseAdvType
in class ExtendableAdvertisement
public Object clone()
clone
in class Advertisement
public String getName()
public void setName(String name)
name
- name of the group.public ModuleSpecID getModuleSpecID()
public void setModuleSpecID(ModuleSpecID sid)
sid
- The id of the specpublic PeerGroupID getPeerGroupID()
public void setPeerGroupID(PeerGroupID gid)
gid
- The id of this group.public ID getID()
getID
in class Advertisement
public String getDescription()
public void setDescription(String description)
description
- the descriptionpublic void setServiceParams(Hashtable params)
params
- The whole set of parameters.public Hashtable getServiceParams()
public void putServiceParam(ID key, Element param)
key
- The key.param
- The parameter, as an element. What is stored is a copy as
a standalone StructuredDocument which type is the element's name.public StructuredDocument getServiceParam(ID key)
key
- The key.
public StructuredDocument removeServiceParam(ID key)
key
- The key.
|
JXTA J2SE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |