|
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.ModuleImplAdvertisement
public abstract class ModuleImplAdvertisement
A ModuleImplAdvertisement describes one of any number of published implementations for a given specification.
Module specifications are referenced by their ModuleSpecID. Given a ModuleSpecID, a ModuleImplAdvertisement may be searched by means of JXTA Discovery, filtered according to the compatibility statement it contains, and if compatible, loaded and initialized. TheloadModule()
method of
PeerGroup performs this task automatically, given a ModuleSpecID.
One significant example of Modules referenced and loaded in that manner are
the services and protocols that constitute a StdPeerGroup in the Java
reference implementation.
ID
,
ModuleSpecID
,
Advertisement
,
StructuredDocument
,
Element
,
ModuleSpecAdvertisement
,
PeerGroup
Constructor Summary | |
---|---|
ModuleImplAdvertisement()
|
Method Summary | |
---|---|
ModuleImplAdvertisement |
clone()
Clone this ModuleImplAdvertisement |
static String |
getAdvertisementType()
Returns the identifying type of this Advertisement. |
String |
getBaseAdvType()
Returns the base type of this advertisement hierarchy. |
String |
getCode()
returns the code; a reference to or representation of the executable code advertised by this advertisement. |
StructuredDocument |
getCompat()
Returns the opaque compatibility statement for this advertisement. |
protected StructuredDocument |
getCompatPriv()
Privileged version of getCompat() that does not clone the elements. |
StructuredDocument |
getDesc()
returns the description |
StructuredDocument |
getDescPriv()
Privileged version of getDesc() that does not clone the elements. |
String |
getDescription()
returns the description |
ID |
getID()
Returns the unique ID of that advertisement for indexing purposes. |
ModuleSpecID |
getModuleSpecID()
Returns the id of the spec that this implements. |
StructuredDocument |
getParam()
returns the param element. |
protected StructuredDocument |
getParamPriv()
Privileged version of getParam() that does not clone the elements. |
String |
getProvider()
returns the provider |
String |
getUri()
returns the uri; that is a reference to or representation of a package from which the executable code referenced by the getCode method may be loaded. |
void |
setCode(String code)
Sets the reference for the executable code described by this advertisement. |
void |
setCompat(Element compat)
Sets the module impl. compatibility statement. |
void |
setDesc(Element desc)
sets the description |
void |
setDescription(String description)
sets the description |
void |
setModuleSpecID(ModuleSpecID msid)
Sets the id of the spec that is implemented |
void |
setParam(Element param)
Sets the module param |
void |
setProvider(String provider)
sets the provider |
void |
setUri(String uri)
Sets the uri |
Methods inherited from class net.jxta.document.ExtendableAdvertisement |
---|
getDocument, handleAttribute, 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 ModuleImplAdvertisement()
Method Detail |
---|
public static String getAdvertisementType()
public final String getBaseAdvType()
final
.
getBaseAdvType
in class ExtendableAdvertisement
public ModuleImplAdvertisement clone()
clone
in class Advertisement
public ID getID()
getID
in class Advertisement
public ModuleSpecID getModuleSpecID()
public void setModuleSpecID(ModuleSpecID msid)
msid
- The id of the specpublic String getDescription()
public void setDescription(String description)
description
- the descriptionpublic StructuredDocument getDesc()
public StructuredDocument getDescPriv()
getDesc()
that does not clone the elements.
public void setDesc(Element desc)
desc
- the descriptionpublic StructuredDocument getCompat()
protected StructuredDocument getCompatPriv()
getCompat()
that does not clone the elements.
public void setCompat(Element compat)
compat
- Element of an unspecified content.public String getCode()
public void setCode(String code)
code
- A reference to the executable code described by this
advertisement.public String getUri()
public void setUri(String uri)
uri
- Location URI for the code described by this advertisement.public String getProvider()
public void setProvider(String provider)
provider
- the providerpublic StructuredDocument getParam()
protected StructuredDocument getParamPriv()
getParam()
that does not clone the elements.
public void setParam(Element param)
param
- Element of an unspecified content.
|
JXSE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |