routeadvertisement.html

jxta的api库

      and is relatively unique between advertisements instances. For
      example, the Peer Advertisement returns the Peer ID.</li>

      <li>A static CodatID which is generated via some canonical process
      which will produce the same value each time and different values for
      different advertisements of the same type.</li>

      <li>ID.nullID for advertisement types which are not readily indexed.
      </li>
  </ul>

  <p/>Since this ID is normally used for indexing, the IDs returned must 
  be as unique as possible to avoid collisions.

  <p/>For Advertisement types which normally return non-ID.nullID values
  no ID should be returned when asked to generate an ID while the
  Advertisement is an inconsistent state (example: unitialized index
  fields). Instead <code>java.lang.IllegalStateException</code> should be
  thrown.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/jxta/document/Advertisement.html#getID()">getID</A></CODE> in class <CODE><A HREF="../../../net/jxta/document/Advertisement.html" title="class in net.jxta.document">Advertisement</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>ID An ID that uniquely identifies the advertisement or ID.nullID
  if this advertisement is of a type that is not normally indexed.</DL>
</DD>
</DL>
<HR>

<A NAME="getDest()"><!-- --></A><H3>
getDest</H3>
<PRE>
public <A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A> <B>getDest</B>()</PRE>
<DL>
<DD>Returns the destination access point
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>AccessPointAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="setDest(net.jxta.protocol.AccessPointAdvertisement)"><!-- --></A><H3>
setDest</H3>
<PRE>
public void <B>setDest</B>(<A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A>&nbsp;ap)</PRE>
<DL>
<DD>Sets the access point of the destination
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ap</CODE> - AccessPointAdvertisement of the destination peer</DL>
</DD>
</DL>
<HR>

<A NAME="getHops()"><!-- --></A><H3>
getHops</H3>
<PRE>
public java.util.Enumeration <B>getHops</B>()</PRE>
<DL>
<DD>returns the list of hops
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Enumeration list of hops as AccessPointAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="getVectorHops()"><!-- --></A><H3>
getVectorHops</H3>
<PRE>
public java.util.Vector <B>getVectorHops</B>()</PRE>
<DL>
<DD>returns the list of hops
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Vectorlist of hops as AccessPointAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="setHops(java.util.Vector)"><!-- --></A><H3>
setHops</H3>
<PRE>
public void <B>setHops</B>(java.util.Vector&nbsp;hopsAccess)</PRE>
<DL>
<DD>sets the list of hops associated with this route
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>hopsAccess</CODE> - Enumeration of hops as AccessPointAdvertisement
 The vector of hops is specified as a vector of AccessPoint
 advertisement.</DL>
</DD>
</DL>
<HR>

<A NAME="addDestEndpointAddresses(java.util.Vector)"><!-- --></A><H3>
addDestEndpointAddresses</H3>
<PRE>
public void <B>addDestEndpointAddresses</B>(java.util.Vector&nbsp;addresses)</PRE>
<DL>
<DD>add a new list of EndpointAddresses to the Route Destination access
 point
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addresses</CODE> - vector of endpoint addresses to add to the
 destination access point. Warning: The vector of endpoint addresses
 is specified as a vector of String. Each string representing
 one endpoint address.</DL>
</DD>
</DL>
<HR>

<A NAME="removeDestEndpointAddresses(java.util.Vector)"><!-- --></A><H3>
removeDestEndpointAddresses</H3>
<PRE>
public void <B>removeDestEndpointAddresses</B>(java.util.Vector&nbsp;addresses)</PRE>
<DL>
<DD>remove a list of EndpointAddresses from the Route Destination
 access point
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addresses</CODE> - vector of endpoint addresses to remove from the
 destination access point. Warning: The vector of endpoint addresses is
 specified as a vector of String. Each string representing one
 endpoint address.</DL>
</DD>
</DL>
<HR>

<A NAME="getFirstHop()"><!-- --></A><H3>
getFirstHop</H3>
<PRE>
public <A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A> <B>getFirstHop</B>()</PRE>
<DL>
<DD>Returns the access point for the first hop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>AccessPointAdvertisement first hop</DL>
</DD>
</DL>
<HR>

<A NAME="setFirstHop(net.jxta.protocol.AccessPointAdvertisement)"><!-- --></A><H3>
setFirstHop</H3>
<PRE>
public void <B>setFirstHop</B>(<A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A>&nbsp;ap)</PRE>
<DL>
<DD>Sets the access point for the first hop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ap</CODE> - AccessPointAdvertisement of the first hop</DL>
</DD>
</DL>
<HR>

<A NAME="getLastHop()"><!-- --></A><H3>
getLastHop</H3>
<PRE>
public <A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A> <B>getLastHop</B>()</PRE>
<DL>
<DD>Returns the access point for the last hop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>AccessPointAdvertisement last hop</DL>
</DD>
</DL>
<HR>

<A NAME="setLastHop(net.jxta.protocol.AccessPointAdvertisement)"><!-- --></A><H3>
setLastHop</H3>
<PRE>
public void <B>setLastHop</B>(<A HREF="../../../net/jxta/protocol/AccessPointAdvertisement.html" title="class in net.jxta.protocol">AccessPointAdvertisement</A>&nbsp;ap)</PRE>
<DL>
<DD>Sets the access point for the last hop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ap</CODE> - AccessPointAdvertisement of the last hop</DL>
</DD>
</DL>
<HR>

<A NAME="getDestPeerID()"><!-- --></A><H3>
getDestPeerID</H3>
<PRE>
public <A HREF="../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A> <B>getDestPeerID</B>()</PRE>
<DL>
<DD>Returns the route destination Peer ID
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>peerID of the destination of the route</DL>
</DD>
</DL>
<HR>

<A NAME="setDestPeerID(net.jxta.peer.PeerID)"><!-- --></A><H3>
setDestPeerID</H3>
<PRE>
public void <B>setDestPeerID</B>(<A HREF="../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A>&nbsp;pid)</PRE>
<DL>
<DD>Sets the route destination peer id
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pid</CODE> - route destination peerID</DL>
</DD>
</DL>
<HR>

<A NAME="setDestEndpointAddresses(java.util.Vector)"><!-- --></A><H3>
setDestEndpointAddresses</H3>
<PRE>
public void <B>setDestEndpointAddresses</B>(java.util.Vector&nbsp;ea)</PRE>
<DL>
<DD>Set the route destination endpoint addresses
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ea</CODE> - vector of endpoint addresses. Warning: The vector of endpoint
 addresses is specified as a vector of String. Each string
 representing one endpoint address.</DL>
</DD>
</DL>
<HR>

<A NAME="getDestEndpointAddresses()"><!-- --></A><H3>
getDestEndpointAddresses</H3>
<PRE>
public java.util.Vector <B>getDestEndpointAddresses</B>()</PRE>
<DL>
<DD>Return the endpoint addresses of the destination
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>vector of endpoint addresses. Warning: The vector of
 endpoint addresses is specified as a vector of String. Each string
 representing one endpoint address.</DL>
</DD>
</DL>
<HR>

<A NAME="containsHop(net.jxta.peer.PeerID)"><!-- --></A><H3>
containsHop</H3>
<PRE>
public boolean <B>containsHop</B>(<A HREF="../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A>&nbsp;pid)</PRE>
<DL>
<DD>Check if the route contains the following hop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pid</CODE> - peer id of the hop
<DT><B>Returns:</B><DD>boolean true or false if the hop is found in the route</DL>
</DD>
</DL>
<HR>

<A NAME="hasALoop()"><!-- --></A><H3>
hasALoop</H3>
<PRE>
public boolean <B>hasALoop</B>()</PRE>
<DL>
<DD>check if the route has a loop
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>boolean true or false if the route has a loop</DL>
</DD>
</DL>
<HR>

<A NAME="size()"><!-- --></A><H3>