Project JXTA

net.jxta.impl.protocol
Class PlatformConfig

java.lang.Object
  extended by net.jxta.document.Advertisement
      extended by net.jxta.document.ExtendableAdvertisement
          extended by net.jxta.protocol.ConfigParams
              extended by net.jxta.impl.protocol.PlatformConfig

public final class PlatformConfig
extends ConfigParams

This type of advertisement is generated by configuration and serves to pass to all services their optional user-driven configuration. Some of which may be published as part of the above process. A PlatformConfig is not itself published.


Nested Class Summary
static class PlatformConfig.Instantiator
          Instantiator for PlatformConfig
 
Field Summary
 
Fields inherited from class net.jxta.protocol.ConfigParams
modCount
 
Constructor Summary
PlatformConfig()
          Use the Instantiator through the factory
PlatformConfig(Element root)
          Use the Instantiator through the factory
 
Method Summary
 Object clone()
          Make a safe clone of this PlatformConfig.
static String getAdvertisementType()
          returns the advertisement type
 String getAdvType()
          
 String getDebugLevel()
          returns the debugLevel
 StructuredDocument getDesc()
          returns the description
 String getDescription()
          returns the description
 Document getDocument(MimeMediaType encodeAs)
          
 ID getID()
          Returns a unique ID for that peer X group intersection.
 String[] getIndexFields()
          
 String getName()
          returns the name of the peer.
 PeerID getPeerID()
          Returns the id of the peer.
protected  boolean handleElement(Element raw)
          
 void setDebugLevel(String debugLevel)
          sets the debugLevel
 void setDesc(Element desc)
          sets the description
 void setDescription(String description)
          sets the description
 void setName(String name)
          sets the name of the peer.
 void setPeerID(PeerID pid)
          Sets the id of the peer.
 
Methods inherited from class net.jxta.protocol.ConfigParams
addDocumentElements, getBaseAdvType, getModCount, getServiceParam, getServiceParamsEntrySet, incModCount, putServiceParam, removeServiceParam
 
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
 

Constructor Detail

PlatformConfig

PlatformConfig()
Use the Instantiator through the factory


PlatformConfig

PlatformConfig(Element root)
Use the Instantiator through the factory

Method Detail

clone

public Object clone()
Make a safe clone of this PlatformConfig.

Overrides:
clone in class Advertisement
Returns:
Object an object of class PlatformConfig that is a deep-enough copy of this one.

getAdvertisementType

public static String getAdvertisementType()
returns the advertisement type

Returns:
string type

getAdvType

public String getAdvType()

Overrides:
getAdvType in class Advertisement

getName

public String getName()
returns the name of the peer.

Returns:
String name of the peer.
Since:
JXTA 1.0

setName

public void setName(String name)
sets the name of the peer.

Parameters:
name - name of the peer.
Since:
JXTA 1.0

getPeerID

public PeerID getPeerID()
Returns the id of the peer.

Returns:
PeerID the peer id
Since:
JXTA 1.0

setPeerID

public void setPeerID(PeerID pid)
Sets the id of the peer.

Parameters:
pid - the id of this peer.
Since:
JXTA 1.0

getID

public ID getID()
Returns a unique ID for that peer X group intersection. This is for indexing purposes only.

Specified by:
getID in class Advertisement

getDescription

public String getDescription()
returns the description

Returns:
String the description

setDescription

public void setDescription(String description)
sets the description

Parameters:
description - the description

getDesc

public StructuredDocument getDesc()
returns the description

Returns:
the description
Since:
JXTA 1.0

setDesc

public void setDesc(Element desc)
sets the description

Parameters:
desc - the description
Since:
JXTA 1.0

getDebugLevel

public String getDebugLevel()
returns the debugLevel

Returns:
String the debugLevel

setDebugLevel

public void setDebugLevel(String debugLevel)
sets the debugLevel

Parameters:
debugLevel - the debugLevel

handleElement

protected boolean handleElement(Element raw)

Overrides:
handleElement in class ConfigParams

getDocument

public Document getDocument(MimeMediaType encodeAs)

Overrides:
getDocument in class ExtendableAdvertisement

getIndexFields

public final String[] getIndexFields()

Specified by:
getIndexFields in class Advertisement

JXTA J2SE