|
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.protocol.PipeAdvertisement
public abstract class PipeAdvertisement
Describes a JXTA Pipe. A pipe is described by a pipe id and by a pipe type. A pipe can also optionally have a name and/or a description.
PipeService
,
JXTA Protocols Specification : Pipe Binding ProtocolField Summary | |
---|---|
static String |
descTag
XML tag to store the name of the Pipe |
static String |
IdTag
XML tag to store the PipeID |
static String |
NameTag
XML tag to store the name of the Pipe |
static String |
TypeTag
XML tag to store the Pipe Type |
Constructor Summary | |
---|---|
PipeAdvertisement()
|
Method Summary | |
---|---|
PipeAdvertisement |
clone()
|
boolean |
equals(Object obj)
|
static String |
getAdvertisementType()
Returns the identifying type of this Advertisement. |
String |
getBaseAdvType()
Returns the base type of this advertisement hierarchy. |
StructuredDocument |
getDesc()
Return the description meta-data for the pipe described by this advertisement. |
String |
getDescription()
Returns the description |
ID |
getID()
Returns an ID which identifies this Advertisement as uniquely as
possible. |
String |
getName()
Return the symbolic name for the pipe described by this advertisement. |
ID |
getPipeID()
Return the pipe ID for the pipe described by this advertisement. |
String |
getType()
Return the pipe type for the pipe described by this advertisement. |
int |
hashCode()
|
void |
setDesc(Element desc)
Set the description meta-data for the pipe described by this advertisement. |
void |
setDescription(String description)
Set the description meta-data for the pipe described by this advertisement. |
void |
setName(String name)
Set the symbolic name for the pipe described by this advertisement. |
void |
setPipeID(ID pipeId)
Set the pipe ID for the pipe described by this advertisement. |
void |
setType(String type)
Set the pipe type for the pipe described by this advertisement. |
Methods inherited from class net.jxta.document.ExtendableAdvertisement |
---|
getDocument, handleAttribute, handleElement |
Methods inherited from class net.jxta.document.Advertisement |
---|
getAdvType, getIndexFields, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String IdTag
public static final String TypeTag
public static final String NameTag
public static final String descTag
Constructor Detail |
---|
public PipeAdvertisement()
Method Detail |
---|
public static String getAdvertisementType()
public PipeAdvertisement clone()
clone
in class Advertisement
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
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.
The PipeID uniquely identifies this ADV.
getID
in class Advertisement
ID.nullID
if this advertisement is of a type that is not
normally indexed.public ID getPipeID()
public void setPipeID(ID pipeId)
pipeId
- The pipe ID for the pipe described by this advertisement.public String getType()
public void setType(String type)
type
- The pipe type for the pipe described by this advertisement.public String getName()
public void setName(String name)
name
- The symbolic name for the pipe described by this advertisement.public String getDescription()
public void setDescription(String description)
description
- The description meta-data for the pipe described by this advertisement.public StructuredDocument getDesc()
public void setDesc(Element desc)
desc
- The description meta-data for the pipe described by this advertisement.
|
JXSE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |