|
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.impl.protocol.PeerGroupConfigAdv
public final class PeerGroupConfigAdv
Defines Peer Group Runtime Configuration parameters.
This typically includes the peer group ID to use, the peer group name (if any) to use, and optional descriptive meta-data.
NetPeerGroupID=uuid-59313231343132314A484431544E504702
PeerGroupName=Network Infrastructure PeerGroup
PeerGroupDesc=Infrastructure Group Description
Nested Class Summary | |
---|---|
static class |
PeerGroupConfigAdv.Instantiator
Instantiator for PeerGroupConfigAdv |
Method Summary | |
---|---|
PeerGroupConfigAdv |
clone()
Make a safe clone of this PeerGroupConfigAdv. |
static String |
getAdvertisementType()
Returns the identifying type of this Advertisement. |
String |
getAdvType()
Returns the identifying type of this Advertisement. |
String |
getBaseAdvType()
Returns the base type of this advertisement hierarchy. |
XMLDocument |
getDesc()
returns the description |
String |
getDescription()
returns the description |
Document |
getDocument(MimeMediaType encodeAs)
Write this advertisement into a document of the requested type. |
ID |
getID()
Returns an ID which identifies this Advertisement as uniquely as
possible. |
String[] |
getIndexFields()
Returns the element names on which this advertisement should be indexed. |
String |
getName()
Gets the name to use for the peer group. |
ID |
getPeerGroupID()
Returns the id of the peer group. |
protected boolean |
handleElement(Element raw)
Process an individual element from the document during parse. |
void |
setDesc(XMLElement desc)
Sets the description |
void |
setDescription(String description)
sets the description |
void |
setName(String name)
Sets the name to use for the peer group. |
void |
setPeerGroupID(ID gid)
Sets the id of the peer group. |
Methods inherited from class net.jxta.document.ExtendableAdvertisement |
---|
handleAttribute |
Methods inherited from class net.jxta.document.Advertisement |
---|
toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static String getAdvertisementType()
Advertisement adv = module.getSomeAdv();
String advType = adv.getAdvertisementType();
This is wrong and does not work the way you might expect.
This call is not polymorphic and calls
Advertisement.getAdvertisementType() no matter what the real type of the
advertisement.
protected boolean handleElement(Element raw)
protected boolean handleElement(Element elem) {
if (super.handleElement()) {
// it's been handled.
return true;
}
... handle elements here ...
// we don't know how to handle the element
return false;
}
handleElement
in class ExtendableAdvertisement
raw
- The element to be processed.
true
if the element was recognized, otherwise false.public PeerGroupConfigAdv clone()
clone
in class Advertisement
public String getAdvType()
Advertisement.getAdvertisementType()
this method will return the correct
runtime type of an Advertisement object.
This implementation is provided for existing advertisements which do not
provide their own implementation. In most cases you should provide your
own implementation for efficiency reasons.
getAdvType
in class Advertisement
public final String getBaseAdvType()
final
.
getBaseAdvType
in class ExtendableAdvertisement
public ID getID()
Advertisement
as uniquely as
possible. This ID is typically used as the primary key for indexing of
the Advertisement within databases.
Each advertisement sub-class must choose an appropriate implementation
which returns canonical and relatively unique ID values for it's
instances. Since this ID is commonly used for indexing, the IDs returned
must be as unique as possible to avoid collisions. The value for the ID
returned can either be:
IllegalStateException
should be
thrown.
getID
in class Advertisement
ID.nullID
if this advertisement is of a type that is not
normally indexed.public Document getDocument(MimeMediaType encodeAs)
"text/plain"
encodes
the document in a "pretty-print" format for human viewing and
"text/xml" which provides an XML format.
We don't have any content to add, just build the document instance and
return it to implementations that actually do something with it.
- Overrides:
getDocument
in class ExtendableAdvertisement
- Parameters:
encodeAs
- MimeMediaType format representation requested.
- Returns:
- The
Advertisement
represented as a Document
of
the requested MIME Media Type.
public String[] getIndexFields()
getIndexFields
in class Advertisement
public ID getPeerGroupID()
public void setPeerGroupID(ID gid)
gid
- The id of this group.public String getName()
public void setName(String name)
name
- The new name valuepublic String getDescription()
public void setDescription(String description)
description
- the descriptionpublic XMLDocument getDesc()
public void setDesc(XMLElement desc)
desc
- the description
|
JXSE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |