net.jxta.impl.protocol
Class PipeAdv
java.lang.Object
net.jxta.document.Advertisement
net.jxta.document.ExtendableAdvertisement
net.jxta.protocol.PipeAdvertisement
net.jxta.impl.protocol.PipeAdv
- All Implemented Interfaces:
- Cloneable
public class PipeAdv
- extends PipeAdvertisement
This class implements the Pipe Advertisement according to the schema used by
the standard Pipe Binding Protocol. (PBP)
<xs:complexType name="PipeAdvertisement">
<xs:sequence>
<xs:element name="Id" type="jxta:JXTAID"/>
<xs:element name="Type" type="xs:string"/>
<xs:element name="Name" type="xs:string" minOccurs="0"/>
<xs:element name="Desc" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
- See Also:
PipeAdvertisement
,
PipeService
,
JXTA Protocols Specification : Pipe Binding Protocol
Nested Class Summary |
static class |
PipeAdv.Instantiator
AvertisementFactory instantiator for our type. |
Methods inherited from class net.jxta.protocol.PipeAdvertisement |
clone, equals, getAdvertisementType, getBaseAdvType, getDesc, getDescription, getID, getName, getPipeID, getType, hashCode, setDesc, setDescription, setName, setPipeID, setType |
getAdvType
public String getAdvType()
- Returns the identifying type of this Advertisement. Unlike
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.
- Overrides:
getAdvType
in class Advertisement
- Returns:
- The identifying type of this Advertisement.
handleElement
protected boolean handleElement(Element raw)
- Process an individual element from the document during parse. Normally,
implementations will allow the base advertisements a chance to handle
the element before attempting to handle the element themselves. ie.
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;
}
- Overrides:
handleElement
in class ExtendableAdvertisement
- Parameters:
raw
- The element to be processed.
- Returns:
true
if the element was recognized, otherwise false.
getDocument
public Document getDocument(MimeMediaType encodeAs)
- Write this advertisement into a document of the requested type. Two
standard document forms are defined.
"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.
getIndexFields
public String[] getIndexFields()
- Returns the element names on which this advertisement should be indexed.
- Specified by:
getIndexFields
in class Advertisement
- Returns:
- The element names on which this advertisement should be indexed.