Overview  Package   Class  Use  Deprecated  Index
Home >> All >> net >> jxta >> [ protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

net.jxta.protocol
Class ConfigParams  

java.lang.Object
  net.jxta.document.Advertisement
      net.jxta.document.ExtendableAdvertisement
          net.jxta.protocol.ConfigParams

---

public abstract class ConfigParams

extends net.jxta.document.ExtendableAdvertisement

A container for configuration parameters.

---

Field Summary
private static org.apache.log4j.Logger	LOG           Log4J Logger
private static java.lang.String	MCID_TAG
protected  int	modCount           Counts the changes made to this object.
private static java.lang.String	PARAM_TAG
private  java.util.Map	params           A table of structured documents to be interpreted by each service.
private static java.lang.String	SVC_TAG

 

Constructor Summary

ConfigParams()

 

Method Summary
boolean	addDocumentElements(net.jxta.document.StructuredDocument adv)           Return the advertisement as a document.
static java.lang.String	getAdvertisementType()           Returns the identifying type of this Advertisement.
java.lang.String	getBaseAdvType()           null
int	getModCount()           Returns the number of times this object has been modified since it was created.
net.jxta.document.StructuredDocument	getServiceParam(net.jxta.id.ID key)           Returns the parameter element that matches the given key from the service parameters table.
java.util.Set	getServiceParamsEntrySet()           Returns the set of params held by this object.
protected  boolean	handleElement(net.jxta.document.Element raw)           null
protected  int	incModCount()           Increases the modification count of the
void	putServiceParam(net.jxta.id.ID key, net.jxta.document.Element param)           Puts a service parameter in the service parameters table under the given key.
net.jxta.document.StructuredDocument	removeServiceParam(net.jxta.id.ID key)           Removes and returns the parameter element that matches the given key from the service parameters table.

 

Methods inherited from class net.jxta.document.ExtendableAdvertisement

getDocument

 

Methods inherited from class net.jxta.document.Advertisement

clone, getAdvType, getID, getIndexFields, toString

 

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

Log4J Logger

---

SVC_TAG

private static final java.lang.String SVC_TAG

See Also:

Constant Field Values

---

MCID_TAG

private static final java.lang.String MCID_TAG

See Also:

Constant Field Values

---

PARAM_TAG

private static final java.lang.String PARAM_TAG

See Also:

Constant Field Values

---

params

private java.util.Map params

A table of structured documents to be interpreted by each service. For safe operation these elements should be immutable, but we're helpless if they are not. Parameters for services associated with this peer. May be needed for invocation of those services.

---

modCount

protected transient volatile int modCount

Counts the changes made to this object. The API increments it every time some change is not proven to be idempotent. We rely on implementations to increment modCount every time something is changed without going through the API.

Constructor Detail

ConfigParams

public ConfigParams()

Method Detail

getModCount

public int getModCount()

Returns the number of times this object has been modified since it was created. This permits the detection of local changes that require refreshing some other data.

---

incModCount

protected int incModCount()

Increases the modification count of the

---

getAdvertisementType

public static java.lang.String getAdvertisementType()

Returns the identifying type of this Advertisement.

---

getBaseAdvType

public final java.lang.String getBaseAdvType()

null

---

putServiceParam

public void putServiceParam(net.jxta.id.ID key,
                            net.jxta.document.Element param)

Puts a service parameter in the service parameters table under the given key. The key is of a subclass of ID; usually a ModuleClassID. This method makes a deep copy of the given element into an independent document.

---

getServiceParam

public net.jxta.document.StructuredDocument getServiceParam(net.jxta.id.ID key)

Returns the parameter element that matches the given key from the service parameters table. The key is of a subclass of ID; usually a ModuleClassID.

---

removeServiceParam

public net.jxta.document.StructuredDocument removeServiceParam(net.jxta.id.ID key)

Removes and returns the parameter element that matches the given key from the service parameters table. The key is of a subclass of ID; usually a ModuleClassID.

---

getServiceParamsEntrySet

public java.util.Set getServiceParamsEntrySet()

Returns the set of params held by this object. The parameters are not copied and any changes to the Set are reflected in this object's version. incModCount should be called as appropriate.

---

handleElement

protected boolean handleElement(net.jxta.document.Element raw)

null

---

addDocumentElements

public boolean addDocumentElements(net.jxta.document.StructuredDocument adv)

Return the advertisement as a document.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> net >> jxta >> [ protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---