mirror of
https://github.com/vanitasvitae/Smack.git
synced 2025-12-16 07:51:08 +01:00
Substitute 'packet' with 'stanza(/packet)' in javadoc
This commit is contained in:
parent
0ca4e8b72a
commit
5e86db4f80
168 changed files with 650 additions and 650 deletions
|
|
@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub;
|
|||
import org.jivesoftware.smackx.xdata.Form;
|
||||
|
||||
/**
|
||||
* Generic packet extension which represents any pubsub form that is
|
||||
* Generic stanza(/packet) extension which represents any pubsub form that is
|
||||
* parsed from the incoming stream or being sent out to the server.
|
||||
*
|
||||
* Form types are defined in {@link FormNodeType}.
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@ public class LeafNode extends Node
|
|||
* Get items persisted on the node.
|
||||
* <p>
|
||||
* {@code additionalExtensions} can be used e.g. to add a "Result Set Management" extension.
|
||||
* {@code returnedExtensions} will be filled with the packet extensions found in the answer.
|
||||
* {@code returnedExtensions} will be filled with the stanza(/packet) extensions found in the answer.
|
||||
* </p>
|
||||
*
|
||||
* @param additionalExtensions additional {@code PacketExtensions} to be added to the request.
|
||||
|
|
@ -202,7 +202,7 @@ public class LeafNode extends Node
|
|||
* and {@link ConfigureForm#isDeliverPayloads()}=false.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
* stanza(/packet) has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send() send()}.
|
||||
* @throws NotConnectedException
|
||||
|
|
@ -223,7 +223,7 @@ public class LeafNode extends Node
|
|||
* publishes an event with NO item.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
* stanza(/packet) has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send(Item) send(Item))}.
|
||||
*
|
||||
|
|
@ -245,7 +245,7 @@ public class LeafNode extends Node
|
|||
* list will get stored on the node, assuming it stores the last sent item.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
* stanza(/packet) has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send(Collection) send(Collection))}.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -153,7 +153,7 @@ abstract public class Node
|
|||
* Get the subscriptions currently associated with this node.
|
||||
* <p>
|
||||
* {@code additionalExtensions} can be used e.g. to add a "Result Set Management" extension.
|
||||
* {@code returnedExtensions} will be filled with the packet extensions found in the answer.
|
||||
* {@code returnedExtensions} will be filled with the stanza(/packet) extensions found in the answer.
|
||||
* </p>
|
||||
*
|
||||
* @param additionalExtensions
|
||||
|
|
@ -193,11 +193,11 @@ abstract public class Node
|
|||
* </p>
|
||||
* <p>
|
||||
* {@code additionalExtensions} can be used e.g. to add a "Result Set Management" extension.
|
||||
* {@code returnedExtensions} will be filled with the packet extensions found in the answer.
|
||||
* {@code returnedExtensions} will be filled with the stanza(/packet) extensions found in the answer.
|
||||
* </p>
|
||||
*
|
||||
* @param additionalExtensions
|
||||
* @param returnedExtensions a collection that will be filled with the returned packet extensions
|
||||
* @param returnedExtensions a collection that will be filled with the returned stanza(/packet) extensions
|
||||
* @return List of {@link Subscription}
|
||||
* @throws NoResponseException
|
||||
* @throws XMPPErrorException
|
||||
|
|
@ -246,7 +246,7 @@ abstract public class Node
|
|||
* Get the affiliations of this node.
|
||||
* <p>
|
||||
* {@code additionalExtensions} can be used e.g. to add a "Result Set Management" extension.
|
||||
* {@code returnedExtensions} will be filled with the packet extensions found in the answer.
|
||||
* {@code returnedExtensions} will be filled with the stanza(/packet) extensions found in the answer.
|
||||
* </p>
|
||||
*
|
||||
* @param additionalExtensions additional {@code PacketExtensions} add to the request
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub;
|
|||
import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||
|
||||
/**
|
||||
* A packet extension representing the <b>options</b> element.
|
||||
* A stanza(/packet) extension representing the <b>options</b> element.
|
||||
*
|
||||
* @author Robin Collier
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ public class PubSub extends IQ
|
|||
/**
|
||||
* Returns the XML element name of the extension sub-packet root element.
|
||||
*
|
||||
* @return the XML element name of the packet extension.
|
||||
* @return the XML element name of the stanza(/packet) extension.
|
||||
*/
|
||||
public String getElementName() {
|
||||
return ELEMENT;
|
||||
|
|
@ -64,7 +64,7 @@ public class PubSub extends IQ
|
|||
/**
|
||||
* Returns the XML representation of a pubsub element according the specification.
|
||||
*
|
||||
* The XML representation will be inside of an iq packet like
|
||||
* The XML representation will be inside of an iq stanza(/packet) like
|
||||
* in the following example:
|
||||
* <pre>
|
||||
* <iq type='set' id="MlIpV-4" to="pubsub.gato.home" from="gato3@gato.home/Smack">
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import org.xmlpull.v1.XmlPullParser;
|
|||
import org.xmlpull.v1.XmlPullParserException;
|
||||
|
||||
/**
|
||||
* Parses the root pubsub packet extensions of the {@link IQ} packet and returns
|
||||
* Parses the root pubsub stanza(/packet) extensions of the {@link IQ} stanza(/packet) and returns
|
||||
* a {@link PubSub} instance.
|
||||
*
|
||||
* @author Robin Collier
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue