net.jxta.impl.content
Class AbstractPipeContentShareAdvertisement

java.lang.Object
  net.jxta.document.Advertisement
      net.jxta.document.ExtendableAdvertisement
          net.jxta.protocol.ContentShareAdvertisement
              net.jxta.impl.protocol.ContentShareAdvertisementImpl
                  net.jxta.impl.content.AbstractPipeContentShareAdvertisement

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DefaultContentShareAdvertisementImpl, SRDISocketContentShareAdvertisementImpl

public abstract class AbstractPipeContentShareAdvertisement
extends ContentShareAdvertisementImpl

An AbstractPipeContentShareAdvertisement describes a Content object which uses a Pipe advertisement to contact the possessor of the Content. The protocol used over the pipe is undefined at this point, hence the abstract nature of this class.

See Also:

Content, ContentAdvertisement, PipeAdvertisement

AbstractPipeContentShareAdvertisement

public AbstractPipeContentShareAdvertisement()

Construct a new AbstractPipeContentShareAdvertisement.

AbstractPipeContentShareAdvertisement

public AbstractPipeContentShareAdvertisement(Element root)

Construct a new AbstractPipeContentShareAdvertisement.

getPipeAdvertisement

public PipeAdvertisement getPipeAdvertisement()

Returns the PipeAdvertisement used to contact the Content possessor.

Returns:

pipe advertisement

setPipeAdvertisement

public void setPipeAdvertisement(PipeAdvertisement pipeAdvertisement)

Sets the PipeAdvertisement used to contact the Content possessor.

Parameters:

pipeAdvertisement - pipe advertisement

clone

public AbstractPipeContentShareAdvertisement clone()

Clone this AbstractPipeContentShareAdvertisement.

Overrides:

clone in class ContentShareAdvertisement

Returns:

a copy of this AbstractPipeContentShareAdvertisement

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 ContentShareAdvertisementImpl

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 ContentShareAdvertisementImpl

Parameters:

encodeAs - MimeMediaType format representation requested.

Returns:

The Advertisement represented as a Document of the requested MIME Media Type.