mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2024-11-26 08:12:05 +01:00
javadoc: s/packet/stanza/
This commit is contained in:
parent
164b7c6690
commit
9ac3633612
7 changed files with 11 additions and 11 deletions
|
@ -302,7 +302,7 @@ public class PacketCollector {
|
||||||
* Set the stanza filter used by this collector. If <code>null</code>, then all stanzas will
|
* Set the stanza filter used by this collector. If <code>null</code>, then all stanzas will
|
||||||
* get collected by this collector.
|
* get collected by this collector.
|
||||||
*
|
*
|
||||||
* @param packetFilter
|
* @param stanzaFilter
|
||||||
* @return a reference to this configuration.
|
* @return a reference to this configuration.
|
||||||
*/
|
*/
|
||||||
public Configuration setStanzaFilter(StanzaFilter stanzaFilter) {
|
public Configuration setStanzaFilter(StanzaFilter stanzaFilter) {
|
||||||
|
|
|
@ -166,7 +166,7 @@ public interface XMPPConnection {
|
||||||
/**
|
/**
|
||||||
* Sends the specified stanza to the server.
|
* Sends the specified stanza to the server.
|
||||||
*
|
*
|
||||||
* @param packet the stanza to send.
|
* @param stanza the stanza to send.
|
||||||
* @throws NotConnectedException if the connection is not connected.
|
* @throws NotConnectedException if the connection is not connected.
|
||||||
*/
|
*/
|
||||||
public void sendStanza(Stanza stanza) throws NotConnectedException;
|
public void sendStanza(Stanza stanza) throws NotConnectedException;
|
||||||
|
@ -468,7 +468,7 @@ public interface XMPPConnection {
|
||||||
* has been elapsed.
|
* has been elapsed.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packet the stanza to send (required)
|
* @param stanza the stanza to send (required)
|
||||||
* @param replyFilter the filter used to determine response stanza (required)
|
* @param replyFilter the filter used to determine response stanza (required)
|
||||||
* @param callback the callback invoked if there is a response (required)
|
* @param callback the callback invoked if there is a response (required)
|
||||||
* @throws NotConnectedException
|
* @throws NotConnectedException
|
||||||
|
@ -484,7 +484,7 @@ public interface XMPPConnection {
|
||||||
* with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
|
* with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packet the stanza to send (required)
|
* @param stanza the stanza to send (required)
|
||||||
* @param replyFilter the filter used to determine response stanza (required)
|
* @param replyFilter the filter used to determine response stanza (required)
|
||||||
* @param callback the callback invoked if there is a response (required)
|
* @param callback the callback invoked if there is a response (required)
|
||||||
* @param exceptionCallback the callback invoked if there is an exception (optional)
|
* @param exceptionCallback the callback invoked if there is an exception (optional)
|
||||||
|
@ -501,7 +501,7 @@ public interface XMPPConnection {
|
||||||
* with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
|
* with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packet the stanza to send (required)
|
* @param stanza the stanza to send (required)
|
||||||
* @param replyFilter the filter used to determine response stanza (required)
|
* @param replyFilter the filter used to determine response stanza (required)
|
||||||
* @param callback the callback invoked if there is a response (required)
|
* @param callback the callback invoked if there is a response (required)
|
||||||
* @param exceptionCallback the callback invoked if there is an exception (optional)
|
* @param exceptionCallback the callback invoked if there is an exception (optional)
|
||||||
|
|
|
@ -51,7 +51,7 @@ public interface StanzaFilter {
|
||||||
/**
|
/**
|
||||||
* Tests whether or not the specified stanza should pass the filter.
|
* Tests whether or not the specified stanza should pass the filter.
|
||||||
*
|
*
|
||||||
* @param packet the stanza(/packet) to test.
|
* @param stanza the stanza(/packet) to test.
|
||||||
* @return true if and only if <tt>stanza</tt> passes the filter.
|
* @return true if and only if <tt>stanza</tt> passes the filter.
|
||||||
*/
|
*/
|
||||||
public boolean accept(Stanza stanza);
|
public boolean accept(Stanza stanza);
|
||||||
|
|
|
@ -32,7 +32,7 @@ public class StanzaIdFilter implements StanzaFilter {
|
||||||
/**
|
/**
|
||||||
* Creates a new stanza ID filter using the specified stanza's ID.
|
* Creates a new stanza ID filter using the specified stanza's ID.
|
||||||
*
|
*
|
||||||
* @param packet the stanza which the ID is taken from.
|
* @param stanza the stanza which the ID is taken from.
|
||||||
*/
|
*/
|
||||||
public StanzaIdFilter(Stanza stanza) {
|
public StanzaIdFilter(Stanza stanza) {
|
||||||
this(stanza.getStanzaId());
|
this(stanza.getStanzaId());
|
||||||
|
@ -41,7 +41,7 @@ public class StanzaIdFilter implements StanzaFilter {
|
||||||
/**
|
/**
|
||||||
* Creates a new stanza ID filter using the specified stanza ID.
|
* Creates a new stanza ID filter using the specified stanza ID.
|
||||||
*
|
*
|
||||||
* @param packetID the stanza ID to filter for.
|
* @param stanzaID the stanza ID to filter for.
|
||||||
*/
|
*/
|
||||||
public StanzaIdFilter(String stanzaID) {
|
public StanzaIdFilter(String stanzaID) {
|
||||||
this.stanzaId = StringUtils.requireNotNullOrEmpty(stanzaID, "Stanza ID must not be null or empty.");
|
this.stanzaId = StringUtils.requireNotNullOrEmpty(stanzaID, "Stanza ID must not be null or empty.");
|
||||||
|
|
|
@ -37,7 +37,7 @@ public abstract class ParsingExceptionCallback {
|
||||||
/**
|
/**
|
||||||
* Called when parsing an message stanza caused an exception.
|
* Called when parsing an message stanza caused an exception.
|
||||||
*
|
*
|
||||||
* @param packetData
|
* @param stanzaData
|
||||||
* the raw message stanza data that caused the exception
|
* the raw message stanza data that caused the exception
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -377,7 +377,7 @@ public class InBandBytestreamManager implements BytestreamManager {
|
||||||
* The use of {@link StanzaType#IQ} is recommended. See <a
|
* The use of {@link StanzaType#IQ} is recommended. See <a
|
||||||
* href="http://xmpp.org/extensions/xep-0047.html#message">XEP-0047</a> Section 4.
|
* href="http://xmpp.org/extensions/xep-0047.html#message">XEP-0047</a> Section 4.
|
||||||
*
|
*
|
||||||
* @param packet the stanza to set
|
* @param stanza the stanza to set
|
||||||
*/
|
*/
|
||||||
public void setStanza(StanzaType stanza) {
|
public void setStanza(StanzaType stanza) {
|
||||||
this.stanza = stanza;
|
this.stanza = stanza;
|
||||||
|
|
|
@ -51,7 +51,7 @@ public class Open extends IQ {
|
||||||
*
|
*
|
||||||
* @param sessionID unique session ID identifying this In-Band Bytestream
|
* @param sessionID unique session ID identifying this In-Band Bytestream
|
||||||
* @param blockSize block size in which the data will be fragmented
|
* @param blockSize block size in which the data will be fragmented
|
||||||
* @param packet stanza type used to encapsulate the data
|
* @param stanza stanza type used to encapsulate the data
|
||||||
*/
|
*/
|
||||||
public Open(String sessionID, int blockSize, StanzaType stanza) {
|
public Open(String sessionID, int blockSize, StanzaType stanza) {
|
||||||
super(ELEMENT, NAMESPACE);
|
super(ELEMENT, NAMESPACE);
|
||||||
|
|
Loading…
Reference in a new issue