From 5e86db4f8047541b5a35f054b8e7897699b70a6e Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Sat, 21 Mar 2015 09:36:28 +0100 Subject: [PATCH] Substitute 'packet' with 'stanza(/packet)' in javadoc --- .../smack/bosh/XMPPBOSHConnection.java | 4 +- .../java/org/jivesoftware/smack/IQTest.java | 2 +- .../smack/filter/PacketIDFilterTest.java | 2 +- .../jivesoftware/smack/packet/MockPacket.java | 2 +- .../smack/AbstractXMPPConnection.java | 52 +++---- .../jivesoftware/smack/PacketCollector.java | 48 +++--- .../smack/SmackConfiguration.java | 4 +- .../jivesoftware/smack/SmackException.java | 4 +- .../jivesoftware/smack/StanzaListener.java | 6 +- .../jivesoftware/smack/XMPPConnection.java | 146 +++++++++--------- .../smack/debugger/SmackDebugger.java | 2 +- .../jivesoftware/smack/filter/AndFilter.java | 2 +- .../smack/filter/FromMatchesFilter.java | 10 +- .../smack/filter/IQReplyFilter.java | 4 +- .../smack/filter/IQTypeFilter.java | 2 +- .../jivesoftware/smack/filter/NotFilter.java | 2 +- .../jivesoftware/smack/filter/OrFilter.java | 2 +- .../smack/filter/PacketExtensionFilter.java | 16 +- .../smack/filter/PacketFilter.java | 14 +- .../smack/filter/PacketIDFilter.java | 10 +- .../smack/filter/PacketTypeFilter.java | 2 +- .../smack/filter/PresenceTypeFilter.java | 2 +- .../smack/filter/StanzaFilter.java | 2 +- .../smack/filter/StanzaIdFilter.java | 4 +- .../smack/filter/StanzaTypeFilter.java | 2 +- .../smack/packet/AbstractError.java | 6 +- .../org/jivesoftware/smack/packet/Bind.java | 4 +- .../smack/packet/DefaultExtensionElement.java | 14 +- .../jivesoftware/smack/packet/Element.java | 4 +- .../org/jivesoftware/smack/packet/IQ.java | 16 +- .../smack/packet/NamedElement.java | 2 +- .../org/jivesoftware/smack/packet/Packet.java | 62 ++++---- .../jivesoftware/smack/packet/Presence.java | 6 +- .../jivesoftware/smack/packet/Session.java | 2 +- .../org/jivesoftware/smack/packet/Stanza.java | 58 +++---- .../jivesoftware/smack/packet/XMPPError.java | 4 +- .../parsing/ParsingExceptionCallback.java | 4 +- .../smack/provider/ExtensionProviderInfo.java | 2 +- .../smack/provider/ProviderManager.java | 18 +-- .../smack/util/PacketParserUtils.java | 4 +- .../jivesoftware/smack/DummyConnection.java | 12 +- .../smack/ThreadedDummyConnection.java | 4 +- .../smackx/debugger/EnhancedDebugger.java | 12 +- .../smackx/carbons/CarbonManager.java | 2 +- .../carbons/packet/CarbonExtension.java | 6 +- .../provider/CarbonManagerProvider.java | 2 +- .../smackx/gcm/packet/GcmPacketExtension.java | 4 +- .../smackx/hoxt/packet/Base64BinaryChunk.java | 2 +- .../AbstractHttpOverXmppProvider.java | 2 +- .../provider/Base64BinaryChunkProvider.java | 2 +- .../provider/HttpOverXmppReqProvider.java | 2 +- .../provider/HttpOverXmppRespProvider.java | 2 +- .../json/packet/JsonPacketExtension.java | 4 +- .../smackx/address/MultipleRecipientInfo.java | 4 +- .../address/MultipleRecipientManager.java | 36 ++--- .../address/packet/MultipleAddresses.java | 8 +- .../smackx/amp/packet/AMPExtension.java | 4 +- .../amp/provider/AMPExtensionProvider.java | 2 +- .../smackx/bytestreams/ibb/DataListener.java | 4 +- .../ibb/InBandBytestreamManager.java | 14 +- .../ibb/InBandBytestreamSession.java | 22 +-- .../smackx/bytestreams/ibb/packet/Data.java | 6 +- .../ibb/packet/DataPacketExtension.java | 8 +- .../smackx/bytestreams/ibb/packet/Open.java | 2 +- .../ibb/provider/DataPacketProvider.java | 2 +- .../socks5/Socks5BytestreamManager.java | 10 +- .../socks5/Socks5ClientForInitiator.java | 2 +- .../bytestreams/socks5/packet/Bytestream.java | 14 +- .../smackx/caps/EntityCapsManager.java | 2 +- .../cache/SimpleDirectoryPersistentCache.java | 4 +- .../smackx/chatstates/ChatStateManager.java | 4 +- .../smackx/commands/AdHocCommandManager.java | 4 +- .../smackx/delay/packet/DelayInformation.java | 14 +- .../smackx/disco/NodeInformationProvider.java | 4 +- .../smackx/disco/ServiceDiscoveryManager.java | 10 +- .../filetransfer/FileTransferNegotiator.java | 2 +- .../filetransfer/FileTransferRequest.java | 4 +- .../smackx/filetransfer/StreamNegotiator.java | 2 +- .../smackx/forward/packet/Forwarded.java | 14 +- .../forward/provider/ForwardedProvider.java | 2 +- .../smackx/iqlast/LastActivityManager.java | 6 +- .../smackx/iqprivate/PrivateDataManager.java | 2 +- .../iqprivate/packet/DefaultPrivateData.java | 4 +- .../smackx/iqregister/AccountManager.java | 4 +- .../jiveproperties/JivePropertiesManager.java | 8 +- .../packet/JivePropertiesExtension.java | 4 +- .../JivePropertiesExtensionProvider.java | 2 +- .../smackx/muc/MultiUserChat.java | 26 ++-- .../org/jivesoftware/smackx/muc/RoomInfo.java | 2 +- .../muc/packet/GroupChatInvitation.java | 8 +- .../smackx/muc/packet/MUCAdmin.java | 2 +- .../smackx/muc/packet/MUCOwner.java | 2 +- .../smackx/muc/packet/MUCUser.java | 4 +- .../smackx/muc/provider/MUCUserProvider.java | 2 +- .../offline/packet/OfflineMessageInfo.java | 6 +- .../smackx/pep/packet/PEPEvent.java | 4 +- .../smackx/pep/packet/PEPItem.java | 4 +- .../smackx/pep/provider/PEPProvider.java | 2 +- .../smackx/privacy/PrivacyListManager.java | 8 +- .../smackx/privacy/packet/PrivacyItem.java | 2 +- .../jivesoftware/smackx/pubsub/FormNode.java | 2 +- .../jivesoftware/smackx/pubsub/LeafNode.java | 8 +- .../org/jivesoftware/smackx/pubsub/Node.java | 8 +- .../smackx/pubsub/OptionsExtension.java | 2 +- .../smackx/pubsub/packet/PubSub.java | 4 +- .../pubsub/provider/PubSubProvider.java | 2 +- .../receipts/DeliveryReceiptManager.java | 4 +- .../receipts/ReceiptReceivedListener.java | 2 +- .../smackx/search/ReportedData.java | 4 +- .../sharedgroups/packet/SharedGroupsInfo.java | 2 +- .../org/jivesoftware/smackx/xdata/Form.java | 6 +- .../smackx/xdata/packet/DataForm.java | 2 +- .../smackx/xhtmlim/packet/XHTMLExtension.java | 4 +- .../bytestreams/ibb/DataListenerTest.java | 2 +- .../InBandBytestreamSessionMessageTest.java | 2 +- .../ibb/InBandBytestreamSessionTest.java | 6 +- .../bytestreams/socks5/Socks5PacketUtils.java | 6 +- .../jivesoftware/util/ConnectionUtils.java | 4 +- .../java/org/jivesoftware/util/Protocol.java | 8 +- .../org/jivesoftware/smack/chat/Chat.java | 4 +- .../smackx/jingleold/JingleManager.java | 4 +- .../smackx/jingleold/JingleNegotiator.java | 8 +- .../smackx/jingleold/JingleSession.java | 34 ++-- .../jingleold/JingleSessionRequest.java | 4 +- .../jingleold/media/MediaNegotiator.java | 8 +- .../jingleold/mediaimpl/jmf/AudioChannel.java | 4 +- .../jingleold/nat/DatagramListener.java | 4 +- .../smackx/jingleold/nat/RTPBridge.java | 16 +- .../smackx/jingleold/nat/STUN.java | 10 +- .../jingleold/nat/TransportNegotiator.java | 12 +- .../smackx/jingleold/packet/Jingle.java | 6 +- .../smackx/workgroup/MetaData.java | 6 +- .../smackx/workgroup/agent/AgentSession.java | 2 +- .../smackx/workgroup/agent/Offer.java | 4 +- .../workgroup/agent/OfferConfirmation.java | 2 +- .../workgroup/ext/forms/WorkgroupForm.java | 4 +- .../ext/history/AgentChatHistory.java | 6 +- .../workgroup/ext/history/ChatMetadata.java | 4 +- .../smackx/workgroup/ext/macros/Macros.java | 4 +- .../smackx/workgroup/ext/notes/ChatNotes.java | 6 +- .../smackx/workgroup/packet/AgentInfo.java | 6 +- .../smackx/workgroup/packet/AgentStatus.java | 6 +- .../workgroup/packet/AgentStatusRequest.java | 10 +- .../workgroup/packet/DepartQueuePacket.java | 4 +- .../workgroup/packet/MonitorPacket.java | 6 +- .../workgroup/packet/OccupantsInfo.java | 8 +- .../smackx/workgroup/packet/QueueDetails.java | 8 +- .../workgroup/packet/QueueOverview.java | 4 +- .../smackx/workgroup/packet/QueueUpdate.java | 6 +- .../workgroup/packet/RoomInvitation.java | 6 +- .../smackx/workgroup/packet/RoomTransfer.java | 6 +- .../smackx/workgroup/packet/SessionID.java | 4 +- .../workgroup/packet/TranscriptSearch.java | 6 +- .../smackx/workgroup/packet/UserID.java | 4 +- .../packet/WorkgroupInformation.java | 8 +- .../workgroup/settings/ChatSettings.java | 6 +- .../workgroup/settings/GenericSettings.java | 6 +- .../workgroup/settings/OfflineSettings.java | 6 +- .../workgroup/settings/SearchSettings.java | 6 +- .../workgroup/settings/SoundSettings.java | 6 +- .../settings/WorkgroupProperties.java | 6 +- .../smackx/workgroup/user/Workgroup.java | 2 +- .../smackx/xevent/packet/MessageEvent.java | 8 +- .../xevent/provider/MessageEventProvider.java | 2 +- .../smackx/xroster/packet/RosterExchange.java | 4 +- .../provider/RosterExchangeProvider.java | 2 +- .../smack/tcp/XMPPTCPConnection.java | 8 +- .../smack/tcp/PacketWriterTest.java | 2 +- 168 files changed, 650 insertions(+), 650 deletions(-) diff --git a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java index ded19e207..14050b037 100644 --- a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java +++ b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java @@ -275,7 +275,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { * Closes the connection by setting presence to unavailable and closing the * HTTP client. The shutdown logic will be used during a planned disconnection or when * dealing with an unexpected disconnection. Unlike {@link #disconnect()} the connection's - * BOSH packet reader will not be removed; thus connection's state is kept. + * BOSH stanza(/packet) reader will not be removed; thus connection's state is kept. * */ @Override @@ -476,7 +476,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { /** * Listens for XML traffic from the BOSH connection manager and parses it into - * packet objects. + * stanza(/packet) objects. * * @author Guenther Niess */ diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java index 29ae721c3..e626dc04d 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java @@ -37,7 +37,7 @@ public class IQTest extends SmackTestCase { } /** - * Check that the server responds a 503 error code when the client sends an IQ packet with an + * Check that the server responds a 503 error code when the client sends an IQ stanza(/packet) with an * invalid namespace. */ public void testInvalidNamespace() { diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/filter/PacketIDFilterTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/filter/PacketIDFilterTest.java index a86573120..b6a6dc8ff 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/filter/PacketIDFilterTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/filter/PacketIDFilterTest.java @@ -49,7 +49,7 @@ public class PacketIDFilterTest extends TestCase { } /** - * Wraps the MockPacket class to always give an expected packet ID field. + * Wraps the MockPacket class to always give an expected stanza(/packet) ID field. */ private class MockIDPacket extends MockPacket { private String id; diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/MockPacket.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/MockPacket.java index 11fc2b156..5d115a20c 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/MockPacket.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/MockPacket.java @@ -18,7 +18,7 @@ package org.jivesoftware.smack.packet; /** - * A mock implementation of the Packet abstract class. Implements toXML() by returning null. + * A mock implementation of the Stanza(/Packet) abstract class. Implements toXML() by returning null. */ public class MockPacket extends Packet { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java index 79eef043c..8502357ec 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java @@ -128,24 +128,24 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { private final Collection collectors = new ConcurrentLinkedQueue(); /** - * List of PacketListeners that will be notified synchronously when a new packet was received. + * List of PacketListeners that will be notified synchronously when a new stanza(/packet) was received. */ private final Map syncRecvListeners = new LinkedHashMap<>(); /** - * List of PacketListeners that will be notified asynchronously when a new packet was received. + * List of PacketListeners that will be notified asynchronously when a new stanza(/packet) was received. */ private final Map asyncRecvListeners = new LinkedHashMap<>(); /** - * List of PacketListeners that will be notified when a new packet was sent. + * List of PacketListeners that will be notified when a new stanza(/packet) was sent. */ private final Map sendListeners = new HashMap(); /** - * List of PacketListeners that will be notified when a new packet is about to be - * sent to the server. These interceptors may modify the packet before it is being + * List of PacketListeners that will be notified when a new stanza(/packet) is about to be + * sent to the server. These interceptors may modify the stanza(/packet) before it is being * actually sent to the server. */ private final Map interceptors = @@ -260,7 +260,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { ); /** - * A executor service used to invoke the callbacks of synchronous packet listeners. We use a executor service to + * A executor service used to invoke the callbacks of synchronous stanza(/packet) listeners. We use a executor service to * decouple incoming stanza processing from callback invocation. It is important that order of callback invocation * is the same as the order of the incoming stanzas. Therefore we use a single threaded executor service. */ @@ -376,7 +376,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Logs in to the server using the strongest SASL mechanism supported by - * the server. If more than the connection's default packet timeout elapses in each step of the + * the server. If more than the connection's default stanza(/packet) timeout elapses in each step of the * authentication process without a response from the server, a * {@link SmackException.NoResponseException} will be thrown. *

@@ -655,10 +655,10 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * by closing the stream. The XMPPConnection can still be used for connecting to the server * again. A custom unavailable presence is useful for communicating offline presence * information such as "On vacation". Typically, just the status text of the presence - * packet is set with online information, but most XMPP servers will deliver the full - * presence packet with whatever data is set. + * stanza(/packet) is set with online information, but most XMPP servers will deliver the full + * presence stanza(/packet) with whatever data is set. * - * @param unavailablePresence the presence packet to send during shutdown. + * @param unavailablePresence the presence stanza(/packet) to send during shutdown. * @throws NotConnectedException */ public synchronized void disconnect(Presence unavailablePresence) throws NotConnectedException { @@ -795,12 +795,12 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * Process all packet listeners for sending packets. + * Process all stanza(/packet) listeners for sending packets. *

* Compared to {@link #firePacketInterceptors(Stanza)}, the listeners will be invoked in a new thread. *

* - * @param packet the packet to process. + * @param packet the stanza(/packet) to process. */ @SuppressWarnings("javadoc") protected void firePacketSendingListeners(final Stanza packet) { @@ -851,12 +851,12 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * Process interceptors. Interceptors may modify the packet that is about to be sent. - * Since the thread that requested to send the packet will invoke all interceptors, it + * Process interceptors. Interceptors may modify the stanza(/packet) that is about to be sent. + * Since the thread that requested to send the stanza(/packet) will invoke all interceptors, it * is important that interceptors perform their work as soon as possible so that the * thread does not remain blocked for a long period. * - * @param packet the packet that is going to be sent to the server + * @param packet the stanza(/packet) that is going to be sent to the server */ private void firePacketInterceptors(Stanza packet) { List interceptorsToInvoke = new LinkedList(); @@ -962,11 +962,11 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * Processes a packet after it's been fully parsed by looping through the installed - * packet collectors and listeners and letting them examine the packet to see if + * Processes a stanza(/packet) after it's been fully parsed by looping through the installed + * stanza(/packet) collectors and listeners and letting them examine the stanza(/packet) to see if * they are a match with the filter. * - * @param packet the packet to process. + * @param packet the stanza(/packet) to process. */ protected void processPacket(Stanza packet) { assert(packet != null); @@ -976,7 +976,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * A runnable to notify all listeners and packet collectors of a packet. + * A runnable to notify all listeners and stanza(/packet) collectors of a packet. */ private class ListenerNotification implements Runnable { @@ -993,9 +993,9 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Invoke {@link PacketCollector#processPacket(Stanza)} for every - * PacketCollector with the given packet. Also notify the receive listeners with a matching packet filter about the packet. + * PacketCollector with the given packet. Also notify the receive listeners with a matching stanza(/packet) filter about the packet. * - * @param packet the packet to notify the PacketCollectors and receive listeners about. + * @param packet the stanza(/packet) to notify the PacketCollectors and receive listeners about. */ protected void invokePacketCollectorsAndNotifyRecvListeners(final Stanza packet) { if (packet instanceof IQ) { @@ -1210,7 +1210,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * A wrapper class to associate a packet filter with a listener. + * A wrapper class to associate a stanza(/packet) filter with a listener. */ protected static class ListenerWrapper { @@ -1218,9 +1218,9 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { private final StanzaFilter packetFilter; /** - * Create a class which associates a packet filter with a listener. + * Create a class which associates a stanza(/packet) filter with a listener. * - * @param packetListener the packet listener. + * @param packetListener the stanza(/packet) listener. * @param packetFilter the associated filter or null if it listen for all packets. */ public ListenerWrapper(StanzaListener packetListener, StanzaFilter packetFilter) { @@ -1238,7 +1238,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { } /** - * A wrapper class to associate a packet filter with an interceptor. + * A wrapper class to associate a stanza(/packet) filter with an interceptor. */ protected static class InterceptorWrapper { @@ -1246,7 +1246,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { private final StanzaFilter packetFilter; /** - * Create a class which associates a packet filter with an interceptor. + * Create a class which associates a stanza(/packet) filter with an interceptor. * * @param packetInterceptor the interceptor. * @param packetFilter the associated filter or null if it intercepts all packets. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/PacketCollector.java b/smack-core/src/main/java/org/jivesoftware/smack/PacketCollector.java index a324f8923..56ac6687f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/PacketCollector.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/PacketCollector.java @@ -34,7 +34,7 @@ import org.jivesoftware.smack.packet.Stanza; * use than a {@link StanzaListener} when you need to wait for a specific * result.

* - * Each packet collector will queue up a configured number of packets for processing before + * Each stanza(/packet) collector will queue up a configured number of packets for processing before * older packets are automatically dropped. The default number is retrieved by * {@link SmackConfiguration#getPacketCollectorSize()}. * @@ -49,7 +49,7 @@ public class PacketCollector { private final ArrayBlockingQueue resultQueue; /** - * The packet collector which timeout for the next result will get reset once this collector collects a stanza. + * The stanza(/packet) collector which timeout for the next result will get reset once this collector collects a stanza. */ private final PacketCollector collectorToReset; @@ -58,7 +58,7 @@ public class PacketCollector { private boolean cancelled = false; /** - * Creates a new packet collector. If the packet filter is null, then + * Creates a new stanza(/packet) collector. If the stanza(/packet) filter is null, then * all packets will match this collector. * * @param connection the connection the collector is tied to. @@ -72,9 +72,9 @@ public class PacketCollector { } /** - * Explicitly cancels the packet collector so that no more results are - * queued up. Once a packet collector has been cancelled, it cannot be - * re-enabled. Instead, a new packet collector must be created. + * Explicitly cancels the stanza(/packet) collector so that no more results are + * queued up. Once a stanza(/packet) collector has been cancelled, it cannot be + * re-enabled. Instead, a new stanza(/packet) collector must be created. */ public void cancel() { // If the packet collector has already been cancelled, do nothing. @@ -85,10 +85,10 @@ public class PacketCollector { } /** - * Returns the packet filter associated with this packet collector. The packet + * Returns the stanza(/packet) filter associated with this stanza(/packet) collector. The packet * filter is used to determine what packets are queued as results. * - * @return the packet filter. + * @return the stanza(/packet) filter. * @deprecated use {@link #getStanzaFilter()} instead. */ @Deprecated @@ -107,11 +107,11 @@ public class PacketCollector { } /** - * Polls to see if a packet is currently available and returns it, or + * Polls to see if a stanza(/packet) is currently available and returns it, or * immediately returns null if no packets are currently in the * result queue. * - * @return the next packet result, or null if there are no more + * @return the next stanza(/packet) result, or null if there are no more * results. */ @SuppressWarnings("unchecked") @@ -120,7 +120,7 @@ public class PacketCollector { } /** - * Polls to see if a packet is currently available and returns it, or + * Polls to see if a stanza(/packet) is currently available and returns it, or * immediately returns null if no packets are currently in the * result queue. *

@@ -139,7 +139,7 @@ public class PacketCollector { } /** - * Returns the next available packet. The method call will block (not return) until a packet is + * Returns the next available packet. The method call will block (not return) until a stanza(/packet) is * available. * * @return the next available packet. @@ -173,7 +173,7 @@ public class PacketCollector { /** * Returns the next available packet. The method call will block (not return) - * until a packet is available or the timeout has elapsed. If the + * until a stanza(/packet) is available or the timeout has elapsed. If the * timeout elapses without a result, null will be returned. * * @param timeout the timeout in milliseconds. @@ -201,7 +201,7 @@ public class PacketCollector { } /** - * Returns the next available packet. The method call will block until a packet is available or + * Returns the next available packet. The method call will block until a stanza(/packet) is available or * the connections reply timeout has elapsed. If the timeout elapses without a result, * null will be returned. This method does also cancel the PacketCollector. * @@ -214,10 +214,10 @@ public class PacketCollector { } /** - * Returns the next available packet. The method call will block until a packet is available or + * Returns the next available packet. The method call will block until a stanza(/packet) is available or * the timeout has elapsed. This method does also cancel the PacketCollector. * - * @param timeout the amount of time to wait for the next packet (in milleseconds). + * @param timeout the amount of time to wait for the next stanza(/packet) (in milleseconds). * @return the next available packet. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException in case an error response. @@ -235,7 +235,7 @@ public class PacketCollector { } /** - * Get the number of collected stanzas this packet collector has collected so far. + * Get the number of collected stanzas this stanza(/packet) collector has collected so far. * * @return the count of collected stanzas. * @since 4.1 @@ -245,10 +245,10 @@ public class PacketCollector { } /** - * Processes a packet to see if it meets the criteria for this packet collector. - * If so, the packet is added to the result queue. + * Processes a stanza(/packet) to see if it meets the criteria for this stanza(/packet) collector. + * If so, the stanza(/packet) is added to the result queue. * - * @param packet the packet to process. + * @param packet the stanza(/packet) to process. */ protected void processPacket(Stanza packet) { if (packetFilter == null || packetFilter.accept(packet)) { @@ -269,9 +269,9 @@ public class PacketCollector { } /** - * Get a new packet collector configuration instance. + * Get a new stanza(/packet) collector configuration instance. * - * @return a new packet collector configuration. + * @return a new stanza(/packet) collector configuration. */ public static Configuration newConfiguration() { return new Configuration(); @@ -286,7 +286,7 @@ public class PacketCollector { } /** - * Set the packet filter used by this collector. If null, then all packets will + * Set the stanza(/packet) filter used by this collector. If null, then all packets will * get collected by this collector. * * @param packetFilter @@ -302,7 +302,7 @@ public class PacketCollector { * Set the stanza filter used by this collector. If null, then all stanzas will * get collected by this collector. * - * @param stanzaFilter + * @param packetFilter * @return a reference to this configuration. */ public Configuration setStanzaFilter(StanzaFilter stanzaFilter) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java index 9a22054bb..d76883d5f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java @@ -124,7 +124,7 @@ public final class SmackConfiguration { } /** - * Gets the default max size of a packet collector before it will delete + * Gets the default max size of a stanza(/packet) collector before it will delete * the older packets. * * @return The number of packets to queue before deleting older packets. @@ -134,7 +134,7 @@ public final class SmackConfiguration { } /** - * Sets the default max size of a packet collector before it will delete + * Sets the default max size of a stanza(/packet) collector before it will delete * the older packets. * * @param collectorSize the number of packets to queue before deleting older packets. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java index 261a46807..1a2fd3f76 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java @@ -55,8 +55,8 @@ public class SmackException extends Exception { } /** - * Exception thrown always when there was no response to an request within the packet reply timeout of the used - * connection instance. You can modify (e.g. increase) the packet reply timeout with + * Exception thrown always when there was no response to an request within the stanza(/packet) reply timeout of the used + * connection instance. You can modify (e.g. increase) the stanza(/packet) reply timeout with * {@link XMPPConnection#setPacketReplyTimeout(long)}. */ public static class NoResponseException extends SmackException { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java b/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java index 01bcf89d9..84d511bae 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java @@ -22,7 +22,7 @@ import org.jivesoftware.smack.packet.Stanza; /** * Provides a mechanism to listen for packets that pass a specified filter. - * This allows event-style programming -- every time a new packet is found, + * This allows event-style programming -- every time a new stanza(/packet) is found, * the {@link #processPacket(Stanza)} method will be called. This is the * opposite approach to the functionality provided by a {@link PacketCollector} * which lets you block while waiting for results. @@ -39,14 +39,14 @@ import org.jivesoftware.smack.packet.Stanza; public interface StanzaListener { /** - * Process the next packet sent to this packet listener. + * Process the next stanza(/packet) sent to this stanza(/packet) listener. *

* A single thread is responsible for invoking all listeners, so * it's very important that implementations of this method not block * for any extended period of time. *

* - * @param packet the packet to process. + * @param packet the stanza(/packet) to process. */ public void processPacket(Stanza packet) throws NotConnectedException; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java index 3b7079f04..fcd9f8894 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java @@ -154,9 +154,9 @@ public interface XMPPConnection { public boolean isUsingCompression(); /** - * Sends the specified packet to the server. + * Sends the specified stanza(/packet) to the server. * - * @param packet the packet to send. + * @param packet the stanza(/packet) to send. * @throws NotConnectedException * @deprecated use {@link #sendStanza(Stanza)} instead. */ @@ -166,7 +166,7 @@ public interface XMPPConnection { /** * Sends the specified stanza to the server. * - * @param stanza the stanza to send. + * @param packet the stanza to send. * @throws NotConnectedException if the connection is not connected. */ public void sendStanza(Stanza stanza) throws NotConnectedException; @@ -200,79 +200,79 @@ public interface XMPPConnection { public void removeConnectionListener(ConnectionListener connectionListener); /** - * Creates a new packet collector collecting packets that are replies to packet. - * Does also send packet. The packet filter for the collector is an - * {@link IQReplyFilter}, guaranteeing that packet id and JID in the 'from' address have + * Creates a new stanza(/packet) collector collecting packets that are replies to packet. + * Does also send packet. The stanza(/packet) filter for the collector is an + * {@link IQReplyFilter}, guaranteeing that stanza(/packet) id and JID in the 'from' address have * expected values. * - * @param packet the packet to filter responses from - * @return a new packet collector. + * @param packet the stanza(/packet) to filter responses from + * @return a new stanza(/packet) collector. * @throws NotConnectedException */ public PacketCollector createPacketCollectorAndSend(IQ packet) throws NotConnectedException; /** - * Creates a new packet collector for this connection. A packet filter determines + * Creates a new stanza(/packet) collector for this connection. A stanza(/packet) filter determines * which packets will be accumulated by the collector. A PacketCollector is * more suitable to use than a {@link StanzaListener} when you need to wait for * a specific result. * - * @param packetFilter the packet filter to use. - * @param packet the packet to send right after the collector got created - * @return a new packet collector. + * @param packetFilter the stanza(/packet) filter to use. + * @param packet the stanza(/packet) to send right after the collector got created + * @return a new stanza(/packet) collector. */ public PacketCollector createPacketCollectorAndSend(StanzaFilter packetFilter, Stanza packet) throws NotConnectedException; /** - * Creates a new packet collector for this connection. A packet filter + * Creates a new stanza(/packet) collector for this connection. A stanza(/packet) filter * determines which packets will be accumulated by the collector. A * PacketCollector is more suitable to use than a {@link StanzaListener} * when you need to wait for a specific result. *

- * Note: If you send a Packet right after using this method, then + * Note: If you send a Stanza(/Packet) right after using this method, then * consider using * {@link #createPacketCollectorAndSend(StanzaFilter, Stanza)} instead. * Otherwise make sure cancel the PacketCollector in every case, e.g. even * if an exception is thrown, or otherwise you may leak the PacketCollector. *

* - * @param packetFilter the packet filter to use. - * @return a new packet collector. + * @param packetFilter the stanza(/packet) filter to use. + * @return a new stanza(/packet) collector. */ public PacketCollector createPacketCollector(StanzaFilter packetFilter); /** - * Create a new packet collector with the given packet collector configuration. + * Create a new stanza(/packet) collector with the given stanza(/packet) collector configuration. *

* Please make sure to cancel the collector when it is no longer required. See also * {@link #createPacketCollector(StanzaFilter)}. *

* - * @param configuration the packet collector configuration. - * @return a new packet collector. + * @param configuration the stanza(/packet) collector configuration. + * @return a new stanza(/packet) collector. * @since 4.1 */ public PacketCollector createPacketCollector(PacketCollector.Configuration configuration); /** - * Remove a packet collector of this connection. + * Remove a stanza(/packet) collector of this connection. * - * @param collector a packet collectors which was created for this connection. + * @param collector a stanza(/packet) collectors which was created for this connection. */ public void removePacketCollector(PacketCollector collector); /** - * Registers a packet listener with this connection. + * Registers a stanza(/packet) listener with this connection. *

- * This method has been deprecated. It is important to differentiate between using an asynchronous packet listener - * (preferred where possible) and a synchronous packet lister. Refer + * This method has been deprecated. It is important to differentiate between using an asynchronous stanza(/packet) listener + * (preferred where possible) and a synchronous stanza(/packet) lister. Refer * {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} and * {@link #addSyncStanzaListener(StanzaListener, StanzaFilter)} for more information. *

* - * @param packetListener the packet listener to notify of new received packets. - * @param packetFilter the packet filter to use. + * @param packetListener the stanza(/packet) listener to notify of new received packets. + * @param packetFilter the stanza(/packet) filter to use. * @deprecated use {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} or * {@link #addSyncStanzaListener(StanzaListener, StanzaFilter)}. */ @@ -280,107 +280,107 @@ public interface XMPPConnection { public void addPacketListener(StanzaListener packetListener, StanzaFilter packetFilter); /** - * Removes a packet listener for received packets from this connection. + * Removes a stanza(/packet) listener for received packets from this connection. * - * @param packetListener the packet listener to remove. - * @return true if the packet listener was removed + * @param packetListener the stanza(/packet) listener to remove. + * @return true if the stanza(/packet) listener was removed * @deprecated use {@link #removeAsyncStanzaListener(StanzaListener)} or {@link #removeSyncStanzaListener(StanzaListener)}. */ @Deprecated public boolean removePacketListener(StanzaListener packetListener); /** - * Registers a synchronous packet listener with this connection. A packet listener will be invoked only when - * an incoming packet is received. A packet filter determines which packets will be delivered to the listener. If - * the same packet listener is added again with a different filter, only the new filter will be used. + * Registers a synchronous stanza(/packet) listener with this connection. A stanza(/packet) listener will be invoked only when + * an incoming stanza(/packet) is received. A stanza(/packet) filter determines which packets will be delivered to the listener. If + * the same stanza(/packet) listener is added again with a different filter, only the new filter will be used. *

- * Important: This packet listeners will be called in the same single thread that processes all - * incoming stanzas. Only use this kind of packet filter if it does not perform any XMPP activity that waits for a + * Important: This stanza(/packet) listeners will be called in the same single thread that processes all + * incoming stanzas. Only use this kind of stanza(/packet) filter if it does not perform any XMPP activity that waits for a * response. Consider using {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} when possible, i.e. when * the invocation order doesn't have to be the same as the order of the arriving packets. If the order of the * arriving packets, consider using a {@link PacketCollector} when possible. *

* - * @param packetListener the packet listener to notify of new received packets. - * @param packetFilter the packet filter to use. + * @param packetListener the stanza(/packet) listener to notify of new received packets. + * @param packetFilter the stanza(/packet) filter to use. * @see #addPacketInterceptor(StanzaListener, StanzaFilter) * @since 4.1 */ public void addSyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter); /** - * Removes a packet listener for received packets from this connection. + * Removes a stanza(/packet) listener for received packets from this connection. * - * @param packetListener the packet listener to remove. - * @return true if the packet listener was removed + * @param packetListener the stanza(/packet) listener to remove. + * @return true if the stanza(/packet) listener was removed * @since 4.1 */ public boolean removeSyncStanzaListener(StanzaListener packetListener); /** - * Registers an asynchronous packet listener with this connection. A packet listener will be invoked only - * when an incoming packet is received. A packet filter determines which packets will be delivered to the listener. - * If the same packet listener is added again with a different filter, only the new filter will be used. + * Registers an asynchronous stanza(/packet) listener with this connection. A stanza(/packet) listener will be invoked only + * when an incoming stanza(/packet) is received. A stanza(/packet) filter determines which packets will be delivered to the listener. + * If the same stanza(/packet) listener is added again with a different filter, only the new filter will be used. *

- * Unlike {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} packet listeners added with this method will be - * invoked asynchronously in their own thread. Use this method if the order of the packet listeners must not depend + * Unlike {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} stanza(/packet) listeners added with this method will be + * invoked asynchronously in their own thread. Use this method if the order of the stanza(/packet) listeners must not depend * on the order how the stanzas where received. *

* - * @param packetListener the packet listener to notify of new received packets. - * @param packetFilter the packet filter to use. + * @param packetListener the stanza(/packet) listener to notify of new received packets. + * @param packetFilter the stanza(/packet) filter to use. * @see #addPacketInterceptor(StanzaListener, StanzaFilter) * @since 4.1 */ public void addAsyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter); /** - * Removes an asynchronous packet listener for received packets from this connection. + * Removes an asynchronous stanza(/packet) listener for received packets from this connection. * - * @param packetListener the packet listener to remove. - * @return true if the packet listener was removed + * @param packetListener the stanza(/packet) listener to remove. + * @return true if the stanza(/packet) listener was removed * @since 4.1 */ public boolean removeAsyncStanzaListener(StanzaListener packetListener); /** - * Registers a packet listener with this connection. The listener will be - * notified of every packet that this connection sends. A packet filter determines + * Registers a stanza(/packet) listener with this connection. The listener will be + * notified of every stanza(/packet) that this connection sends. A stanza(/packet) filter determines * which packets will be delivered to the listener. Note that the thread * that writes packets will be used to invoke the listeners. Therefore, each - * packet listener should complete all operations quickly or use a different + * stanza(/packet) listener should complete all operations quickly or use a different * thread for processing. * - * @param packetListener the packet listener to notify of sent packets. - * @param packetFilter the packet filter to use. + * @param packetListener the stanza(/packet) listener to notify of sent packets. + * @param packetFilter the stanza(/packet) filter to use. */ public void addPacketSendingListener(StanzaListener packetListener, StanzaFilter packetFilter); /** - * Removes a packet listener for sending packets from this connection. + * Removes a stanza(/packet) listener for sending packets from this connection. * - * @param packetListener the packet listener to remove. + * @param packetListener the stanza(/packet) listener to remove. */ public void removePacketSendingListener(StanzaListener packetListener); /** - * Registers a packet interceptor with this connection. The interceptor will be - * invoked every time a packet is about to be sent by this connection. Interceptors - * may modify the packet to be sent. A packet filter determines which packets + * Registers a stanza(/packet) interceptor with this connection. The interceptor will be + * invoked every time a stanza(/packet) is about to be sent by this connection. Interceptors + * may modify the stanza(/packet) to be sent. A stanza(/packet) filter determines which packets * will be delivered to the interceptor. * *

* NOTE: For a similar functionality on incoming packets, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}. * - * @param packetInterceptor the packet interceptor to notify of packets about to be sent. - * @param packetFilter the packet filter to use. + * @param packetInterceptor the stanza(/packet) interceptor to notify of packets about to be sent. + * @param packetFilter the stanza(/packet) filter to use. */ public void addPacketInterceptor(StanzaListener packetInterceptor, StanzaFilter packetFilter); /** - * Removes a packet interceptor. + * Removes a stanza(/packet) interceptor. * - * @param packetInterceptor the packet interceptor to remove. + * @param packetInterceptor the stanza(/packet) interceptor to remove. */ public void removePacketInterceptor(StanzaListener packetInterceptor); @@ -388,15 +388,15 @@ public interface XMPPConnection { * Returns the current value of the reply timeout in milliseconds for request for this * XMPPConnection instance. * - * @return the packet reply timeout in milliseconds + * @return the stanza(/packet) reply timeout in milliseconds */ public long getPacketReplyTimeout(); /** - * Set the packet reply timeout in milliseconds. In most cases, Smack will throw a + * Set the stanza(/packet) reply timeout in milliseconds. In most cases, Smack will throw a * {@link NoResponseException} if no reply to a request was received within the timeout period. * - * @param timeout the packet reply timeout in milliseconds + * @param timeout the stanza(/packet) reply timeout in milliseconds */ public void setPacketReplyTimeout(long timeout); @@ -442,12 +442,12 @@ public interface XMPPConnection { public FromMode getFromMode(); /** - * Get the feature packet extensions for a given stream feature of the + * Get the feature stanza(/packet) extensions for a given stream feature of the * server, or null if the server doesn't support that feature. * * @param element * @param namespace - * @return a packet extensions of the feature or null + * @return a stanza(/packet) extensions of the feature or null */ public F getFeature(String element, String namespace); @@ -468,7 +468,7 @@ public interface XMPPConnection { * has been elapsed. *

* - * @param stanza the stanza to send (required) + * @param packet the stanza to send (required) * @param replyFilter the filter used to determine response stanza (required) * @param callback the callback invoked if there is a response (required) * @throws NotConnectedException @@ -484,7 +484,7 @@ public interface XMPPConnection { * with a {@link SmackException.NoResponseException}. The callback will be invoked at most once. *

* - * @param stanza the stanza to send (required) + * @param packet the stanza to send (required) * @param replyFilter the filter used to determine response stanza (required) * @param callback the callback invoked if there is a response (required) * @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. *

* - * @param stanza the stanza to send (required) + * @param packet the stanza to send (required) * @param replyFilter the filter used to determine response stanza (required) * @param callback the callback invoked if there is a response (required) * @param exceptionCallback the callback invoked if there is an exception (optional) @@ -559,9 +559,9 @@ public interface XMPPConnection { /** * Add a callback that is called exactly once and synchronously with the incoming stanza that matches the given - * packet filter. + * stanza(/packet) filter. * - * @param callback the callback invoked once the packet filter matches a stanza. + * @param callback the callback invoked once the stanza(/packet) filter matches a stanza. * @param packetFilter the filter to match stanzas or null to match all. */ public void addOneTimeSyncCallback(StanzaListener callback, StanzaFilter packetFilter); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java index 0871ff1b1..5f8612106 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java @@ -78,7 +78,7 @@ public interface SmackDebugger { /** * Returns the thread that will listen for all incoming packets and write them to the GUI. - * This is what we call "interpreted" packet data, since it's the packet data as Smack sees + * This is what we call "interpreted" stanza(/packet) data, since it's the stanza(/packet) data as Smack sees * it and not as it's coming in as raw XML. * * @return the PacketListener that will listen for all incoming packets and write them to diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/AndFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/AndFilter.java index 94fda8a5a..a1a5749fc 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/AndFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/AndFilter.java @@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter; import org.jivesoftware.smack.packet.Stanza; /** - * Implements the logical AND operation over two or more packet filters. + * Implements the logical AND operation over two or more stanza(/packet) filters. * In other words, packets pass this filter if they pass all of the filters. * * @author Matt Tucker diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java index 8bf88b7e7..85af6bd08 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java @@ -26,7 +26,7 @@ import org.jxmpp.util.XmppStringUtils; * Filter for packets where the "from" field exactly matches a specified JID. If the specified * address is a bare JID then the filter will match any address whose bare JID matches the * specified JID. But if the specified address is a full JID then the filter will only match - * if the sender of the packet matches the specified resource. + * if the sender of the stanza(/packet) matches the specified resource. * * @author Gaston Dombiak */ @@ -44,7 +44,7 @@ public class FromMatchesFilter implements StanzaFilter { * filter address. The second parameter specifies whether the full or the bare addresses are * compared. * - * @param address The address to filter for. If null is given, the packet must not + * @param address The address to filter for. If null is given, the stanza(/packet) must not * have a from address. * @param matchBare */ @@ -58,7 +58,7 @@ public class FromMatchesFilter implements StanzaFilter { * the filter address with the bare from address. Otherwise, compares the filter address * with the full from address. * - * @param address The address to filter for. If null is given, the packet must not + * @param address The address to filter for. If null is given, the stanza(/packet) must not * have a from address. */ public static FromMatchesFilter create(String address) { @@ -69,7 +69,7 @@ public class FromMatchesFilter implements StanzaFilter { * Creates a filter matching on the "from" field. Compares the bare version of from and filter * address. * - * @param address The address to filter for. If null is given, the packet must not + * @param address The address to filter for. If null is given, the stanza(/packet) must not * have a from address. */ public static FromMatchesFilter createBare(String address) { @@ -82,7 +82,7 @@ public class FromMatchesFilter implements StanzaFilter { * Creates a filter matching on the "from" field. Compares the full version of from and filter * address. * - * @param address The address to filter for. If null is given, the packet must not + * @param address The address to filter for. If null is given, the stanza(/packet) must not * have a from address. */ public static FromMatchesFilter createFull(String address) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java index ef639b073..c18fb69fc 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java @@ -28,7 +28,7 @@ import org.jxmpp.util.XmppStringUtils; /** * Filters for packets which are a valid reply to an IQ request. *

- * Such a packet must have the same packet id and must be an IQ packet of type + * Such a stanza(/packet) must have the same stanza(/packet) id and must be an IQ stanza(/packet) of type * RESULT or ERROR. Moreover, it is necessary to check * the from address to ignore forged replies. *

@@ -61,7 +61,7 @@ public class IQReplyFilter implements StanzaFilter { /** * Filters for packets which are a valid reply to an IQ request. *

- * Such a packet must have the same packet id and must be an IQ packet of type + * Such a stanza(/packet) must have the same stanza(/packet) id and must be an IQ stanza(/packet) of type * RESULT or ERROR. Moreover, it is necessary to check * the from address to ignore forged replies. *

diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java index a7d3aa02f..900f3a264 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.IQ.Type; import org.jivesoftware.smack.util.Objects; /** - * A filter for IQ packet types. Returns true only if the packet is an IQ packet + * A filter for IQ stanza(/packet) types. Returns true only if the stanza(/packet) is an IQ packet * and it matches the type provided in the constructor. * * @author Alexander Wenckus diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/NotFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/NotFilter.java index 27c363e6b..e657cf4eb 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/NotFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/NotFilter.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.Stanza; import org.jivesoftware.smack.util.Objects; /** - * Implements the logical NOT operation on a packet filter. In other words, packets + * Implements the logical NOT operation on a stanza(/packet) filter. In other words, packets * pass this filter if they do not pass the supplied filter. * * @author Matt Tucker diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/OrFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/OrFilter.java index 4d4b1cb5b..fd5ffd0ae 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/OrFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/OrFilter.java @@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter; import org.jivesoftware.smack.packet.Stanza; /** - * Implements the logical OR operation over two or more packet filters. In + * Implements the logical OR operation over two or more stanza(/packet) filters. In * other words, packets pass this filter if they pass any of the filters. * * @author Matt Tucker diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketExtensionFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketExtensionFilter.java index 71d98c718..f6458194f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketExtensionFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketExtensionFilter.java @@ -22,7 +22,7 @@ import org.jivesoftware.smack.packet.ExtensionElement; import org.jivesoftware.smack.util.StringUtils; /** - * Filters for packets with a particular type of packet extension. + * Filters for packets with a particular type of stanza(/packet) extension. * * @author Matt Tucker * @deprecated use {@link StanzaExtensionFilter} instead. @@ -34,12 +34,12 @@ public class PacketExtensionFilter implements StanzaFilter { private final String namespace; /** - * Creates a new packet extension filter. Packets will pass the filter if - * they have a packet extension that matches the specified element name + * Creates a new stanza(/packet) extension filter. Packets will pass the filter if + * they have a stanza(/packet) extension that matches the specified element name * and namespace. * - * @param elementName the XML element name of the packet extension. - * @param namespace the XML namespace of the packet extension. + * @param elementName the XML element name of the stanza(/packet) extension. + * @param namespace the XML namespace of the stanza(/packet) extension. */ public PacketExtensionFilter(String elementName, String namespace) { StringUtils.requireNotNullOrEmpty(namespace, "namespace must not be null or empty"); @@ -49,17 +49,17 @@ public class PacketExtensionFilter implements StanzaFilter { } /** - * Creates a new packet extension filter. Packets will pass the filter if they have a packet + * Creates a new stanza(/packet) extension filter. Packets will pass the filter if they have a packet * extension that matches the specified namespace. * - * @param namespace the XML namespace of the packet extension. + * @param namespace the XML namespace of the stanza(/packet) extension. */ public PacketExtensionFilter(String namespace) { this(null, namespace); } /** - * Creates a new packet extension filter for the given packet extension. + * Creates a new stanza(/packet) extension filter for the given stanza(/packet) extension. * * @param packetExtension */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketFilter.java index 4dd91466d..d7f53ad2f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketFilter.java @@ -18,25 +18,25 @@ package org.jivesoftware.smack.filter; /** - * Defines a way to filter packets for particular attributes. Packet filters are used when - * constructing packet listeners or collectors -- the filter defines what packets match the criteria - * of the collector or listener for further packet processing. + * Defines a way to filter packets for particular attributes. Stanza(/Packet) filters are used when + * constructing stanza(/packet) listeners or collectors -- the filter defines what packets match the criteria + * of the collector or listener for further stanza(/packet) processing. *

* Several simple filters are pre-defined. These filters can be logically combined for more complex - * packet filtering by using the {@link org.jivesoftware.smack.filter.AndFilter AndFilter} and + * stanza(/packet) filtering by using the {@link org.jivesoftware.smack.filter.AndFilter AndFilter} and * {@link org.jivesoftware.smack.filter.OrFilter OrFilter} filters. It's also possible to define * your own filters by implementing this interface. The code example below creates a trivial filter * for packets with a specific ID (real code should use {@link StanzaIdFilter} instead). * *

- * // Use an anonymous inner class to define a packet filter that returns
- * // all packets that have a packet ID of "RS145".
+ * // Use an anonymous inner class to define a stanza(/packet) filter that returns
+ * // all packets that have a stanza(/packet) ID of "RS145".
  * PacketFilter myFilter = new PacketFilter() {
  *     public boolean accept(Packet packet) {
  *         return "RS145".equals(packet.getStanzaId());
  *     }
  * };
- * // Create a new packet collector using the filter we created.
+ * // Create a new stanza(/packet) collector using the filter we created.
  * PacketCollector myCollector = packetReader.createPacketCollector(myFilter);
  * 
* diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketIDFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketIDFilter.java index 136a5e842..e4ea23248 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketIDFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketIDFilter.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.Stanza; import org.jivesoftware.smack.util.StringUtils; /** - * Filters for packets with a particular packet ID. + * Filters for packets with a particular stanza(/packet) ID. * * @author Matt Tucker * @deprecated use {@link StanzaIdFilter} instead. @@ -32,9 +32,9 @@ public class PacketIDFilter implements StanzaFilter { private final String packetID; /** - * Creates a new packet ID filter using the specified packet's ID. + * Creates a new stanza(/packet) ID filter using the specified packet's ID. * - * @param packet the packet which the ID is taken from. + * @param packet the stanza(/packet) which the ID is taken from. * @deprecated use {@link StanzaIdFilter#StanzaIdFilter(Stanza)} instead. */ @Deprecated @@ -43,9 +43,9 @@ public class PacketIDFilter implements StanzaFilter { } /** - * Creates a new packet ID filter using the specified packet ID. + * Creates a new stanza(/packet) ID filter using the specified stanza(/packet) ID. * - * @param packetID the packet ID to filter for. + * @param packetID the stanza(/packet) ID to filter for. * @deprecated use {@link StanzaIdFilter#StanzaIdFilter(Stanza)} instead. */ @Deprecated diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java index bac9eab06..f20fdeac1 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java @@ -42,7 +42,7 @@ public class PacketTypeFilter implements StanzaFilter { private final Class packetType; /** - * Creates a new packet type filter that will filter for packets that are the + * Creates a new stanza(/packet) type filter that will filter for packets that are the * same type as packetType. * * @param packetType the Class type. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PresenceTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PresenceTypeFilter.java index 9a5ac3888..23464e956 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PresenceTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PresenceTypeFilter.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.Presence.Type; import org.jivesoftware.smack.util.Objects; /** - * A filter for Presence types. Returns true only if the stanza is an Presence packet and it matches the type provided in the + * A filter for Presence types. Returns true only if the stanza is an Presence stanza(/packet) and it matches the type provided in the * constructor. */ public class PresenceTypeFilter extends FlexibleStanzaTypeFilter { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java index 39a39e173..97416d448 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java @@ -51,7 +51,7 @@ public interface StanzaFilter { /** * Tests whether or not the specified stanza should pass the filter. * - * @param stanza the packet to test. + * @param packet the stanza(/packet) to test. * @return true if and only if stanza passes the filter. */ public boolean accept(Stanza stanza); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaIdFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaIdFilter.java index 3cc9740a1..178ba5cfe 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaIdFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaIdFilter.java @@ -32,7 +32,7 @@ public class StanzaIdFilter implements StanzaFilter { /** * Creates a new stanza ID filter using the specified stanza's ID. * - * @param stanza the stanza which the ID is taken from. + * @param packet the stanza which the ID is taken from. */ public StanzaIdFilter(Stanza stanza) { this(stanza.getStanzaId()); @@ -41,7 +41,7 @@ public class StanzaIdFilter implements StanzaFilter { /** * Creates a new stanza ID filter using the specified stanza ID. * - * @param stanzaID the stanza ID to filter for. + * @param packetID the stanza ID to filter for. */ public StanzaIdFilter(String stanzaID) { this.stanzaId = StringUtils.requireNotNullOrEmpty(stanzaID, "Stanza ID must not be null or empty."); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java index c3c706e39..799edb010 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java @@ -42,7 +42,7 @@ public final class StanzaTypeFilter implements StanzaFilter { private final Class packetType; /** - * Creates a new packet type filter that will filter for packets that are the + * Creates a new stanza(/packet) type filter that will filter for packets that are the * same type as packetType. * * @param packetType the Class type. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java index f950cc81d..bf55c87e8 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java @@ -84,11 +84,11 @@ public class AbstractError { } /** - * Returns the first packet extension that matches the specified element name and + * Returns the first stanza(/packet) extension that matches the specified element name and * namespace, or null if it doesn't exist. * - * @param elementName the XML element name of the packet extension. - * @param namespace the XML element namespace of the packet extension. + * @param elementName the XML element name of the stanza(/packet) extension. + * @param namespace the XML element namespace of the stanza(/packet) extension. * @return the extension, or null if it doesn't exist. */ public PE getExtension(String elementName, String namespace) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java index 1a863d684..1cef9010c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java @@ -18,8 +18,8 @@ package org.jivesoftware.smack.packet; /** - * IQ packet used by Smack to bind a resource and to obtain the jid assigned by the server. - * There are two ways to bind a resource. One is simply sending an empty Bind packet where the + * IQ stanza(/packet) used by Smack to bind a resource and to obtain the jid assigned by the server. + * There are two ways to bind a resource. One is simply sending an empty Bind stanza(/packet) where the * server will assign a new resource for this connection. The other option is to set a desired * resource but the server may return a modified version of the sent resource.

* diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/DefaultExtensionElement.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/DefaultExtensionElement.java index dc3b64788..cd0c0edc9 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/DefaultExtensionElement.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/DefaultExtensionElement.java @@ -27,7 +27,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Default implementation of the ExtensionElement interface. Unless a ExtensionElementProvider * is registered with {@link org.jivesoftware.smack.provider.ProviderManager ProviderManager}, - * instances of this class will be returned when getting packet extensions.

+ * instances of this class will be returned when getting stanza(/packet) extensions.

* * This class provides a very simple representation of an XML sub-document. Each element * is a key in a Map with its CDATA being the value. For example, given the following @@ -53,7 +53,7 @@ public class DefaultExtensionElement implements ExtensionElement { private Map map; /** - * Creates a new generic packet extension. + * Creates a new generic stanza(/packet) extension. * * @param elementName the name of the element of the XML sub-document. * @param namespace the namespace of the element. @@ -66,7 +66,7 @@ public class DefaultExtensionElement implements ExtensionElement { /** * 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 elementName; @@ -75,7 +75,7 @@ public class DefaultExtensionElement implements ExtensionElement { /** * Returns the XML namespace of the extension sub-packet root element. * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return namespace; @@ -95,7 +95,7 @@ public class DefaultExtensionElement implements ExtensionElement { /** * Returns an unmodifiable collection of the names that can be used to get - * values of the packet extension. + * values of the stanza(/packet) extension. * * @return the names. */ @@ -107,7 +107,7 @@ public class DefaultExtensionElement implements ExtensionElement { } /** - * Returns a packet extension value given a name. + * Returns a stanza(/packet) extension value given a name. * * @param name the name. * @return the value. @@ -120,7 +120,7 @@ public class DefaultExtensionElement implements ExtensionElement { } /** - * Sets a packet extension value using the given name. + * Sets a stanza(/packet) extension value using the given name. * * @param name the name. * @param value the value. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Element.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Element.java index e78df0523..19afa01c8 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Element.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Element.java @@ -19,14 +19,14 @@ package org.jivesoftware.smack.packet; /** * Interface to represent a XML element. This is similar to {@link ExtensionElement}, but does not - * carry a namespace and is usually included as child element of an packet extension. + * carry a namespace and is usually included as child element of an stanza(/packet) extension. */ public interface Element { /** * Returns the XML representation of this Element. * - * @return the packet extension as XML. + * @return the stanza(/packet) extension as XML. */ public CharSequence toXML(); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java index 5e21aeb62..1e1c4c174 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java @@ -25,12 +25,12 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * The base IQ (Info/Query) packet. IQ packets are used to get and set information * on the server, including authentication, roster operations, and creating - * accounts. Each IQ packet has a specific type that indicates what type of action + * accounts. Each IQ stanza(/packet) has a specific type that indicates what type of action * is being taken: "get", "set", "result", or "error".

* * IQ packets can contain a single child element that exists in a specific XML * namespace. The combination of the element name and namespace determines what - * type of IQ packet it is. Some example IQ subpacket snippets:

    + * type of IQ stanza(/packet) it is. Some example IQ subpacket snippets:
      * *
    • <query xmlns="jabber:iq:auth"> -- an authentication IQ. *
    • <query xmlns="jabber:iq:private"> -- a private storage IQ. @@ -165,7 +165,7 @@ public abstract class IQ extends Stanza { /** * This method must be overwritten by IQ subclasses to create their child content. It is important that the builder * does not include the final end element. This will be done automatically by IQChildelementXmlStringBuilder - * after eventual existing packet extensions have been added. + * after eventual existing stanza(/packet) extensions have been added. *

      * For example to create an IQ with a extra attribute and an additional child element *

      @@ -195,7 +195,7 @@ public abstract class IQ extends Stanza { * xml.attribute("myAttribute", "myAttributeValue"); * xml.setEmptyElement(); * - * If your IQ does not contain any attributes or child elements (besides packet extensions), consider sub-classing + * If your IQ does not contain any attributes or child elements (besides stanza(/packet) extensions), consider sub-classing * {@link SimpleIQ} instead. * * @param xml a pre-created builder which already has the child element and the 'xmlns' attribute set. @@ -206,7 +206,7 @@ public abstract class IQ extends Stanza { /** * Convenience method to create a new empty {@link Type#result IQ.Type.result} * IQ based on a {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set} - * IQ. The new packet will be initialized with:
        + * IQ. The new stanza(/packet) will be initialized with:
          *
        • The sender set to the recipient of the originating IQ. *
        • The recipient set to the sender of the originating IQ. *
        • The type set to {@link Type#result IQ.Type.result}. @@ -215,7 +215,7 @@ public abstract class IQ extends Stanza { *
        * * @param request the {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set} IQ packet. - * @throws IllegalArgumentException if the IQ packet does not have a type of + * @throws IllegalArgumentException if the IQ stanza(/packet) does not have a type of * {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set}. * @return a new {@link Type#result IQ.Type.result} IQ based on the originating IQ. */ @@ -226,7 +226,7 @@ public abstract class IQ extends Stanza { /** * Convenience method to create a new {@link Type#error IQ.Type.error} IQ * based on a {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set} - * IQ. The new packet will be initialized with:
          + * IQ. The new stanza(/packet) will be initialized with:
            *
          • The sender set to the recipient of the originating IQ. *
          • The recipient set to the sender of the originating IQ. *
          • The type set to {@link Type#error IQ.Type.error}. @@ -237,7 +237,7 @@ public abstract class IQ extends Stanza { * * @param request the {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set} IQ packet. * @param error the error to associate with the created IQ packet. - * @throws IllegalArgumentException if the IQ packet does not have a type of + * @throws IllegalArgumentException if the IQ stanza(/packet) does not have a type of * {@link Type#get IQ.Type.get} or {@link Type#set IQ.Type.set}. * @return a new {@link Type#error IQ.Type.error} IQ based on the originating IQ. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/NamedElement.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/NamedElement.java index 1f2571601..bc22e1c25 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/NamedElement.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/NamedElement.java @@ -19,7 +19,7 @@ package org.jivesoftware.smack.packet; /** * Interface to represent a XML element. This is similar to {@link ExtensionElement}, but does not - * carry a namespace and is usually included as child element of an packet extension. + * carry a namespace and is usually included as child element of an stanza(/packet) extension. */ public interface NamedElement extends Element { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java index c0d59328b..0dfaec627 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java @@ -47,7 +47,7 @@ public interface Packet extends TopLevelStreamElement { public String getPacketID(); /** - * Sets the unique ID of the packet. To indicate that a packet has no id + * Sets the unique ID of the packet. To indicate that a stanza(/packet) has no id * pass null as the packet's id value. * * @param id the unique ID for the packet. @@ -63,39 +63,39 @@ public interface Packet extends TopLevelStreamElement { public void setPacketID(String packetID); /** - * Returns who the packet is being sent "to", or null if + * Returns who the stanza(/packet) is being sent "to", or null if * the value is not set. The XMPP protocol often makes the "to" * attribute optional, so it does not always need to be set.

            * - * @return who the packet is being sent to, or null if the + * @return who the stanza(/packet) is being sent to, or null if the * value has not been set. */ public String getTo(); /** - * Sets who the packet is being sent "to". The XMPP protocol often makes + * Sets who the stanza(/packet) is being sent "to". The XMPP protocol often makes * the "to" attribute optional, so it does not always need to be set. * - * @param to who the packet is being sent to. + * @param to who the stanza(/packet) is being sent to. */ public void setTo(String to); /** - * Returns who the packet is being sent "from" or null if + * Returns who the stanza(/packet) is being sent "from" or null if * the value is not set. The XMPP protocol often makes the "from" * attribute optional, so it does not always need to be set.

            * - * @return who the packet is being sent from, or null if the + * @return who the stanza(/packet) is being sent from, or null if the * value has not been set. */ public String getFrom(); /** - * Sets who the packet is being sent "from". The XMPP protocol often + * Sets who the stanza(/packet) is being sent "from". The XMPP protocol often * makes the "from" attribute optional, so it does not always need to * be set. * - * @param from who the packet is being sent to. + * @param from who the stanza(/packet) is being sent to. */ public void setFrom(String from); @@ -128,16 +128,16 @@ public interface Packet extends TopLevelStreamElement { public void setLanguage(String language); /** - * Returns a copy of the packet extensions attached to the packet. + * Returns a copy of the stanza(/packet) extensions attached to the packet. * - * @return the packet extensions. + * @return the stanza(/packet) extensions. */ public List getExtensions(); /** * Return a set of all extensions with the given element name and namespace. *

            - * Changes to the returned set will update the packet extensions, if the returned set is not the empty set. + * Changes to the returned set will update the stanza(/packet) extensions, if the returned set is not the empty set. *

            * * @param elementName the element name, must not be null. @@ -148,20 +148,20 @@ public interface Packet extends TopLevelStreamElement { public Set getExtensions(String elementName, String namespace); /** - * Returns the first extension of this packet that has the given namespace. + * Returns the first extension of this stanza(/packet) that has the given namespace. *

            * When possible, use {@link #getExtension(String,String)} instead. *

            * * @param namespace the namespace of the extension that is desired. - * @return the packet extension with the given namespace. + * @return the stanza(/packet) extension with the given namespace. */ public ExtensionElement getExtension(String namespace); /** - * Returns the first packet extension that matches the specified element name and + * Returns the first stanza(/packet) extension that matches the specified element name and * namespace, or null if it doesn't exist. If the provided elementName is null, - * only the namespace is matched. Packet extensions are + * only the namespace is matched. Stanza(/Packet) extensions are * are arbitrary XML sub-documents in standard XMPP packets. By default, a * DefaultPacketExtension instance will be returned for each extension. However, * PacketExtensionProvider instances can be registered with the @@ -169,59 +169,59 @@ public interface Packet extends TopLevelStreamElement { * class to handle custom parsing. In that case, the type of the Object * will be determined by the provider. * - * @param elementName the XML element name of the packet extension. (May be null) - * @param namespace the XML element namespace of the packet extension. + * @param elementName the XML element name of the stanza(/packet) extension. (May be null) + * @param namespace the XML element namespace of the stanza(/packet) extension. * @return the extension, or null if it doesn't exist. */ public PE getExtension(String elementName, String namespace); /** - * Adds a packet extension to the packet. Does nothing if extension is null. + * Adds a stanza(/packet) extension to the packet. Does nothing if extension is null. * - * @param extension a packet extension. + * @param extension a stanza(/packet) extension. */ public void addExtension(ExtensionElement extension); /** - * Adds a collection of packet extensions to the packet. Does nothing if extensions is null. + * Adds a collection of stanza(/packet) extensions to the packet. Does nothing if extensions is null. * - * @param extensions a collection of packet extensions + * @param extensions a collection of stanza(/packet) extensions */ public void addExtensions(Collection extensions); /** - * Check if a packet extension with the given element and namespace exists. + * Check if a stanza(/packet) extension with the given element and namespace exists. *

            * The argument elementName may be null. *

            * * @param elementName * @param namespace - * @return true if a packet extension exists, false otherwise. + * @return true if a stanza(/packet) extension exists, false otherwise. */ public boolean hasExtension(String elementName, String namespace); /** - * Check if a packet extension with the given namespace exists. + * Check if a stanza(/packet) extension with the given namespace exists. * * @param namespace - * @return true if a packet extension exists, false otherwise. + * @return true if a stanza(/packet) extension exists, false otherwise. */ public boolean hasExtension(String namespace); /** - * Remove the packet extension with the given elementName and namespace. + * Remove the stanza(/packet) extension with the given elementName and namespace. * * @param elementName * @param namespace - * @return the removed packet extension or null. + * @return the removed stanza(/packet) extension or null. */ public ExtensionElement removeExtension(String elementName, String namespace); /** - * Removes a packet extension from the packet. + * Removes a stanza(/packet) extension from the packet. * - * @param extension the packet extension to remove. - * @return the removed packet extension or null. + * @param extension the stanza(/packet) extension to remove. + * @return the removed stanza(/packet) extension or null. */ public ExtensionElement removeExtension(ExtensionElement extension); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java index c50e35f74..5781e94c0 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java @@ -24,7 +24,7 @@ import org.jivesoftware.smack.util.TypedCloneable; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * Represents XMPP presence packets. Every presence packet has a type, which is one of + * Represents XMPP presence packets. Every presence stanza(/packet) has a type, which is one of * the following values: *
              *
            • {@link Presence.Type#available available} -- (Default) indicates the user is available to @@ -36,7 +36,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; * sender's presence. *
            • {@link Presence.Type#unsubscribed unsubscribed} -- grant removal of subscription to * sender's presence. - *
            • {@link Presence.Type#error error} -- the presence packet contains an error message. + *
            • {@link Presence.Type#error error} -- the presence stanza(/packet) contains an error message. *

            * * A number of attributes are optional: @@ -299,7 +299,7 @@ public final class Presence extends Stanza implements TypedCloneable { unsubscribed, /** - * The presence packet contains an error message. + * The presence stanza(/packet) contains an error message. */ error, diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Session.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Session.java index ea74d4fdb..8f7d9acda 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Session.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Session.java @@ -20,7 +20,7 @@ package org.jivesoftware.smack.packet; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * IQ packet that will be sent to the server to establish a session.

            + * IQ stanza(/packet) that will be sent to the server to establish a session.

            * * If a server supports sessions, it MUST include a session element in the * stream features it advertises to a client after the completion of stream authentication. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java index b3319d681..d256b2d3f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java @@ -31,7 +31,7 @@ import java.util.Locale; import java.util.Set; /** - * Base class for XMPP Stanzas, which are called Packet in older versions of Smack (i.e. < 4.1). + * Base class for XMPP Stanzas, which are called Stanza(/Packet) in older versions of Smack (i.e. < 4.1). *

            * Every stanza has a unique ID (which is automatically generated, but can be overridden). Stanza * IDs are required for IQ stanzas and recommended for presence and message stanzas. Optionally, the @@ -113,7 +113,7 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Sets the unique ID of the packet. To indicate that a packet has no id + * Sets the unique ID of the packet. To indicate that a stanza(/packet) has no id * pass null as the packet's id value. * * @param id the unique ID for the packet. @@ -148,11 +148,11 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Returns who the packet is being sent "to", or null if + * Returns who the stanza(/packet) is being sent "to", or null if * the value is not set. The XMPP protocol often makes the "to" * attribute optional, so it does not always need to be set.

            * - * @return who the packet is being sent to, or null if the + * @return who the stanza(/packet) is being sent to, or null if the * value has not been set. */ public String getTo() { @@ -160,21 +160,21 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Sets who the packet is being sent "to". The XMPP protocol often makes + * Sets who the stanza(/packet) is being sent "to". The XMPP protocol often makes * the "to" attribute optional, so it does not always need to be set. * - * @param to who the packet is being sent to. + * @param to who the stanza(/packet) is being sent to. */ public void setTo(String to) { this.to = to; } /** - * Returns who the packet is being sent "from" or null if + * Returns who the stanza(/packet) is being sent "from" or null if * the value is not set. The XMPP protocol often makes the "from" * attribute optional, so it does not always need to be set.

            * - * @return who the packet is being sent from, or null if the + * @return who the stanza(/packet) is being sent from, or null if the * value has not been set. */ public String getFrom() { @@ -182,11 +182,11 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Sets who the packet is being sent "from". The XMPP protocol often + * Sets who the stanza(/packet) is being sent "from". The XMPP protocol often * makes the "from" attribute optional, so it does not always need to * be set. * - * @param from who the packet is being sent to. + * @param from who the stanza(/packet) is being sent to. */ public void setFrom(String from) { this.from = from; @@ -244,7 +244,7 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { /** * Return a set of all extensions with the given element name and namespace. *

            - * Changes to the returned set will update the packet extensions, if the returned set is not the empty set. + * Changes to the returned set will update the stanza(/packet) extensions, if the returned set is not the empty set. *

            * * @param elementName the element name, must not be null. @@ -260,13 +260,13 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Returns the first extension of this packet that has the given namespace. + * Returns the first extension of this stanza(/packet) that has the given namespace. *

            * When possible, use {@link #getExtension(String,String)} instead. *

            * * @param namespace the namespace of the extension that is desired. - * @return the packet extension with the given namespace. + * @return the stanza(/packet) extension with the given namespace. */ public ExtensionElement getExtension(String namespace) { return PacketUtil.extensionElementFrom(getExtensions(), null, namespace); @@ -304,9 +304,9 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Adds a packet extension to the packet. Does nothing if extension is null. + * Adds a stanza(/packet) extension to the packet. Does nothing if extension is null. * - * @param extension a packet extension. + * @param extension a stanza(/packet) extension. */ public void addExtension(ExtensionElement extension) { if (extension == null) return; @@ -317,9 +317,9 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Adds a collection of packet extensions to the packet. Does nothing if extensions is null. + * Adds a collection of stanza(/packet) extensions to the packet. Does nothing if extensions is null. * - * @param extensions a collection of packet extensions + * @param extensions a collection of stanza(/packet) extensions */ public void addExtensions(Collection extensions) { if (extensions == null) return; @@ -329,14 +329,14 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Check if a packet extension with the given element and namespace exists. + * Check if a stanza(/packet) extension with the given element and namespace exists. *

            * The argument elementName may be null. *

            * * @param elementName * @param namespace - * @return true if a packet extension exists, false otherwise. + * @return true if a stanza(/packet) extension exists, false otherwise. */ public boolean hasExtension(String elementName, String namespace) { if (elementName == null) { @@ -349,10 +349,10 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Check if a packet extension with the given namespace exists. + * Check if a stanza(/packet) extension with the given namespace exists. * * @param namespace - * @return true if a packet extension exists, false otherwise. + * @return true if a stanza(/packet) extension exists, false otherwise. */ public boolean hasExtension(String namespace) { synchronized (packetExtensions) { @@ -366,11 +366,11 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Remove the packet extension with the given elementName and namespace. + * Remove the stanza(/packet) extension with the given elementName and namespace. * * @param elementName * @param namespace - * @return the removed packet extension or null. + * @return the removed stanza(/packet) extension or null. */ public ExtensionElement removeExtension(String elementName, String namespace) { String key = XmppStringUtils.generateKey(elementName, namespace); @@ -380,10 +380,10 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Removes a packet extension from the packet. + * Removes a stanza(/packet) extension from the packet. * - * @param extension the packet extension to remove. - * @return the removed packet extension or null. + * @param extension the stanza(/packet) extension to remove. + * @return the removed stanza(/packet) extension or null. */ public ExtensionElement removeExtension(ExtensionElement extension) { return removeExtension(extension.getElementName(), extension.getNamespace()); @@ -397,10 +397,10 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { /** * Returns the extension sub-packets (including properties data) as an XML - * String, or the Empty String if there are no packet extensions. + * String, or the Empty String if there are no stanza(/packet) extensions. * * @return the extension sub-packets as XML or the Empty String if there - * are no packet extensions. + * are no stanza(/packet) extensions. */ protected final XmlStringBuilder getExtensionsXML() { XmlStringBuilder xml = new XmlStringBuilder(); @@ -433,7 +433,7 @@ public abstract class Stanza implements TopLevelStreamElement, Packet { } /** - * Append an XMPPError is this packet has one set. + * Append an XMPPError is this stanza(/packet) has one set. * * @param xml the XmlStringBuilder to append the error to. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/XMPPError.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/XMPPError.java index 93cf5270c..8a259838f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/XMPPError.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/XMPPError.java @@ -27,7 +27,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Represents an XMPP error sub-packet. Typically, a server responds to a request that has - * problems by sending the packet back and including an error packet. Each error has a type, + * problems by sending the stanza(/packet) back and including an error packet. Each error has a type, * error condition as well as as an optional text explanation. Typical errors are:

            * * @@ -112,7 +112,7 @@ public class XMPPError extends AbstractError { * @param type the error type. * @param condition the error condition. * @param descriptiveTexts - * @param extensions list of packet extensions + * @param extensions list of stanza(/packet) extensions */ public XMPPError(Condition condition, String conditionText, String errorGenerator, Type type, Map descriptiveTexts, List extensions) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java index ce8ba1219..affc2461f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java @@ -23,7 +23,7 @@ package org.jivesoftware.smack.parsing; * place the parser after the faulty stanza. * * Subclasses may or may not override certain methods of this class. Each of these methods will receive the exception - * that caused the parsing error and an instance of an Unparsed Packet type. The latter can be used to inspect the + * that caused the parsing error and an instance of an Unparsed Stanza(/Packet) type. The latter can be used to inspect the * stanza that caused the parsing error by using the getContent() (for example {@link UnparsablePacket#getContent()}) * method. * @@ -37,7 +37,7 @@ public abstract class ParsingExceptionCallback { /** * Called when parsing an message stanza caused an exception. * - * @param stanzaData + * @param packetData * the raw message stanza data that caused the exception * @throws Exception */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java index 9605b7439..8ba4479a6 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java @@ -19,7 +19,7 @@ package org.jivesoftware.smack.provider; import org.jivesoftware.smack.packet.ExtensionElement; /** - * Defines the information required to register a packet extension Provider with the {@link ProviderManager} when using the + * Defines the information required to register a stanza(/packet) extension Provider with the {@link ProviderManager} when using the * {@link ProviderLoader}. * * @author Robin Collier diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderManager.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderManager.java index 360d29f82..49639cd22 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderManager.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderManager.java @@ -64,7 +64,7 @@ import org.jxmpp.util.XmppStringUtils; * interface, or extend the IQ class. In the former case, each IQProvider is responsible for * parsing the raw XML stream to create an IQ instance. In the latter case, bean introspection * is used to try to automatically set properties of the IQ instance using the values found - * in the IQ packet XML. For example, an XMPP time packet resembles the following: + * in the IQ stanza(/packet) XML. For example, an XMPP time stanza(/packet) resembles the following: *
              * <iq type='result' to='joe@example.com' from='mary@example.com' id='time_1'>
              *     <query xmlns='jabber:iq:time'>
            @@ -74,13 +74,13 @@ import org.jxmpp.util.XmppStringUtils;
              *     </query>
              * </iq>
            * - * In order for this packet to be automatically mapped to the Time object listed in the + * In order for this stanza(/packet) to be automatically mapped to the Time object listed in the * providers file above, it must have the methods setUtc(String), setTz(String), and * setDisplay(String). The introspection service will automatically try to convert the String * value from the XML into a boolean, int, long, float, double, or Class depending on the * type the IQ instance expects.

            * - * A pluggable system for packet extensions, child elements in a custom namespace for + * A pluggable system for stanza(/packet) extensions, child elements in a custom namespace for * message and presence packets, also exists. Each extension provider * is registered with a name space in the smack.providers file as in the following example: * @@ -95,12 +95,12 @@ import org.jxmpp.util.XmppStringUtils; * </smackProviders> * * If multiple provider entries attempt to register to handle the same element name and namespace, - * the first entry loaded from the classpath will take precedence. Whenever a packet extension + * the first entry loaded from the classpath will take precedence. Whenever a stanza(/packet) extension * is found in a packet, parsing will be passed to the correct provider. Each provider * can either implement the PacketExtensionProvider interface or be a standard Java Bean. In * the former case, each extension provider is responsible for parsing the raw XML stream to * contruct an object. In the latter case, bean introspection is used to try to automatically - * set the properties of th class using the values in the packet extension sub-element. When an + * set the properties of th class using the values in the stanza(/packet) extension sub-element. When an * extension provider is not registered for an element name and namespace combination, Smack will * store all top-level elements of the sub-packet in DefaultPacketExtension object and then * attach it to the packet.

            @@ -146,7 +146,7 @@ public final class ProviderManager { /** * Returns the IQ provider registered to the specified XML element name and namespace. * For example, if a provider was registered to the element name "query" and the - * namespace "jabber:iq:time", then the following packet would trigger the provider: + * namespace "jabber:iq:time", then the following stanza(/packet) would trigger the provider: * *

                  * <iq type='result' to='joe@example.com' from='mary@example.com' id='time_1'>
            @@ -220,9 +220,9 @@ public final class ProviderManager {
                 }
             
                 /**
            -     * Returns the packet extension provider registered to the specified XML element name
            +     * Returns the stanza(/packet) extension provider registered to the specified XML element name
                  * and namespace. For example, if a provider was registered to the element name "x" and the
            -     * namespace "jabber:x:event", then the following packet would trigger the provider:
            +     * namespace "jabber:x:event", then the following stanza(/packet) would trigger the provider:
                  *
                  * 
                  * <message to='romeo@montague.net' id='message_1'>
            @@ -273,7 +273,7 @@ public final class ProviderManager {
                  *
                  * @param elementName the XML element name.
                  * @param namespace the XML namespace.
            -     * @return the key of the removed packet extension provider
            +     * @return the key of the removed stanza(/packet) extension provider
                  */
                 public static String removeExtensionProvider(String elementName, String namespace) {
                     String key = getKey(elementName, namespace);
            diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
            index cebc9934b..f1c709c60 100644
            --- a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
            +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
            @@ -138,7 +138,7 @@ public class PacketParserUtils {
                  * connection is optional and is used to return feature-not-implemented errors for unknown IQ stanzas.
                  *
                  * @param parser
            -     * @return a packet which is either a Message, IQ or Presence.
            +     * @return a stanza(/packet) which is either a Message, IQ or Presence.
                  * @throws XmlPullParserException 
                  * @throws SmackException 
                  * @throws IOException 
            @@ -906,7 +906,7 @@ public class PacketParserUtils {
                  * Parses an extension element.
                  *
                  * @param elementName the XML element name of the extension element.
            -     * @param namespace the XML namespace of the packet extension.
            +     * @param namespace the XML namespace of the stanza(/packet) extension.
                  * @param parser the XML parser, positioned at the starting element of the extension.
                  * @return an extension element.
                  */
            diff --git a/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java b/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java
            index dde1da0cc..d98aee962 100644
            --- a/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java
            +++ b/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java
            @@ -39,7 +39,7 @@ import org.jivesoftware.smack.packet.TopLevelStreamElement;
              * 
              * Packets that should be processed by the client to simulate a received stanza
              * can be delivered using the {@linkplain #processPacket(Stanza)} method.
            - * It invokes the registered packet interceptors and listeners.
            + * It invokes the registered stanza(/packet) interceptors and listeners.
              * 
              * @see XMPPConnection
              * @author Guenther Niess
            @@ -150,7 +150,7 @@ public class DummyConnection extends AbstractXMPPConnection {
                 }
             
                 /**
            -     * Returns the first packet that's sent through {@link #sendStanza(Stanza)}
            +     * Returns the first stanza(/packet) that's sent through {@link #sendStanza(Stanza)}
                  * and that has not been returned by earlier calls to this method.
                  * 
                  * @return a sent packet.
            @@ -160,7 +160,7 @@ public class DummyConnection extends AbstractXMPPConnection {
                 }
             
                 /**
            -     * Returns the first packet that's sent through {@link #sendStanza(Stanza)}
            +     * Returns the first stanza(/packet) that's sent through {@link #sendStanza(Stanza)}
                  * and that has not been returned by earlier calls to this method. This
                  * method will block for up to the specified number of seconds if no packets
                  * have been sent yet.
            @@ -178,11 +178,11 @@ public class DummyConnection extends AbstractXMPPConnection {
                 }
             
                 /**
            -     * Processes a packet through the installed packet collectors and listeners
            -     * and letting them examine the packet to see if they are a match with the
            +     * Processes a stanza(/packet) through the installed stanza(/packet) collectors and listeners
            +     * and letting them examine the stanza(/packet) to see if they are a match with the
                  * filter.
                  *
            -     * @param packet the packet to process.
            +     * @param packet the stanza(/packet) to process.
                  */
                 public void processPacket(Stanza packet) {
                     if (SmackConfiguration.DEBUG) {
            diff --git a/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java b/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java
            index e5cec42d0..45b4f7466 100644
            --- a/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java
            +++ b/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java
            @@ -62,8 +62,8 @@ public class ThreadedDummyConnection extends DummyConnection {
                 }
             
                 /**
            -     * Calling this method will cause the next sendStanza call with an IQ packet to timeout.
            -     * This is accomplished by simply stopping the auto creating of the reply packet 
            +     * Calling this method will cause the next sendStanza call with an IQ stanza(/packet) to timeout.
            +     * This is accomplished by simply stopping the auto creating of the reply stanza(/packet) 
                  * or processing one that was entered via {@link #processPacket(Stanza)}.
                  */
                 public void setTimeout() {
            diff --git a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java
            index edd2fda17..9a0abfd8f 100644
            --- a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java
            +++ b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java
            @@ -786,10 +786,10 @@ public class EnhancedDebugger implements SmackDebugger {
                 }
             
                 /**
            -     * Adds the received packet detail to the messages table.
            +     * Adds the received stanza(/packet) detail to the messages table.
                  *
                  * @param dateFormatter the SimpleDateFormat to use to format Dates
            -     * @param packet        the read packet to add to the table
            +     * @param packet        the read stanza(/packet) to add to the table
                  */
                 private void addReadPacketToTable(final SimpleDateFormat dateFormatter, final Stanza packet) {
                     SwingUtilities.invokeLater(new Runnable() {
            @@ -847,10 +847,10 @@ public class EnhancedDebugger implements SmackDebugger {
                 }
             
                 /**
            -     * Adds the sent packet detail to the messages table.
            +     * Adds the sent stanza(/packet) detail to the messages table.
                  *
                  * @param dateFormatter the SimpleDateFormat to use to format Dates
            -     * @param packet        the sent packet to add to the table
            +     * @param packet        the sent stanza(/packet) to add to the table
                  */
                 private void addSentPacketToTable(final SimpleDateFormat dateFormatter, final Stanza packet) {
                     SwingUtilities.invokeLater(new Runnable() {
            @@ -964,7 +964,7 @@ public class EnhancedDebugger implements SmackDebugger {
                 }
             
                 /**
            -     * An ad-hoc packet is like any regular packet but with the exception that it's intention is
            +     * An ad-hoc stanza(/packet) is like any regular stanza(/packet) but with the exception that it's intention is
                  * to be used only to send packets.

            *

            * The whole text to send must be passed to the constructor. This implies that the client of @@ -978,7 +978,7 @@ public class EnhancedDebugger implements SmackDebugger { * Create a new AdHocPacket with the text to send. The passed text must be a valid text to * send to the server, no validation will be done on the passed text. * - * @param text the whole text of the packet to send + * @param text the whole text of the stanza(/packet) to send */ public AdHocPacket(String text) { this.text = text; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java index 743f5452a..92e8134d3 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java @@ -38,7 +38,7 @@ import org.jivesoftware.smackx.carbons.packet.CarbonExtension.Private; import org.jivesoftware.smackx.disco.ServiceDiscoveryManager; /** - * Packet extension for XEP-0280: Message Carbons. This class implements + * Stanza(/Packet) extension for XEP-0280: Message Carbons. This class implements * the manager for registering {@link CarbonExtension} support, enabling and disabling * message carbons. * diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java index 64be4a00b..a82ca67c0 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java @@ -22,12 +22,12 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jivesoftware.smackx.forward.packet.Forwarded; /** - * Packet extension for XEP-0280: Message Carbons. The extension + * Stanza(/Packet) extension for XEP-0280: Message Carbons. The extension * XEP-0280 is * meant to synchronize a message flow to multiple presences of a user. * *

            - * It accomplishes this by wrapping a {@link Forwarded} packet in a sent + * It accomplishes this by wrapping a {@link Forwarded} stanza(/packet) in a sent * or received element * * @author Georg Lukas @@ -128,7 +128,7 @@ public class CarbonExtension implements ExtensionElement { } /** - * Packet extension indicating that a message may not be carbon-copied. Adding this + * Stanza(/Packet) extension indicating that a message may not be carbon-copied. Adding this * extension to any message will disallow that message from being copied. */ public static class Private implements ExtensionElement { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java index 65c90ef63..cf8183ec7 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * This class implements the {@link ExtensionElementProvider} to parse - * carbon copied messages from a packet. It will return a {@link CarbonExtension} packet extension. + * carbon copied messages from a packet. It will return a {@link CarbonExtension} stanza(/packet) extension. * * @author Georg Lukas * diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/gcm/packet/GcmPacketExtension.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/gcm/packet/GcmPacketExtension.java index a08882ca3..018955810 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/gcm/packet/GcmPacketExtension.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/gcm/packet/GcmPacketExtension.java @@ -48,10 +48,10 @@ public class GcmPacketExtension extends AbstractJsonPacketExtension { } /** - * Retrieve the GCM packet extension from the packet. + * Retrieve the GCM stanza(/packet) extension from the packet. * * @param packet - * @return the GCM packet extension or null. + * @return the GCM stanza(/packet) extension or null. */ public static GcmPacketExtension from(Stanza packet) { return packet.getExtension(ELEMENT, NAMESPACE); diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/Base64BinaryChunk.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/Base64BinaryChunk.java index b4e747ac6..a80955242 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/Base64BinaryChunk.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/Base64BinaryChunk.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.ExtensionElement; import org.jivesoftware.smackx.hoxt.HOXTManager; /** - * Packet extension for base64 binary chunks.

            + * Stanza(/Packet) extension for base64 binary chunks.

            * This class is immutable. * * @author Andriy Tsykholyas diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java index 6079256c1..bfdd406d4 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParserException; import java.io.IOException; /** - * Abstract parent for Req and Resp packet providers. + * Abstract parent for Req and Resp stanza(/packet) providers. * * @author Andriy Tsykholyas * @see XEP-0332: HTTP over XMPP transport diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/Base64BinaryChunkProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/Base64BinaryChunkProvider.java index fd6578749..64c1743e2 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/Base64BinaryChunkProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/Base64BinaryChunkProvider.java @@ -24,7 +24,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Packet provider for base64 binary chunks. + * Stanza(/Packet) provider for base64 binary chunks. * * @author Andriy Tsykholyas * @see XEP-0332: HTTP over XMPP transport diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppReqProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppReqProvider.java index 4cb3d3422..8aabb1028 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppReqProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppReqProvider.java @@ -25,7 +25,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Req packet provider. + * Req stanza(/packet) provider. * * @author Andriy Tsykholyas * @see XEP-0332: HTTP over XMPP transport diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppRespProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppRespProvider.java index 40656c09d..08ca05a5e 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppRespProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/HttpOverXmppRespProvider.java @@ -24,7 +24,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Resp packet provider. + * Resp stanza(/packet) provider. * * @author Andriy Tsykholyas * @see XEP-0332: HTTP over XMPP transport diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java index fa7b524f1..8296aa35c 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java @@ -43,10 +43,10 @@ public class JsonPacketExtension extends AbstractJsonPacketExtension { } /** - * Retrieve the JSON packet extension from the packet. + * Retrieve the JSON stanza(/packet) extension from the packet. * * @param packet - * @return the JSON packet extension or null. + * @return the JSON stanza(/packet) extension or null. */ public static JsonPacketExtension from(Stanza packet) { return packet.getExtension(ELEMENT, NAMESPACE); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java index 0b64bf2d0..0cb5e4818 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java @@ -70,11 +70,11 @@ public class MultipleRecipientInfo { } /** - * Returns true if the received packet should not be replied. Use + * Returns true if the received stanza(/packet) should not be replied. Use * {@link MultipleRecipientManager#reply(org.jivesoftware.smack.XMPPConnection, org.jivesoftware.smack.packet.Message, org.jivesoftware.smack.packet.Message)} * to send replies. * - * @return true if the received packet should not be replied. + * @return true if the received stanza(/packet) should not be replied. */ public boolean shouldNotReply() { return !extension.getAddressesOfType(MultipleAddresses.Type.noreply).isEmpty(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java index bc5822b66..e3cd1ab98 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java @@ -44,14 +44,14 @@ import java.util.List; public class MultipleRecipientManager { /** - * Sends the specified packet to the collection of specified recipients using the + * Sends the specified stanza(/packet) to the collection of specified recipients using the * specified connection. If the server has support for XEP-33 then only one - * packet is going to be sent to the server with the multiple recipient instructions. + * stanza(/packet) is going to be sent to the server with the multiple recipient instructions. * However, if XEP-33 is not supported by the server then the client is going to send - * the packet to each recipient. + * the stanza(/packet) to each recipient. * * @param connection the connection to use to send the packet. - * @param packet the packet to send to the list of recipients. + * @param packet the stanza(/packet) to send to the list of recipients. * @param to the collection of JIDs to include in the TO list or null if no TO * list exists. * @param cc the collection of JIDs to include in the CC list or null if no CC @@ -71,13 +71,13 @@ public class MultipleRecipientManager { } /** - * Sends the specified packet to the collection of specified recipients using the specified - * connection. If the server has support for XEP-33 then only one packet is going to be sent to + * Sends the specified stanza(/packet) to the collection of specified recipients using the specified + * connection. If the server has support for XEP-33 then only one stanza(/packet) is going to be sent to * the server with the multiple recipient instructions. However, if XEP-33 is not supported by - * the server then the client is going to send the packet to each recipient. + * the server then the client is going to send the stanza(/packet) to each recipient. * * @param connection the connection to use to send the packet. - * @param packet the packet to send to the list of recipients. + * @param packet the stanza(/packet) to send to the list of recipients. * @param to the collection of JIDs to include in the TO list or null if no TO list exists. * @param cc the collection of JIDs to include in the CC list or null if no CC list exists. * @param bcc the collection of JIDs to include in the BCC list or null if no BCC list @@ -125,12 +125,12 @@ public class MultipleRecipientManager { } /** - * Sends a reply to a previously received packet that was sent to multiple recipients. Before + * Sends a reply to a previously received stanza(/packet) that was sent to multiple recipients. Before * attempting to send the reply message some checkings are performed. If any of those checkings * fail then an XMPPException is going to be thrown with the specific error detail. * * @param connection the connection to use to send the reply. - * @param original the previously received packet that was sent to multiple recipients. + * @param original the previously received stanza(/packet) that was sent to multiple recipients. * @param reply the new message to send as a reply. * @throws SmackException * @throws XMPPErrorException @@ -184,12 +184,12 @@ public class MultipleRecipientManager { } /** - * Returns the {@link MultipleRecipientInfo} contained in the specified packet or + * Returns the {@link MultipleRecipientInfo} contained in the specified stanza(/packet) or * null if none was found. Only packets sent to multiple recipients will * contain such information. * - * @param packet the packet to check. - * @return the MultipleRecipientInfo contained in the specified packet or null + * @param packet the stanza(/packet) to check. + * @return the MultipleRecipientInfo contained in the specified stanza(/packet) or null * if none was found. */ public static MultipleRecipientInfo getMultipleRecipientInfo(Stanza packet) { @@ -284,9 +284,9 @@ public class MultipleRecipientManager { } /** - * Packet that holds the XML stanza to send. This class is useful when the same packet - * is needed to be sent to different recipients. Since using the same packet is not possible - * (i.e. cannot change the TO address of a queues packet to be sent) then this class was + * Stanza(/Packet) that holds the XML stanza to send. This class is useful when the same packet + * is needed to be sent to different recipients. Since using the same stanza(/packet) is not possible + * (i.e. cannot change the TO address of a queues stanza(/packet) to be sent) then this class was * created to keep the XML stanza to send. */ private static class PacketCopy extends Stanza { @@ -294,10 +294,10 @@ public class MultipleRecipientManager { private CharSequence text; /** - * Create a copy of a packet with the text to send. The passed text must be a valid text to + * Create a copy of a stanza(/packet) with the text to send. The passed text must be a valid text to * send to the server, no validation will be done on the passed text. * - * @param text the whole text of the packet to send + * @param text the whole text of the stanza(/packet) to send */ public PacketCopy(CharSequence text) { this.text = text; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/packet/MultipleAddresses.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/packet/MultipleAddresses.java index 9fe631d5d..597efbf34 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/packet/MultipleAddresses.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/packet/MultipleAddresses.java @@ -25,7 +25,7 @@ import java.util.ArrayList; import java.util.List; /** - * Packet extension that contains the list of addresses that a packet should be sent or was sent. + * Stanza(/Packet) extension that contains the list of addresses that a stanza(/packet) should be sent or was sent. * * @author Gaston Dombiak */ @@ -54,14 +54,14 @@ public class MultipleAddresses implements ExtensionElement { private List

            addresses = new ArrayList
            (); /** - * Adds a new address to which the packet is going to be sent or was sent. + * Adds a new address to which the stanza(/packet) is going to be sent or was sent. * * @param type on of the static type (BCC, CC, NO_REPLY, REPLY_ROOM, etc.) * @param jid the JID address of the recipient. * @param node used to specify a sub-addressable unit at a particular JID, corresponding to * a Service Discovery node. * @param desc used to specify human-readable information for this address. - * @param delivered true when the packet was already delivered to this address. + * @param delivered true when the stanza(/packet) was already delivered to this address. * @param uri used to specify an external system address, such as a sip:, sips:, or im: URI. */ public void addAddress(Type type, String jid, String node, String desc, boolean delivered, @@ -78,7 +78,7 @@ public class MultipleAddresses implements ExtensionElement { } /** - * Indicate that the packet being sent should not be replied. + * Indicate that the stanza(/packet) being sent should not be replied. */ public void setNoReply() { // Create a new address with the specificed configuration diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java index 55f803896..f7b5514d4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java @@ -129,7 +129,7 @@ public class AMPExtension implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "amp" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ @Override public String getElementName() { @@ -140,7 +140,7 @@ public class AMPExtension implements ExtensionElement { * Returns the XML namespace of the extension sub-packet root element. * According the specification the namespace is always "http://jabber.org/protocol/xhtml-im" * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ @Override public String getNamespace() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java index b47d8ea04..c3c34cf74 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java @@ -32,7 +32,7 @@ public class AMPExtensionProvider extends ExtensionElementProvider private static final Logger LOGGER = Logger.getLogger(AMPExtensionProvider.class.getName()); /** - * Parses a AMPExtension packet (extension sub-packet). + * Parses a AMPExtension stanza(/packet) (extension sub-packet). * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java index 83406a6ad..e2b43b2bb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java @@ -24,9 +24,9 @@ import org.jivesoftware.smackx.bytestreams.ibb.packet.DataPacketExtension; /** * DataListener handles all In-Band Bytestream IQ stanzas containing a data - * packet extension that don't belong to an existing session. + * stanza(/packet) extension that don't belong to an existing session. *

            - * If a data packet is received it looks if a stored In-Band Bytestream session + * If a data stanza(/packet) is received it looks if a stored In-Band Bytestream session * exists. If no session with the given session ID exists an * <item-not-found/> error is returned to the sender. *

            diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java index ccc3a5f1d..20ccf68ff 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java @@ -49,7 +49,7 @@ import org.jivesoftware.smackx.filetransfer.FileTransferManager; * in case the Socks5 bytestream method of transferring data is not available. *

            * There are two ways to send data over an In-Band Bytestream. It could either use IQ stanzas to - * send data packets or message stanzas. If IQ stanzas are used every data packet is acknowledged by + * send data packets or message stanzas. If IQ stanzas are used every data stanza(/packet) is acknowledged by * the receiver. This is the recommended way to avoid possible rate-limiting penalties. Message * stanzas are not acknowledged because most XMPP server implementation don't support stanza * flow-control method like Advanced Message @@ -286,7 +286,7 @@ public class InBandBytestreamManager implements BytestreamManager { * to the initiator. *

            * This method should be used if you are awaiting an In-Band Bytestream request as a reply to - * another packet (e.g. file transfer). + * another stanza(/packet) (e.g. file transfer). * * @param sessionID to be ignored */ @@ -377,7 +377,7 @@ public class InBandBytestreamManager implements BytestreamManager { * The use of {@link StanzaType#IQ} is recommended. See XEP-0047 Section 4. * - * @param stanza the stanza to set + * @param packet the stanza to set */ public void setStanza(StanzaType stanza) { this.stanza = stanza; @@ -436,7 +436,7 @@ public class InBandBytestreamManager implements BytestreamManager { * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream is * not accepted. * - * @param request IQ packet that should be answered with a not-acceptable error + * @param request IQ stanza(/packet) that should be answered with a not-acceptable error * @throws NotConnectedException */ protected void replyRejectPacket(IQ request) throws NotConnectedException { @@ -449,7 +449,7 @@ public class InBandBytestreamManager implements BytestreamManager { * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream open * request is rejected because its block size is greater than the maximum allowed block size. * - * @param request IQ packet that should be answered with a resource-constraint error + * @param request IQ stanza(/packet) that should be answered with a resource-constraint error * @throws NotConnectedException */ protected void replyResourceConstraintPacket(IQ request) throws NotConnectedException { @@ -462,7 +462,7 @@ public class InBandBytestreamManager implements BytestreamManager { * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream * session could not be found. * - * @param request IQ packet that should be answered with a item-not-found error + * @param request IQ stanza(/packet) that should be answered with a item-not-found error * @throws NotConnectedException */ protected void replyItemNotFoundPacket(IQ request) throws NotConnectedException { @@ -532,7 +532,7 @@ public class InBandBytestreamManager implements BytestreamManager { } /** - * Disables the InBandBytestreamManager by removing its packet listeners and resetting its + * Disables the InBandBytestreamManager by removing its stanza(/packet) listeners and resetting its * internal status, which includes removing this instance from the managers map. */ private void disableService() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java index 1f197fa4c..e2c5f8748 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java @@ -229,7 +229,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * IBBInputStream class is the base implementation of an In-Band Bytestream input stream. - * Subclasses of this input stream must provide a packet listener along with a packet filter to + * Subclasses of this input stream must provide a stanza(/packet) listener along with a stanza(/packet) filter to * collect the In-Band Bytestream data packets. */ private abstract class IBBInputStream extends InputStream { @@ -268,16 +268,16 @@ public class InBandBytestreamSession implements BytestreamSession { } /** - * Returns the packet listener that processes In-Band Bytestream data packets. + * Returns the stanza(/packet) listener that processes In-Band Bytestream data packets. * - * @return the data packet listener + * @return the data stanza(/packet) listener */ protected abstract StanzaListener getDataPacketListener(); /** - * Returns the packet filter that accepts In-Band Bytestream data packets. + * Returns the stanza(/packet) filter that accepts In-Band Bytestream data packets. * - * @return the data packet filter + * @return the data stanza(/packet) filter */ protected abstract StanzaFilter getDataPacketFilter(); @@ -334,7 +334,7 @@ public class InBandBytestreamSession implements BytestreamSession { } /** - * This method blocks until a data packet is received, the stream is closed or the current + * This method blocks until a data stanza(/packet) is received, the stream is closed or the current * thread is interrupted. * * @return true if data was received, otherwise false @@ -418,7 +418,7 @@ public class InBandBytestreamSession implements BytestreamSession { } /** - * This method sets the close flag and removes the data packet listener. + * This method sets the close flag and removes the data stanza(/packet) listener. */ private void closeInternal() { if (isClosed) { @@ -492,7 +492,7 @@ public class InBandBytestreamSession implements BytestreamSession { protected StanzaFilter getDataPacketFilter() { /* * filter all IQ stanzas having type 'SET' (represented by Data class), containing a - * data packet extension, matching session ID and recipient + * data stanza(/packet) extension, matching session ID and recipient */ return new AndFilter(new StanzaTypeFilter(Data.class), new IBBDataPacketFilter()); } @@ -538,7 +538,7 @@ public class InBandBytestreamSession implements BytestreamSession { @Override protected StanzaFilter getDataPacketFilter() { /* - * filter all message stanzas containing a data packet extension, matching session ID + * filter all message stanzas containing a data stanza(/packet) extension, matching session ID * and recipient */ return new AndFilter(new StanzaTypeFilter(Message.class), new IBBDataPacketFilter()); @@ -548,7 +548,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * IBBDataPacketFilter class filters all packets from the remote peer of this session, - * containing an In-Band Bytestream data packet extension whose session ID matches this sessions + * containing an In-Band Bytestream data stanza(/packet) extension whose session ID matches this sessions * ID. */ private class IBBDataPacketFilter implements StanzaFilter { @@ -608,7 +608,7 @@ public class InBandBytestreamSession implements BytestreamSession { } /** - * Writes the given data packet to the XMPP stream. + * Writes the given data stanza(/packet) to the XMPP stream. * * @param data the data packet * @throws IOException if an I/O error occurred while sending or if the stream is closed diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java index 25000231a..b9c4369ee 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java @@ -32,7 +32,7 @@ public class Data extends IQ { /** * Constructor. * - * @param data data packet extension containing the encoded data + * @param data data stanza(/packet) extension containing the encoded data */ public Data(DataPacketExtension data) { super(DataPacketExtension.ELEMENT, DataPacketExtension.NAMESPACE); @@ -45,9 +45,9 @@ public class Data extends IQ { } /** - * Returns the data packet extension. + * Returns the data stanza(/packet) extension. * - * @return the data packet extension + * @return the data stanza(/packet) extension */ public DataPacketExtension getDataPacketExtension() { return this.dataPacketExtension; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java index 11e1a0a2a..bdc55c626 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java @@ -30,7 +30,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64; public class DataPacketExtension implements ExtensionElement { /** - * The element name of the data packet extension. + * The element name of the data stanza(/packet) extension. */ public final static String ELEMENT = "data"; @@ -54,7 +54,7 @@ public class DataPacketExtension implements ExtensionElement { * Creates a new In-Band Bytestream data packet. * * @param sessionID unique session ID identifying this In-Band Bytestream - * @param seq sequence of this packet in regard to the other data packets + * @param seq sequence of this stanza(/packet) in regard to the other data packets * @param data the base64 encoded data contained in this packet */ public DataPacketExtension(String sessionID, long seq, String data) { @@ -82,9 +82,9 @@ public class DataPacketExtension implements ExtensionElement { } /** - * Returns the sequence of this packet in regard to the other data packets. + * Returns the sequence of this stanza(/packet) in regard to the other data packets. * - * @return the sequence of this packet in regard to the other data packets. + * @return the sequence of this stanza(/packet) in regard to the other data packets. */ public long getSeq() { return seq; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java index a334a89c6..be9de956f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java @@ -51,7 +51,7 @@ public class Open extends IQ { * * @param sessionID unique session ID identifying this In-Band Bytestream * @param blockSize block size in which the data will be fragmented - * @param stanza stanza type used to encapsulate the data + * @param packet stanza type used to encapsulate the data */ public Open(String sessionID, int blockSize, StanzaType stanza) { super(ELEMENT, NAMESPACE); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java index b30c29418..5185f7f81 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java @@ -25,7 +25,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Parses an In-Band Bytestream data packet which can be a packet extension of + * Parses an In-Band Bytestream data stanza(/packet) which can be a stanza(/packet) extension of * either an IQ stanza or a message stanza. * * @author Henning Staib diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java index 149a3fc12..4145351b5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java @@ -265,7 +265,7 @@ public final class Socks5BytestreamManager implements BytestreamManager { * to the initiator. *

            * This method should be used if you are awaiting a SOCKS5 Bytestream request as a reply to - * another packet (e.g. file transfer). + * another stanza(/packet) (e.g. file transfer). * * @param sessionID to be ignored */ @@ -616,10 +616,10 @@ public final class Socks5BytestreamManager implements BytestreamManager { } /** - * Returns a IQ packet to query a SOCKS5 proxy its network settings. + * Returns a IQ stanza(/packet) to query a SOCKS5 proxy its network settings. * * @param proxy the proxy to query - * @return IQ packet to query a SOCKS5 proxy its network settings + * @return IQ stanza(/packet) to query a SOCKS5 proxy its network settings */ private Bytestream createStreamHostRequest(String proxy) { Bytestream request = new Bytestream(); @@ -668,7 +668,7 @@ public final class Socks5BytestreamManager implements BytestreamManager { } /** - * Returns a SOCKS5 Bytestream initialization request packet with the given session ID + * Returns a SOCKS5 Bytestream initialization request stanza(/packet) with the given session ID * containing the given stream hosts for the given target JID. * * @param sessionID the session ID for the SOCKS5 Bytestream @@ -698,7 +698,7 @@ public final class Socks5BytestreamManager implements BytestreamManager { * Specified in XEP-65 5.3.1 (Example 13) *

            * - * @param packet Packet that should be answered with a not-acceptable error + * @param packet Stanza(/Packet) that should be answered with a not-acceptable error * @throws NotConnectedException */ protected void replyRejectPacket(IQ packet) throws NotConnectedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java index e63aa398b..9653d78f8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java @@ -99,7 +99,7 @@ class Socks5ClientForInitiator extends Socks5Client { } /** - * Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation packet to the + * Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation stanza(/packet) to the * SOCKS5 proxy. * @throws XMPPErrorException * @throws NoResponseException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java index 8f76afc71..17ed49b99 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java @@ -25,7 +25,7 @@ import org.jivesoftware.smack.packet.NamedElement; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * A packet representing part of a SOCKS5 Bytestream negotiation. + * A stanza(/packet) representing part of a SOCKS5 Bytestream negotiation. * * @author Alexander Wenckus */ @@ -198,10 +198,10 @@ public class Bytestream extends IQ { } /** - * Returns the activate element of the packet sent to the proxy host to verify the identity of + * Returns the activate element of the stanza(/packet) sent to the proxy host to verify the identity of * the initiator and match them to the appropriate stream. * - * @return Returns the activate element of the packet sent to the proxy host to verify the + * @return Returns the activate element of the stanza(/packet) sent to the proxy host to verify the * identity of the initiator and match them to the appropriate stream. */ public Activate getToActivate() { @@ -209,7 +209,7 @@ public class Bytestream extends IQ { } /** - * Upon the response from the target of the used host the activate packet is sent to the SOCKS5 + * Upon the response from the target of the used host the activate stanza(/packet) is sent to the SOCKS5 * proxy. The proxy will activate the stream or return an error after verifying the identity of * the initiator, using the activate packet. * @@ -256,7 +256,7 @@ public class Bytestream extends IQ { } /** - * Packet extension that represents a potential SOCKS5 proxy for the file transfer. Stream hosts + * Stanza(/Packet) extension that represents a potential SOCKS5 proxy for the file transfer. Stream hosts * are forwarded to the target of the file transfer who then chooses and connects to one. * * @author Alexander Wenckus @@ -335,7 +335,7 @@ public class Bytestream extends IQ { /** * After selected a SOCKS5 stream host and successfully connecting, the target of the file - * transfer returns a byte stream packet with the stream host used extension. + * transfer returns a byte stream stanza(/packet) with the stream host used extension. * * @author Alexander Wenckus */ @@ -377,7 +377,7 @@ public class Bytestream extends IQ { } /** - * The packet sent by the stream initiator to the stream proxy to activate the connection. + * The stanza(/packet) sent by the stream initiator to the stream proxy to activate the connection. * * @author Alexander Wenckus */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java index b8cfe1383..dd5d55051 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java @@ -549,7 +549,7 @@ public class EntityCapsManager extends Manager { /** * * @param info - * @return true if the packet extensions is ill-formed + * @return true if the stanza(/packet) extensions is ill-formed */ protected static boolean verifyPacketExtensions(DiscoverInfo info) { List foundFormTypes = new LinkedList(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java index dd797e293..65f3ce206 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java @@ -120,7 +120,7 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache } /** - * Writes the DiscoverInfo packet to an file + * Writes the DiscoverInfo stanza(/packet) to an file * * @param file * @param info @@ -136,7 +136,7 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache } /** - * Tries to restore an DiscoverInfo packet from a file. + * Tries to restore an DiscoverInfo stanza(/packet) from a file. * * @param file * @return the restored DiscoverInfo diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/chatstates/ChatStateManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/chatstates/ChatStateManager.java index bc0aab9b7..4f12aa476 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/chatstates/ChatStateManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/chatstates/ChatStateManager.java @@ -38,7 +38,7 @@ import org.jivesoftware.smackx.disco.ServiceDiscoveryManager; /** * Handles chat state for all chats on a particular XMPPConnection. This class manages both the - * packet extensions and the disco response necessary for compliance with + * stanza(/packet) extensions and the disco response necessary for compliance with * XEP-0085. * * NOTE: {@link org.jivesoftware.smackx.chatstates.ChatStateManager#getInstance(org.jivesoftware.smack.XMPPConnection)} @@ -96,7 +96,7 @@ public class ChatStateManager extends Manager { /** * Sets the current state of the provided chat. This method will send an empty bodied Message - * packet with the state attached as a {@link org.jivesoftware.smack.packet.ExtensionElement}, if + * stanza(/packet) with the state attached as a {@link org.jivesoftware.smack.packet.ExtensionElement}, if * and only if the new chat state is different than the last state. * * @param newState the new state of the chat diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java index e6c2add0b..ab9899313 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java @@ -294,7 +294,7 @@ public class AdHocCommandManager extends Manager { } /** - * Process the AdHoc-Command packet that request the execution of some + * Process the AdHoc-Command stanza(/packet) that request the execution of some * action of a command. If this is the first request, this method checks, * before executing the command, if: *
              @@ -315,7 +315,7 @@ public class AdHocCommandManager extends Manager { *
            * * @param requestData - * the packet to process. + * the stanza(/packet) to process. * @throws NotConnectedException * @throws NoResponseException */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java index 8786bef17..8957a103b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java @@ -25,8 +25,8 @@ import org.jxmpp.util.XmppDateTime; /** * Represents timestamp information about data stored for later delivery. A DelayInformation will - * always includes the timestamp when the packet was originally sent and may include more - * information such as the JID of the entity that originally sent the packet as well as the reason + * always includes the timestamp when the stanza(/packet) was originally sent and may include more + * information such as the JID of the entity that originally sent the stanza(/packet) as well as the reason * for the delay.

            * * For more information see XEP-0091 @@ -58,10 +58,10 @@ public class DelayInformation implements ExtensionElement { } /** - * Returns the JID of the entity that originally sent the packet or that delayed the - * delivery of the packet or null if this information is not available. + * Returns the JID of the entity that originally sent the stanza(/packet) or that delayed the + * delivery of the stanza(/packet) or null if this information is not available. * - * @return the JID of the entity that originally sent the packet or that delayed the + * @return the JID of the entity that originally sent the stanza(/packet) or that delayed the * delivery of the packet. */ public String getFrom() { @@ -69,10 +69,10 @@ public class DelayInformation implements ExtensionElement { } /** - * Returns the timestamp when the packet was originally sent. The returned Date is + * Returns the timestamp when the stanza(/packet) was originally sent. The returned Date is * be understood as UTC. * - * @return the timestamp when the packet was originally sent. + * @return the timestamp when the stanza(/packet) was originally sent. */ public Date getStamp() { return stamp; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java index 42c68ddb4..81fff9b47 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java @@ -64,9 +64,9 @@ public interface NodeInformationProvider { List getNodeIdentities(); /** - * Returns a list of the packet extensions defined in the node. + * Returns a list of the stanza(/packet) extensions defined in the node. * - * @return a list of the packet extensions defined in the node. + * @return a list of the stanza(/packet) extensions defined in the node. */ List getNodePacketExtensions(); } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java index 339e3755e..8afc87767 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java @@ -366,7 +366,7 @@ public class ServiceDiscoveryManager extends Manager { * Registers that a new feature is supported by this XMPP entity. When this client is * queried for its information the registered features will be answered.

            * - * Since no packet is actually sent to the server it is safe to perform this operation + * Since no stanza(/packet) is actually sent to the server it is safe to perform this operation * before logging to the server. In fact, you may want to configure the supported features * before logging to the server so that the information is already available if it is required * upon login. @@ -385,7 +385,7 @@ public class ServiceDiscoveryManager extends Manager { /** * Removes the specified feature from the supported features by this XMPP entity.

            * - * Since no packet is actually sent to the server it is safe to perform this operation + * Since no stanza(/packet) is actually sent to the server it is safe to perform this operation * before logging to the server. * * @param feature the feature to remove from the supported features. @@ -415,7 +415,7 @@ public class ServiceDiscoveryManager extends Manager { * specified by XEP-0128. *

            * - * Since no packet is actually sent to the server it is safe to perform this + * Since no stanza(/packet) is actually sent to the server it is safe to perform this * operation before logging to the server. In fact, you may want to * configure the extended info before logging to the server so that the * information is already available if it is required upon login. @@ -458,7 +458,7 @@ public class ServiceDiscoveryManager extends Manager { * Removes the data form containing extended service discovery information * from the information returned by this XMPP entity.

            * - * Since no packet is actually sent to the server it is safe to perform this + * Since no stanza(/packet) is actually sent to the server it is safe to perform this * operation before logging to the server. */ public void removeExtendedInfo() { @@ -592,7 +592,7 @@ public class ServiceDiscoveryManager extends Manager { * be returned by the server whenever the server receives a disco request targeted to the bare * address of the client (i.e. user@host.com). * - * @param info the discover info packet to check. + * @param info the discover info stanza(/packet) to check. * @return true if the server supports publishing of items. */ public static boolean canPublishItems(DiscoverInfo info) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java index 1be561969..8cc776b54 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java @@ -271,7 +271,7 @@ public class FileTransferNegotiator extends Manager { * the option of, accepting, rejecting, or not responding to a received file * transfer request. *

            - * If they accept, the packet will contain the other user's chosen stream + * If they accept, the stanza(/packet) will contain the other user's chosen stream * type to send the file across. The two choices this implementation * provides to the other user for file transfer are SOCKS5 Bytestreams, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java index 43cc7767b..5e663a61c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java @@ -103,11 +103,11 @@ public class FileTransferRequest { } /** - * Returns the stream initiation packet that was sent by the requestor which + * Returns the stream initiation stanza(/packet) that was sent by the requestor which * contains the parameters of the file transfer being transfer and also the * methods available to transfer the file. * - * @return Returns the stream initiation packet that was sent by the + * @return Returns the stream initiation stanza(/packet) that was sent by the * requestor which contains the parameters of the file transfer * being transfer and also the methods available to transfer the * file. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java index 57b07e515..7e78a7162 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java @@ -57,7 +57,7 @@ public abstract class StreamNegotiator { protected static final EventManger initationSetEvents = new EventManger<>(); /** - * Creates the initiation acceptance packet to forward to the stream + * Creates the initiation acceptance stanza(/packet) to forward to the stream * initiator. * * @param streamInitiationOffer The offer from the stream initiator to connect for a stream. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java index 47ef8a713..f9484e07f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java @@ -22,7 +22,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jivesoftware.smackx.delay.packet.DelayInformation; /** - * Packet extension for >XEP-0297: Stanza Forwarding. + * Stanza(/Packet) extension for >XEP-0297: Stanza Forwarding. * * @author Georg Lukas * @see XEP-0297: Stanza Forwarding @@ -35,10 +35,10 @@ public class Forwarded implements ExtensionElement { private final Stanza forwardedPacket; /** - * Creates a new Forwarded packet extension. + * Creates a new Forwarded stanza(/packet) extension. * * @param delay an optional {@link DelayInformation} timestamp of the packet. - * @param fwdPacket the packet that is forwarded (required). + * @param fwdPacket the stanza(/packet) that is forwarded (required). */ public Forwarded(DelayInformation delay, Stanza fwdPacket) { this.delay = delay; @@ -46,9 +46,9 @@ public class Forwarded implements ExtensionElement { } /** - * Creates a new Forwarded packet extension. + * Creates a new Forwarded stanza(/packet) extension. * - * @param fwdPacket the packet that is forwarded (required). + * @param fwdPacket the stanza(/packet) that is forwarded (required). */ public Forwarded(Stanza fwdPacket) { this(null, fwdPacket); @@ -75,7 +75,7 @@ public class Forwarded implements ExtensionElement { } /** - * get the packet forwarded by this stanza. + * get the stanza(/packet) forwarded by this stanza. * * @return the {@link Stanza} instance (typically a message) that was forwarded. */ @@ -86,7 +86,7 @@ public class Forwarded implements ExtensionElement { /** * get the timestamp of the forwarded packet. * - * @return the {@link DelayInformation} representing the time when the original packet was sent. May be null. + * @return the {@link DelayInformation} representing the time when the original stanza(/packet) was sent. May be null. */ public DelayInformation getDelayInformation() { return delay; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/provider/ForwardedProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/provider/ForwardedProvider.java index 0a2b3a237..0e1b96769 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/provider/ForwardedProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/provider/ForwardedProvider.java @@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * This class implements the {@link ExtensionElementProvider} to parse - * forwarded messages from a packet. It will return a {@link Forwarded} packet extension. + * forwarded messages from a packet. It will return a {@link Forwarded} stanza(/packet) extension. * * @author Georg Lukas */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java index 08395c1a6..7ae775b08 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java @@ -59,7 +59,7 @@ import org.jivesoftware.smackx.iqlast.packet.LastActivity; *

            * * For example to get the idle time of a user logged in a resource, simple send - * the LastActivity packet to them, as in the following code: + * the LastActivity stanza(/packet) to them, as in the following code: *

            * *

            @@ -75,7 +75,7 @@ import org.jivesoftware.smackx.iqlast.packet.LastActivity;
              * LastActivity activity = LastActivity.getLastActivity(con, "xray@jabber.org");
              * 
            * - * To get the uptime of a host, you simple send the LastActivity packet to it, + * To get the uptime of a host, you simple send the LastActivity stanza(/packet) to it, * as in the following code example: *

            * @@ -226,7 +226,7 @@ public class LastActivityManager extends Manager { * * @param jid * the JID of the user. - * @return the LastActivity packet of the jid. + * @return the LastActivity stanza(/packet) of the jid. * @throws XMPPErrorException * thrown if a server error has occured. * @throws NoResponseException if there was no response from the server. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java index 5c7b910b9..df04c974b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java @@ -78,7 +78,7 @@ public class PrivateDataManager extends Manager { /** * Returns the private data provider registered to the specified XML element name and namespace. * For example, if a provider was registered to the element name "prefs" and the - * namespace "http://www.xmppclient.com/prefs", then the following packet would trigger + * namespace "http://www.xmppclient.com/prefs", then the following stanza(/packet) would trigger * the provider: * *

            diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/packet/DefaultPrivateData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/packet/DefaultPrivateData.java
            index 2aa4ca3ba..03e6d8d2b 100644
            --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/packet/DefaultPrivateData.java
            +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/packet/DefaultPrivateData.java
            @@ -64,7 +64,7 @@ public class DefaultPrivateData implements PrivateData {
                  /**
                  * Returns the XML element name of the private data 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 elementName;
            @@ -73,7 +73,7 @@ public class DefaultPrivateData implements PrivateData {
                 /**
                  * Returns the XML namespace of the private data sub-packet root element.
                  *
            -     * @return the XML namespace of the packet extension.
            +     * @return the XML namespace of the stanza(/packet) extension.
                  */
                 public String getNamespace() {
                     return namespace;
            diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java
            index 94d42042c..a034d79b8 100644
            --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java
            +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java
            @@ -97,7 +97,7 @@ public class AccountManager extends Manager {
                 /**
                  * Flag that indicates whether the server supports In-Band Registration.
                  * In-Band Registration may be advertised as a stream feature. If no stream feature
            -     * was advertised from the server then try sending an IQ packet to discover if In-Band
            +     * was advertised from the server then try sending an IQ stanza(/packet) to discover if In-Band
                  * Registration is available.
                  */
                 private boolean accountCreationSupported = false;
            @@ -114,7 +114,7 @@ public class AccountManager extends Manager {
                 /**
                  * Sets whether the server supports In-Band Registration. In-Band Registration may be
                  * advertised as a stream feature. If no stream feature was advertised from the server
            -     * then try sending an IQ packet to discover if In-Band Registration is available.
            +     * then try sending an IQ stanza(/packet) to discover if In-Band Registration is available.
                  *
                  * @param accountCreationSupported true if the server supports In-Band Registration.
                  */
            diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java
            index 003f728b7..c26d84ef6 100644
            --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java
            +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java
            @@ -28,7 +28,7 @@ public class JivePropertiesManager {
                 private static boolean javaObjectEnabled = false;
             
                 /**
            -     * Enables deserialization of Java objects embedded in the 'properties' packet extension. Since
            +     * Enables deserialization of Java objects embedded in the 'properties' stanza(/packet) extension. Since
                  * this is a security sensitive feature, it is disabled per default in Smack. Only enable it if
                  * you are sure that you understand the potential security implications it can cause.
                  * 

            @@ -49,7 +49,7 @@ public class JivePropertiesManager { /** * Convenience method to add a property to a packet. * - * @param packet the packet to add the property to. + * @param packet the stanza(/packet) to add the property to. * @param name the name of the property to add. * @param value the value of the property to add. */ @@ -63,7 +63,7 @@ public class JivePropertiesManager { } /** - * Convenience method to get a property from a packet. Will return null if the packet contains + * Convenience method to get a property from a packet. Will return null if the stanza(/packet) contains * not property with the given name. * * @param packet @@ -95,7 +95,7 @@ public class JivePropertiesManager { } /** - * Return a map of all properties of the given packet. If the packet contains no properties + * Return a map of all properties of the given packet. If the stanza(/packet) contains no properties * extension, an empty map will be returned. * * @param packet diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java index 2adf0d419..9750afec0 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java @@ -40,7 +40,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64; */ public class JivePropertiesExtension implements ExtensionElement { /** - * Namespace used to store packet properties. + * Namespace used to store stanza(/packet) properties. */ public static final String NAMESPACE = "http://www.jivesoftware.com/xmlns/xmpp/properties"; @@ -59,7 +59,7 @@ public class JivePropertiesExtension implements ExtensionElement { } /** - * Returns the packet property with the specified name or null if the + * Returns the stanza(/packet) property with the specified name or null if the * property doesn't exist. Property values that were originally primitives will * be returned as their object equivalent. For example, an int property will be * returned as an Integer, a double as a Double, etc. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java index ffc83653e..00ee4ab73 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java @@ -39,7 +39,7 @@ public class JivePropertiesExtensionProvider extends ExtensionElementProvider * Note that you have to explicitly enabled Java object deserialization with @{link * {@link JivePropertiesManager#setJavaObjectEnabled(boolean)} diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java index c59de1807..fd1b5f879 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java @@ -755,10 +755,10 @@ public class MultiUserChat { /** * Adds a new {@link StanzaListener} that will be invoked every time a new presence - * is going to be sent by this MultiUserChat to the server. Packet interceptors may + * is going to be sent by this MultiUserChat to the server. Stanza(/Packet) interceptors may * add new extensions to the presence that is going to be sent to the MUC service. * - * @param presenceInterceptor the new packet interceptor that will intercept presence packets. + * @param presenceInterceptor the new stanza(/packet) interceptor that will intercept presence packets. */ public void addPresenceInterceptor(PresenceListener presenceInterceptor) { presenceInterceptors.add(presenceInterceptor); @@ -766,10 +766,10 @@ public class MultiUserChat { /** * Removes a {@link StanzaListener} that was being invoked every time a new presence - * was being sent by this MultiUserChat to the server. Packet interceptors may + * was being sent by this MultiUserChat to the server. Stanza(/Packet) interceptors may * add new extensions to the presence that is going to be sent to the MUC service. * - * @param presenceInterceptor the packet interceptor to remove. + * @param presenceInterceptor the stanza(/packet) interceptor to remove. */ public void removePresenceInterceptor(StanzaListener presenceInterceptor) { presenceInterceptors.remove(presenceInterceptor); @@ -1414,11 +1414,11 @@ public class MultiUserChat { } /** - * Adds a packet listener that will be notified of any new Presence packets + * Adds a stanza(/packet) listener that will be notified of any new Presence packets * sent to the group chat. Using a listener is a suitable way to know when the list * of occupants should be re-loaded due to any changes. * - * @param listener a packet listener that will be notified of any presence packets + * @param listener a stanza(/packet) listener that will be notified of any presence packets * sent to the group chat. * @return true if the listener was not already added. */ @@ -1427,10 +1427,10 @@ public class MultiUserChat { } /** - * Removes a packet listener that was being notified of any new Presence packets + * Removes a stanza(/packet) listener that was being notified of any new Presence packets * sent to the group chat. * - * @param listener a packet listener that was being notified of any presence packets + * @param listener a stanza(/packet) listener that was being notified of any presence packets * sent to the group chat. * @return true if the listener was removed, otherwise the listener was not added previously. */ @@ -1648,7 +1648,7 @@ public class MultiUserChat { /** * Returns the next available message in the chat. The method call will block - * (not return) until a packet is available or the timeout has elapased. + * (not return) until a stanza(/packet) is available or the timeout has elapased. * If the timeout elapses without a result, null will be returned. * * @param timeout the maximum amount of time to wait for the next message. @@ -1664,14 +1664,14 @@ public class MultiUserChat { } /** - * Adds a packet listener that will be notified of any new messages in the + * Adds a stanza(/packet) listener that will be notified of any new messages in the * group chat. Only "group chat" messages addressed to this group chat will * be delivered to the listener. If you wish to listen for other packets * that may be associated with this group chat, you should register a * PacketListener directly with the XMPPConnection with the appropriate * PacketListener. * - * @param listener a packet listener. + * @param listener a stanza(/packet) listener. * @return true if the listener was not already added. */ public boolean addMessageListener(MessageListener listener) { @@ -1679,11 +1679,11 @@ public class MultiUserChat { } /** - * Removes a packet listener that was being notified of any new messages in the + * Removes a stanza(/packet) listener that was being notified of any new messages in the * multi user chat. Only "group chat" messages addressed to this multi user chat were * being delivered to the listener. * - * @param listener a packet listener. + * @param listener a stanza(/packet) listener. * @return true if the listener was removed, otherwise the listener was not added previously. */ public boolean removeMessageListener(MessageListener listener) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java index 28c8ec872..f851eb058 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java @@ -72,7 +72,7 @@ public class RoomInfo { */ private final boolean moderated; /** - * Every presence packet can include the JID of every occupant unless the owner deactives this + * Every presence stanza(/packet) can include the JID of every occupant unless the owner deactives this * configuration. */ private final boolean nonanonymous; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java index cfd14f3b3..084b223fa 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * A group chat invitation packet extension, which is used to invite other + * A group chat invitation stanza(/packet) extension, which is used to invite other * users to a group chat room. To invite a user to a group chat room, address * a new message to the user and set the room name appropriately, as in the * following code example: @@ -45,7 +45,7 @@ import org.xmlpull.v1.XmlPullParserException; * *

              * PacketFilter filter = new StanzaExtensionFilter("x", "jabber:x:conference");
            - * // Create a packet collector or packet listeners using the filter...
            + * // Create a stanza(/packet) collector or stanza(/packet) listeners using the filter...
              * 
            * * Note: this protocol is outdated now that the Multi-User Chat (MUC) XEP is available @@ -58,12 +58,12 @@ import org.xmlpull.v1.XmlPullParserException; public class GroupChatInvitation implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT = "x"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "jabber:x:conference"; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java index 33b970213..9a36c02e9 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java @@ -23,7 +23,7 @@ import java.util.List; import org.jivesoftware.smack.packet.IQ; /** - * IQ packet that serves for kicking users, granting and revoking voice, banning users, + * IQ stanza(/packet) that serves for kicking users, granting and revoking voice, banning users, * modifying the ban list, granting and revoking membership and granting and revoking * moderator privileges. All these operations are scoped by the * 'http://jabber.org/protocol/muc#admin' namespace. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java index 50f694d99..721c0e01c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java @@ -23,7 +23,7 @@ import java.util.Collections; import java.util.List; /** - * IQ packet that serves for granting and revoking ownership privileges, granting + * IQ stanza(/packet) that serves for granting and revoking ownership privileges, granting * and revoking administrative privileges and destroying a room. All these operations * are scoped by the 'http://jabber.org/protocol/muc#owner' namespace. * diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCUser.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCUser.java index 4e68f4b84..f68726ac3 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCUser.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCUser.java @@ -133,7 +133,7 @@ public class MUCUser implements ExtensionElement { /** * Returns the notification that the room has been destroyed. After a room has been destroyed, - * the room occupants will receive a Presence packet of type 'unavailable' with the reason for + * the room occupants will receive a Presence stanza(/packet) of type 'unavailable' with the reason for * the room destruction if provided by the room owner. * * @return a notification that the room has been destroyed. @@ -203,7 +203,7 @@ public class MUCUser implements ExtensionElement { /** * Sets the notification that the room has been destroyed. After a room has been destroyed, - * the room occupants will receive a Presence packet of type 'unavailable' with the reason for + * the room occupants will receive a Presence stanza(/packet) of type 'unavailable' with the reason for * the room destruction if provided by the room owner. * * @param destroy the notification that the room has been destroyed. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java index 6564254cf..f59c872e4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java @@ -34,7 +34,7 @@ import org.xmlpull.v1.XmlPullParserException; public class MUCUserProvider extends ExtensionElementProvider { /** - * Parses a MUCUser packet (extension sub-packet). + * Parses a MUCUser stanza(/packet) (extension sub-packet). * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java index d8e88af70..9826b8ba2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java @@ -40,7 +40,7 @@ public class OfflineMessageInfo implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "offline" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return "offline"; @@ -50,7 +50,7 @@ public class OfflineMessageInfo implements ExtensionElement { * Returns the XML namespace of the extension sub-packet root element. * According the specification the namespace is always "http://jabber.org/protocol/offline" * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return "http://jabber.org/protocol/offline"; @@ -91,7 +91,7 @@ public class OfflineMessageInfo implements ExtensionElement { public static class Provider extends ExtensionElementProvider { /** - * Parses a OfflineMessageInfo packet (extension sub-packet). + * Parses a OfflineMessageInfo stanza(/packet) (extension sub-packet). * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPEvent.java index f2b4575ef..474b073ef 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPEvent.java @@ -57,7 +57,7 @@ public class PEPEvent implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "x" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return "event"; @@ -68,7 +68,7 @@ public class PEPEvent implements ExtensionElement { * According the specification the namespace is always "jabber:x:roster" * (which is not to be confused with the 'jabber:iq:roster' namespace * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return "http://jabber.org/protocol/pubsub"; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPItem.java index 138c9412a..c8afb073d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/packet/PEPItem.java @@ -46,7 +46,7 @@ public abstract class PEPItem implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "x" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return "item"; @@ -55,7 +55,7 @@ public abstract class PEPItem implements ExtensionElement { /** * Returns the XML namespace of the extension sub-packet root element. * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return "http://jabber.org/protocol/pubsub"; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java index 8786bb26f..7875887c1 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java @@ -50,7 +50,7 @@ public class PEPProvider extends ExtensionElementProvider { } /** - * Parses a PEPEvent packet and extracts a PEPItem from it. + * Parses a PEPEvent stanza(/packet) and extracts a PEPItem from it. * (There is only one per .) * * @param parser the XML parser, positioned at the starting element of the extension. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java index c9ea3c19a..360671031 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java @@ -215,10 +215,10 @@ public class PrivacyListManager extends Manager { } /** - * Send the {@link Privacy} packet to the server in order to know some privacy content and then + * Send the {@link Privacy} stanza(/packet) to the server in order to know some privacy content and then * waits for the answer. * - * @param requestPrivacy is the {@link Privacy} packet configured properly whose XML + * @param requestPrivacy is the {@link Privacy} stanza(/packet) configured properly whose XML * will be sent to the server. * @return a new {@link Privacy} with the data received from the server. * @throws XMPPErrorException @@ -233,10 +233,10 @@ public class PrivacyListManager extends Manager { } /** - * Send the {@link Privacy} packet to the server in order to modify the server privacy and waits + * Send the {@link Privacy} stanza(/packet) to the server in order to modify the server privacy and waits * for the answer. * - * @param requestPrivacy is the {@link Privacy} packet configured properly whose xml will be + * @param requestPrivacy is the {@link Privacy} stanza(/packet) configured properly whose xml will be * sent to the server. * @return a new {@link Privacy} with the data received from the server. * @throws XMPPErrorException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/PrivacyItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/PrivacyItem.java index 02d138f93..1c9594fa7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/PrivacyItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/PrivacyItem.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.privacy.packet; import org.jivesoftware.smack.util.NumberUtil; /** - * A privacy item acts a rule that when matched defines if a packet should be blocked or not. + * A privacy item acts a rule that when matched defines if a stanza(/packet) should be blocked or not. * * Privacy Items can handle different kind of blocking communications based on JID, group, * subscription type or globally by:
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java index ac8256219..c542212ae 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java @@ -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}. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java index c89dae1df..9be5458ab 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java @@ -157,7 +157,7 @@ public class LeafNode extends Node * Get items persisted on the node. *

              * {@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. *

              * * @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))}. * diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java index 597f35d6a..14dd6d6bc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java @@ -153,7 +153,7 @@ abstract public class Node * Get the subscriptions currently associated with this node. *

              * {@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. *

              * * @param additionalExtensions @@ -193,11 +193,11 @@ abstract public class Node *

              *

              * {@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. *

              * * @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. *

              * {@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. *

              * * @param additionalExtensions additional {@code PacketExtensions} add to the request diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java index 21d30bcc8..c1d0cd0bd 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * A packet extension representing the options element. + * A stanza(/packet) extension representing the options element. * * @author Robin Collier */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java index 1684f188b..1e4405c42 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java @@ -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: *
                    * <iq type='set' id="MlIpV-4" to="pubsub.gato.home" from="gato3@gato.home/Smack">
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java
              index 48730b8be..72fa4bc58 100644
              --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java
              +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java
              @@ -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
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
              index 909941a35..6c062b9aa 100644
              --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
              +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
              @@ -49,7 +49,7 @@ import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
                * 

              *
                * deliveryReceiptManager.addReceiptReceivedListener(new ReceiptReceivedListener() {
              - *   void onReceiptReceived(String fromJid, String toJid, String receiptId, Packet receipt) {
              + *   void onReceiptReceived(String fromJid, String toJid, String receiptId, Stanza(/Packet) receipt) {
                *     // If the receiving entity does not support delivery receipts,
                *     // then the receipt received listener may not get invoked.
                *   }
              @@ -264,7 +264,7 @@ public class DeliveryReceiptManager extends Manager {
                   /**
                    * Test if a message requires a delivery receipt.
                    *
              -     * @param message Packet object to check for a DeliveryReceiptRequest
              +     * @param message Stanza(/Packet) object to check for a DeliveryReceiptRequest
                    *
                    * @return true if a delivery receipt was requested
                    */
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java
              index 774820ea7..33e123ff6 100644
              --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java
              +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java
              @@ -33,7 +33,7 @@ public interface ReceiptReceivedListener {
                    * 
                    * @param fromJid the jid that send this receipt
                    * @param toJid the jid which received this receipt
              -     * @param receiptId the message ID of the packet which has been received and this receipt is for
              +     * @param receiptId the message ID of the stanza(/packet) which has been received and this receipt is for
                    * @param receipt the receipt
                    */
                   void onReceiptReceived(String fromJid, String toJid, String receiptId, Stanza receipt);
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
              index 00eede61a..044c621c6 100644
              --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
              +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
              @@ -38,10 +38,10 @@ public class ReportedData {
                   private String title = "";
                   
                   /**
              -     * Returns a new ReportedData if the packet is used for reporting data and includes an 
              +     * Returns a new ReportedData if the stanza(/packet) is used for reporting data and includes an 
                    * extension that matches the elementName and namespace "x","jabber:x:data".
                    * 
              -     * @param packet the packet used for reporting data.
              +     * @param packet the stanza(/packet) used for reporting data.
                    */
                   public static ReportedData getReportedDataFrom(Stanza packet) {
                       // Check if the packet includes the DataForm extension
              diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/packet/SharedGroupsInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/packet/SharedGroupsInfo.java
              index c50c93e0d..761ee7cfa 100644
              --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/packet/SharedGroupsInfo.java
              +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/packet/SharedGroupsInfo.java
              @@ -26,7 +26,7 @@ import java.util.ArrayList;
               import java.util.List;
               
               /**
              - * IQ packet used for discovering the user's shared groups and for getting the answer back
              + * IQ stanza(/packet) used for discovering the user's shared groups and for getting the answer back
                * from the server.

              * * Important note: This functionality is not part of the XMPP spec and it will only work diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java index 191a3257b..fb22e4f6e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java @@ -46,11 +46,11 @@ public class Form { private DataForm dataForm; /** - * Returns a new ReportedData if the packet is used for gathering data and includes an + * Returns a new ReportedData if the stanza(/packet) is used for gathering data and includes an * extension that matches the elementName and namespace "x","jabber:x:data". * - * @param packet the packet used for gathering data. - * @return the data form parsed from the packet or null if there was not + * @param packet the stanza(/packet) used for gathering data. + * @return the data form parsed from the stanza(/packet) or null if there was not * a form in the packet. */ public static Form getFormFrom(Stanza packet) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java index c439cb759..676cad272 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java @@ -41,7 +41,7 @@ public class DataForm implements ExtensionElement { public enum Type { /** - * This packet contains a form to fill out. Display it to the user (if your program can). + * This stanza(/packet) contains a form to fill out. Display it to the user (if your program can). */ form, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java index 3132e5d28..a777d2154 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java @@ -46,7 +46,7 @@ public class XHTMLExtension implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "html" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return ELEMENT; @@ -56,7 +56,7 @@ public class XHTMLExtension implements ExtensionElement { * Returns the XML namespace of the extension sub-packet root element. * According the specification the namespace is always "http://jabber.org/protocol/xhtml-im" * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return NAMESPACE; diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java index 43382d73c..bf7b74ddd 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java @@ -40,7 +40,7 @@ public class DataListenerTest { String targetJID = "target@xmpp-server/Smack"; /** - * If a data packet of an unknown session is received it should be replied + * If a data stanza(/packet) of an unknown session is received it should be replied * with an <item-not-found/> error. * * @throws Exception should not happen diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java index b2ea702ac..f1d8b3b05 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java @@ -244,7 +244,7 @@ public class InBandBytestreamSessionMessageTest { } /** - * If a data packet is received out of order the session should be closed. See XEP-0047 Section + * If a data stanza(/packet) is received out of order the session should be closed. See XEP-0047 Section * 2.2. * * @throws Exception should not happen diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java index 1f59b1418..a6ce11d7d 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java @@ -354,7 +354,7 @@ public class InBandBytestreamSessionTest { } /** - * If the data packet has a sequence that is already used an 'unexpected-request' error should + * If the data stanza(/packet) has a sequence that is already used an 'unexpected-request' error should * be returned. See XEP-0047 Section 2.2. * * @throws Exception should not happen @@ -395,7 +395,7 @@ public class InBandBytestreamSessionTest { } /** - * If the data packet contains invalid Base64 encoding an 'bad-request' error should be + * If the data stanza(/packet) contains invalid Base64 encoding an 'bad-request' error should be * returned. See XEP-0047 Section 2.2. * * @throws Exception should not happen @@ -430,7 +430,7 @@ public class InBandBytestreamSessionTest { } /** - * If a data packet is received out of order the session should be closed. See XEP-0047 Section + * If a data stanza(/packet) is received out of order the session should be closed. See XEP-0047 Section * 2.2. * * @throws Exception should not happen diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java index fac8cab5d..d24875c65 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java @@ -48,7 +48,7 @@ public class Socks5PacketUtils { } /** - * Returns a response to a SOCKS5 Bytestream initialization request. The packet doesn't contain + * Returns a response to a SOCKS5 Bytestream initialization request. The stanza(/packet) doesn't contain * the uses-host information. * * @param from the target @@ -64,7 +64,7 @@ public class Socks5PacketUtils { } /** - * Returns a response to an item discovery request. The packet doesn't contain any items. + * Returns a response to an item discovery request. The stanza(/packet) doesn't contain any items. * * @param from the XMPP server * @param to the XMPP client @@ -79,7 +79,7 @@ public class Socks5PacketUtils { } /** - * Returns a response to an info discovery request. The packet doesn't contain any infos. + * Returns a response to an info discovery request. The stanza(/packet) doesn't contain any infos. * * @param from the target * @param to the initiator diff --git a/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java b/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java index 9dd870445..2f0c00545 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java +++ b/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java @@ -43,7 +43,7 @@ import org.mockito.stubbing.Answer; public class ConnectionUtils { /** - * Creates a mocked XMPP connection that stores every packet that is send over this + * Creates a mocked XMPP connection that stores every stanza(/packet) that is send over this * connection in the given protocol instance and returns the predefined answer packets * form the protocol instance. *

              @@ -54,7 +54,7 @@ public class ConnectionUtils { * * PacketCollector collector = connection.createPacketCollector(new PacketFilter()); * connection.sendStanza(packet); - * Packet reply = collector.nextResult(); + * Stanza(/Packet) reply = collector.nextResult(); * *

              * diff --git a/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java b/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java index c96fd215e..0c85ea0e9 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java +++ b/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java @@ -50,10 +50,10 @@ import org.jivesoftware.smack.packet.Stanza; *
                * 
                * public void methodToTest() {
              - *   Packet packet = new Packet(); // create an XMPP packet
              + *   Stanza(/Packet) stanza(/packet) = new Packet(); // create an XMPP packet
                *   PacketCollector collector = connection.createPacketCollector(new StanzaIdFilter());
                *   connection.sendStanza(packet);
              - *   Packet reply = collector.nextResult();
              + *   Stanza(/Packet) reply = collector.nextResult();
                * }
                * 
                * public void testMethod() {
              @@ -62,8 +62,8 @@ import org.jivesoftware.smack.packet.Stanza;
                *   // create mocked connection
                *   XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, "user@xmpp-server", "xmpp-server");
                *   
              - *   // add reply packet to protocol
              - *   Packet reply = new Packet();
              + *   // add reply stanza(/packet) to protocol
              + *   Stanza(/Packet) reply = new Packet();
                *   protocol.add(reply);
                *   
                *   // call method to test
              diff --git a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java
              index b9465b53b..64dcf42d3 100644
              --- a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java
              +++ b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java
              @@ -115,10 +115,10 @@ public class Chat {
                   }
               
                   /**
              -     * Adds a packet listener that will be notified of any new messages in the
              +     * Adds a stanza(/packet) listener that will be notified of any new messages in the
                    * chat.
                    *
              -     * @param listener a packet listener.
              +     * @param listener a stanza(/packet) listener.
                    */
                   public void addMessageListener(ChatMessageListener listener) {
                       if(listener == null) {
              diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
              index ac8b65fbf..d4d69ee6f 100644
              --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
              +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
              @@ -437,7 +437,7 @@ public class JingleManager implements JingleSessionListener {
                   }
               
                   /**
              -     * Register the listenerJingles, waiting for a Jingle packet that tries to
              +     * Register the listenerJingles, waiting for a Jingle stanza(/packet) that tries to
                    * establish a new session.
                    */
                   private void initJingleSessionRequestListeners() {
              @@ -489,7 +489,7 @@ public class JingleManager implements JingleSessionListener {
                   /**
                    * Activates the listenerJingles on a Jingle session request.
                    *
              -     * @param initJin the packet that must be passed to the jingleSessionRequestListener.
              +     * @param initJin the stanza(/packet) that must be passed to the jingleSessionRequestListener.
                    */
                   void triggerSessionRequested(Jingle initJin) {
               
              diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
              index f3c57fd8f..63ef11da5 100644
              --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
              +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
              @@ -204,7 +204,7 @@ public abstract class JingleNegotiator {
                   /**
                    * Dispatch an incoming packet.
                    * 
              -     * The negotiators form a tree relationship that roughly matches the Jingle packet format:
              +     * The negotiators form a tree relationship that roughly matches the Jingle stanza(/packet) format:
                    * 
                    * JingleSession
                    *      Content Negotiator
              @@ -222,15 +222,15 @@ public abstract class JingleNegotiator {
                    *          
                    *          
                    *          
              -     * This way, each segment of a Jingle packet has a corresponding negotiator that know how to deal with that
              +     * This way, each segment of a Jingle stanza(/packet) has a corresponding negotiator that know how to deal with that
                    * part of the Jingle packet.  It also allows us to support Jingle packets of arbitraty complexity.
                    * 
                    * Each parent calls dispatchIncomingPacket for each of its children.  The children then pass back a List<> of
                    * results that will get sent when we reach the top level negotiator (JingleSession).
                    *
              -     * @param iq the packet received
              +     * @param iq the stanza(/packet) received
                    * @param id the ID of the response that will be sent
              -     * @return the new packet to send (either a Jingle or an IQ error).
              +     * @return the new stanza(/packet) to send (either a Jingle or an IQ error).
                    * @throws XMPPException
                    */
                   public abstract List dispatchIncomingPacket(IQ iq, String id) throws XMPPException, SmackException;
              diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
              index 5b1893b12..42f0bfb10 100644
              --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
              +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
              @@ -266,14 +266,14 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
               
                   /**
                    * Process and respond to an incoming packet. 

              This method is called - * from the packet listener dispatcher when a new packet has arrived. The - * method is responsible for recognizing the packet type and, depending on + * from the stanza(/packet) listener dispatcher when a new stanza(/packet) has arrived. The + * method is responsible for recognizing the stanza(/packet) type and, depending on * the current state, delivering it to the right event handler and wait for - * a response. The response will be another Jingle packet that will be sent + * a response. The response will be another Jingle stanza(/packet) that will be sent * to the other end point. * * @param iq - * the packet received + * the stanza(/packet) received * @throws XMPPException * @throws SmackException */ @@ -336,12 +336,12 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList /** * Dispatch an incoming packet. The method is responsible for recognizing - * the packet type and, depending on the current state, delivering the - * packet to the right event handler and wait for a response. + * the stanza(/packet) type and, depending on the current state, delivering the + * stanza(/packet) to the right event handler and wait for a response. * * @param iq - * the packet received - * @return the new Jingle packet to send. + * the stanza(/packet) received + * @return the new Jingle stanza(/packet) to send. * @throws XMPPException * @throws SmackException */ @@ -414,7 +414,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList * reponse, using the session information we have. * * @param jout - * the Jingle packet we want to complete and send + * the Jingle stanza(/packet) we want to complete and send * @throws NotConnectedException */ public Jingle sendFormattedJingle(Jingle jout) throws NotConnectedException { @@ -427,9 +427,9 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList * incoming packet. * * @param iq - * The Jingle packet we are responing to + * The Jingle stanza(/packet) we are responing to * @param jout - * the Jingle packet we want to complete and send + * the Jingle stanza(/packet) we want to complete and send * @throws NotConnectedException */ public Jingle sendFormattedJingle(IQ iq, Jingle jout) throws NotConnectedException { @@ -647,7 +647,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList } /** - * Remove the packet listener used for processing packet. + * Remove the stanza(/packet) listener used for processing packet. */ protected void removeAsyncPacketListener() { if (packetListener != null) { @@ -658,8 +658,8 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList } /** - * Install the packet listener. The listener is responsible for responding - * to any packet that we receive... + * Install the stanza(/packet) listener. The listener is responsible for responding + * to any stanza(/packet) that we receive... */ protected void updatePacketListener() { removeAsyncPacketListener(); @@ -1017,9 +1017,9 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList * incoming packet. * * @param iq - * The Jingle packet we are responing to + * The Jingle stanza(/packet) we are responing to * @param jingleError - * the IQ packet we want to complete and send + * the IQ stanza(/packet) we want to complete and send */ public IQ createJingleError(IQ iq, JingleError jingleError) { IQ errorPacket = null; @@ -1124,7 +1124,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList /** * When we initiate a session we need to start a bunch of negotiators right after we receive the result - * packet for our session-initiate. This is where we start them. + * stanza(/packet) for our session-initiate. This is where we start them. * */ private void startNegotiators() { diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java index cb611f902..879b70160 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle; * A Jingle session request. *

              * This class is a facade of a received Jingle request. The user can have direct - * access to the Jingle packet (JingleSessionRequest.getJingle() ) of + * access to the Jingle stanza(/packet) (JingleSessionRequest.getJingle() ) of * the request or can use the convencience methods provided by this class. * * @author Alvaro Saurin @@ -75,7 +75,7 @@ public class JingleSessionRequest { } /** - * Returns the Jingle packet that was sent by the requester which contains + * Returns the Jingle stanza(/packet) that was sent by the requester which contains * the parameters of the session. */ public Jingle getJingle() { diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java index 65160a9ef..64f15e3db 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java @@ -95,12 +95,12 @@ public class MediaNegotiator extends JingleNegotiator { /** * Dispatch an incoming packet. The method is responsible for recognizing - * the packet type and, depending on the current state, delivering the - * packet to the right event handler and wait for a response. + * the stanza(/packet) type and, depending on the current state, delivering the + * stanza(/packet) to the right event handler and wait for a response. * * @param iq - * the packet received - * @return the new Jingle packet to send. + * the stanza(/packet) received + * @return the new Jingle stanza(/packet) to send. * @throws XMPPException * @throws NotConnectedException */ diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java index 329a17392..355691877 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java @@ -307,11 +307,11 @@ public class AudioChannel { } /** - * Get the best packet size for a given codec and a codec rate + * Get the best stanza(/packet) size for a given codec and a codec rate * * @param codecFormat * @param milliseconds - * @return the best packet size + * @return the best stanza(/packet) size * @throws IllegalArgumentException */ private int getPacketSize(Format codecFormat, int milliseconds) throws IllegalArgumentException { diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/DatagramListener.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/DatagramListener.java index 89a0c3344..e671b1651 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/DatagramListener.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/DatagramListener.java @@ -27,9 +27,9 @@ public interface DatagramListener { /** * Called when a datagram is received. If the method returns false, the - * packet MUST NOT be resent from the received Channel. + * stanza(/packet) MUST NOT be resent from the received Channel. * - * @param datagramPacket the datagram packet received. + * @param datagramPacket the datagram stanza(/packet) received. * @return ? */ public boolean datagramReceived(DatagramPacket datagramPacket); diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java index 307e8c8cd..4b4885258 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java @@ -39,7 +39,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * RTPBridge IQ Packet used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT. + * RTPBridge IQ Stanza(/Packet) used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT. * This Jingle Bridge has all the needed information to establish a full UDP Channel (Send and Receive) between two parties. * This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport. *

              @@ -69,17 +69,17 @@ public class RTPBridge extends IQ { } /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String NAME = "rtpbridge"; /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "rtpbridge"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://www.jivesoftware.com/protocol/rtpbridge"; @@ -120,7 +120,7 @@ public class RTPBridge extends IQ { } /** - * Creates a RTPBridge Packet without Session ID + * Creates a RTPBridge Stanza(/Packet) without Session ID */ public RTPBridge() { super(ELEMENT_NAME, NAMESPACE); @@ -154,7 +154,7 @@ public class RTPBridge extends IQ { } /** - * Get the Session ID of the Packet (usually same as Jingle Session ID) + * Get the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID) * * @return the session ID */ @@ -163,7 +163,7 @@ public class RTPBridge extends IQ { } /** - * Set the Session ID of the Packet (usually same as Jingle Session ID) + * Set the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID) * * @param sid */ @@ -318,7 +318,7 @@ public class RTPBridge extends IQ { /** * IQProvider for RTP Bridge packets. - * Parse receive RTPBridge packet to a RTPBridge instance + * Parse receive RTPBridge stanza(/packet) to a RTPBridge instance * * @author Thiago Rocha */ diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java index c4416b4ea..f4016887f 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java @@ -36,7 +36,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * STUN IQ Packet used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT. + * STUN IQ Stanza(/Packet) used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT. *

              * High Level Usage Example: *

              @@ -53,17 +53,17 @@ public class STUN extends SimpleIQ { private String publicIp = null; /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String DOMAIN = "stun"; /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "query"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "google:jingleinfo"; @@ -107,7 +107,7 @@ public class STUN extends SimpleIQ { /** * IQProvider for RTP Bridge packets. - * Parse receive RTPBridge packet to a RTPBridge instance + * Parse receive RTPBridge stanza(/packet) to a RTPBridge instance * * @author Thiago Rocha */ diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java index a80e4755d..6da4e566e 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java @@ -45,7 +45,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportC *

              *

              * This class is responsible for managing the transport negotiation process, - * handling all the packet interchange and the stage control. + * handling all the stanza(/packet) interchange and the stage control. * * @author Alvaro Saurin */ @@ -543,7 +543,7 @@ public abstract class TransportNegotiator extends JingleNegotiator { } /** - * Create a Jingle packet where we announce our transport candidates. + * Create a Jingle stanza(/packet) where we announce our transport candidates. * * @throws XMPPException * @throws SmackException @@ -585,11 +585,11 @@ public abstract class TransportNegotiator extends JingleNegotiator { /** * Dispatch an incoming packet. The method is responsible for recognizing - * the packet type and, depending on the current state, deliverying the - * packet to the right event handler and wait for a response. + * the stanza(/packet) type and, depending on the current state, deliverying the + * stanza(/packet) to the right event handler and wait for a response. * - * @param iq the packet received - * @return the new Jingle packet to send. + * @param iq the stanza(/packet) received + * @return the new Jingle stanza(/packet) to send. * @throws XMPPException * @throws SmackException */ diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java index 4669d977b..a82951b32 100644 --- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java +++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java @@ -179,7 +179,7 @@ public class Jingle extends IQ { * Returns the XML element name of the extension sub-packet root element. * Always returns "jingle" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public static String getElementName() { return NODENAME; @@ -188,7 +188,7 @@ public class Jingle extends IQ { /** * Returns the XML namespace of the extension sub-packet root element. * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public static String getNamespace() { return NAMESPACE; @@ -319,7 +319,7 @@ public class Jingle extends IQ { } /** - * Get a hash key for the session this packet belongs to. + * Get a hash key for the session this stanza(/packet) belongs to. * * @param sid The session id * @param initiator The initiator diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/MetaData.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/MetaData.java index 528e16632..8f5770ea6 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/MetaData.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/MetaData.java @@ -25,17 +25,17 @@ import org.jivesoftware.smackx.workgroup.util.MetaDataUtils; import org.jivesoftware.smack.packet.ExtensionElement; /** - * MetaData packet extension. + * MetaData stanza(/packet) extension. */ public class MetaData implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "metadata"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java index 0492740ce..41e44f293 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java @@ -164,7 +164,7 @@ public class AgentSession { /** * Close the agent session. The underlying connection will remain opened but the - * packet listeners that were added by this agent session will be removed. + * stanza(/packet) listeners that were added by this agent session will be removed. */ public void close() { connection.removeAsyncStanzaListener(packetListener); diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Offer.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Offer.java index 3092324d5..5cfdca8db 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Offer.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Offer.java @@ -189,7 +189,7 @@ public class Offer { } /** - * Packet for rejecting offers. + * Stanza(/Packet) for rejecting offers. */ private class RejectPacket extends IQ { @@ -208,7 +208,7 @@ public class Offer { } /** - * Packet for accepting an offer. + * Stanza(/Packet) for accepting an offer. */ private class AcceptPacket extends IQ { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/OfferConfirmation.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/OfferConfirmation.java index 4f65ec6fc..5cc514450 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/OfferConfirmation.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/OfferConfirmation.java @@ -95,7 +95,7 @@ public class OfferConfirmation extends SimpleIQ { /** - * Packet for notifying server of RoomName + * Stanza(/Packet) for notifying server of RoomName */ private class NotifyServicePacket extends IQ { String roomName; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/forms/WorkgroupForm.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/forms/WorkgroupForm.java index 29c585151..c601daf46 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/forms/WorkgroupForm.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/forms/WorkgroupForm.java @@ -29,12 +29,12 @@ import org.xmlpull.v1.XmlPullParserException; public class WorkgroupForm extends SimpleIQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "workgroup-form"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/AgentChatHistory.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/AgentChatHistory.java index 5b96a9870..37487845d 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/AgentChatHistory.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/AgentChatHistory.java @@ -35,12 +35,12 @@ import java.util.List; public class AgentChatHistory extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "chat-sessions"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -86,7 +86,7 @@ public class AgentChatHistory extends IQ { } /** - * Packet extension provider for AgentHistory packets. + * Stanza(/Packet) extension provider for AgentHistory packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/ChatMetadata.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/ChatMetadata.java index 0a53f4f83..57a177d1b 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/ChatMetadata.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/history/ChatMetadata.java @@ -31,12 +31,12 @@ import java.util.Map; public class ChatMetadata extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "chat-metadata"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/macros/Macros.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/macros/Macros.java index c98afc9fd..8a969de9e 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/macros/Macros.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/macros/Macros.java @@ -34,12 +34,12 @@ import org.xmlpull.v1.XmlPullParser; public class Macros extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "macros"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/notes/ChatNotes.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/notes/ChatNotes.java index 2c6e9d588..c79929ade 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/notes/ChatNotes.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/ext/notes/ChatNotes.java @@ -25,17 +25,17 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * IQ packet for retrieving and adding Chat Notes. + * IQ stanza(/packet) for retrieving and adding Chat Notes. */ public class ChatNotes extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "chat-notes"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentInfo.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentInfo.java index 1187c5f9b..cec4f0f84 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentInfo.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentInfo.java @@ -25,17 +25,17 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * IQ packet for retrieving and changing the Agent personal information. + * IQ stanza(/packet) for retrieving and changing the Agent personal information. */ public class AgentInfo extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "agent-info"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatus.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatus.java index 63cb33148..5eddba284 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatus.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatus.java @@ -45,12 +45,12 @@ public class AgentStatus implements ExtensionElement { } /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "agent-status"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; @@ -221,7 +221,7 @@ public class AgentStatus implements ExtensionElement { } /** - * Packet extension provider for AgentStatus packets. + * Stanza(/Packet) extension provider for AgentStatus packets. */ public static class Provider extends ExtensionElementProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatusRequest.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatusRequest.java index cc1e51dbd..55b33d09b 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatusRequest.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/AgentStatusRequest.java @@ -29,8 +29,8 @@ import java.util.Iterator; import java.util.Set; /** - * Agent status request packet. This packet is used by agents to request the list of - * agents in a workgroup. The response packet contains a list of packets. Presence + * Agent status request packet. This stanza(/packet) is used by agents to request the list of + * agents in a workgroup. The response stanza(/packet) contains a list of packets. Presence * packets from individual agents follow. * * @author Matt Tucker @@ -38,12 +38,12 @@ import java.util.Set; public class AgentStatusRequest extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "agent-status-request"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; @@ -114,7 +114,7 @@ public class AgentStatusRequest extends IQ { } /** - * Packet extension provider for AgentStatusRequest packets. + * Stanza(/Packet) extension provider for AgentStatusRequest packets. */ public static class Provider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/DepartQueuePacket.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/DepartQueuePacket.java index 40885d648..b7925f878 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/DepartQueuePacket.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/DepartQueuePacket.java @@ -20,7 +20,7 @@ package org.jivesoftware.smackx.workgroup.packet; import org.jivesoftware.smack.packet.IQ; /** - * A IQ packet used to depart a workgroup queue. There are two cases for issuing a depart + * A IQ stanza(/packet) used to depart a workgroup queue. There are two cases for issuing a depart * queue request:

                *
              • The user wants to leave the queue. In this case, an instance of this class * should be created without passing in a user address. @@ -39,7 +39,7 @@ public class DepartQueuePacket extends IQ { } /** - * Creates a depart queue request packet to the specified workgroup. + * Creates a depart queue request stanza(/packet) to the specified workgroup. * * @param workgroup the workgroup to depart. */ diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MonitorPacket.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MonitorPacket.java index 9da53db75..3fe42a597 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MonitorPacket.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MonitorPacket.java @@ -46,12 +46,12 @@ public class MonitorPacket extends IQ { } /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "monitor"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -72,7 +72,7 @@ public class MonitorPacket extends IQ { /** - * Packet extension provider for Monitor Packets. + * Stanza(/Packet) extension provider for Monitor Packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OccupantsInfo.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OccupantsInfo.java index 3abe85ac6..7b0b35f60 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OccupantsInfo.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OccupantsInfo.java @@ -33,7 +33,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Packet used for requesting information about occupants of a room or for retrieving information + * Stanza(/Packet) used for requesting information about occupants of a room or for retrieving information * such information. * * @author Gaston Dombiak @@ -47,12 +47,12 @@ public class OccupantsInfo extends IQ { } /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "occupants-info"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -127,7 +127,7 @@ public class OccupantsInfo extends IQ { } /** - * Packet extension provider for AgentStatusRequest packets. + * Stanza(/Packet) extension provider for AgentStatusRequest packets. */ public static class Provider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueDetails.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueDetails.java index e201daf83..e7c47bb96 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueDetails.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueDetails.java @@ -34,19 +34,19 @@ import java.util.Set; import java.util.logging.Logger; /** - * Queue details packet extension, which contains details about the users + * Queue details stanza(/packet) extension, which contains details about the users * currently in a queue. */ public class QueueDetails implements ExtensionElement { private static final Logger LOGGER = Logger.getLogger(QueueDetails.class.getName()); /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "notify-queue-details"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; @@ -141,7 +141,7 @@ public class QueueDetails implements ExtensionElement { } /** - * Provider class for QueueDetails packet extensions. + * Provider class for QueueDetails stanza(/packet) extensions. */ public static class Provider extends ExtensionElementProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueOverview.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueOverview.java index 2d9935a4a..b263a54ca 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueOverview.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueOverview.java @@ -32,12 +32,12 @@ import java.util.Date; public class QueueOverview implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static String ELEMENT_NAME = "notify-queue"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static String NAMESPACE = "http://jabber.org/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueUpdate.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueUpdate.java index debf402b4..4b1fe9645 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueUpdate.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/QueueUpdate.java @@ -25,19 +25,19 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * An IQ packet that encapsulates both types of workgroup queue + * An IQ stanza(/packet) that encapsulates both types of workgroup queue * status notifications -- position updates, and estimated time * left in the queue updates. */ public class QueueUpdate implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "queue-status"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomInvitation.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomInvitation.java index c03544ef0..d9fb98f4e 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomInvitation.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomInvitation.java @@ -28,19 +28,19 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Packet extension for {@link org.jivesoftware.smackx.workgroup.agent.InvitationRequest}. + * Stanza(/Packet) extension for {@link org.jivesoftware.smackx.workgroup.agent.InvitationRequest}. * * @author Gaston Dombiak */ public class RoomInvitation implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "invite"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomTransfer.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomTransfer.java index 8b4b4d9d8..b56b54a9a 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomTransfer.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/RoomTransfer.java @@ -28,19 +28,19 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * Packet extension for {@link org.jivesoftware.smackx.workgroup.agent.TransferRequest}. + * Stanza(/Packet) extension for {@link org.jivesoftware.smackx.workgroup.agent.TransferRequest}. * * @author Gaston Dombiak */ public class RoomTransfer implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "transfer"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/SessionID.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/SessionID.java index e869690cd..9e64852e2 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/SessionID.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/SessionID.java @@ -27,12 +27,12 @@ import org.xmlpull.v1.XmlPullParserException; public class SessionID implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "session"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/TranscriptSearch.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/TranscriptSearch.java index 79fd4c2d1..0e7c5dde8 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/TranscriptSearch.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/TranscriptSearch.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * IQ packet for retrieving the transcript search form, submiting the completed search form + * IQ stanza(/packet) for retrieving the transcript search form, submiting the completed search form * or retrieving the answer of a transcript search. * * @author Gaston Dombiak @@ -35,12 +35,12 @@ import org.xmlpull.v1.XmlPullParserException; public class TranscriptSearch extends SimpleIQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "transcript-search"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/UserID.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/UserID.java index 3e2a6499f..2ea844952 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/UserID.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/UserID.java @@ -27,12 +27,12 @@ import org.xmlpull.v1.XmlPullParserException; public class UserID implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "user"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java index 9b19b2fb8..08869e762 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java @@ -25,18 +25,18 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * A packet extension that contains information about the user and agent in a - * workgroup chat. The packet extension is attached to group chat invitations. + * A stanza(/packet) extension that contains information about the user and agent in a + * workgroup chat. The stanza(/packet) extension is attached to group chat invitations. */ public class WorkgroupInformation implements ExtensionElement { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "workgroup"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jabber.org/protocol/workgroup"; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/ChatSettings.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/ChatSettings.java index ca5596ab8..d9a298fdc 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/ChatSettings.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/ChatSettings.java @@ -50,12 +50,12 @@ public class ChatSettings extends IQ { private int type = -1; /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "chat-settings"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -120,7 +120,7 @@ public class ChatSettings extends IQ { } /** - * Packet extension provider for AgentStatusRequest packets. + * Stanza(/Packet) extension provider for AgentStatusRequest packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/GenericSettings.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/GenericSettings.java index 05f5d3321..8bea4f59a 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/GenericSettings.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/GenericSettings.java @@ -51,12 +51,12 @@ public class GenericSettings extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "generic-metadata"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -74,7 +74,7 @@ public class GenericSettings extends IQ { } /** - * Packet extension provider for SoundSetting Packets. + * Stanza(/Packet) extension provider for SoundSetting Packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/OfflineSettings.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/OfflineSettings.java index 0483de5cc..63e969099 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/OfflineSettings.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/OfflineSettings.java @@ -87,12 +87,12 @@ public class OfflineSettings extends SimpleIQ { } /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "offline-settings"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -101,7 +101,7 @@ public class OfflineSettings extends SimpleIQ { } /** - * Packet extension provider for AgentStatusRequest packets. + * Stanza(/Packet) extension provider for AgentStatusRequest packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SearchSettings.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SearchSettings.java index 918417545..ff24f7ae9 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SearchSettings.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SearchSettings.java @@ -58,12 +58,12 @@ public class SearchSettings extends SimpleIQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "search-settings"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -72,7 +72,7 @@ public class SearchSettings extends SimpleIQ { } /** - * Packet extension provider for AgentStatusRequest packets. + * Stanza(/Packet) extension provider for AgentStatusRequest packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SoundSettings.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SoundSettings.java index 67317ee39..e7883b602 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SoundSettings.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/SoundSettings.java @@ -48,12 +48,12 @@ public class SoundSettings extends SimpleIQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "sound-settings"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -62,7 +62,7 @@ public class SoundSettings extends SimpleIQ { } /** - * Packet extension provider for SoundSetting Packets. + * Stanza(/Packet) extension provider for SoundSetting Packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.java index 8166c69d4..5511fd993 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.java @@ -66,12 +66,12 @@ public class WorkgroupProperties extends IQ { /** - * Element name of the packet extension. + * Element name of the stanza(/packet) extension. */ public static final String ELEMENT_NAME = "workgroup-properties"; /** - * Namespace of the packet extension. + * Namespace of the stanza(/packet) extension. */ public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup"; @@ -89,7 +89,7 @@ public class WorkgroupProperties extends IQ { } /** - * Packet extension provider for SoundSetting Packets. + * Stanza(/Packet) extension provider for SoundSetting Packets. */ public static class InternalProvider extends IQProvider { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java index 30ce5fd91..44b52ed97 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java @@ -543,7 +543,7 @@ public class Workgroup { } /** - * IQ packet to request joining the workgroup queue. + * IQ stanza(/packet) to request joining the workgroup queue. */ private class JoinQueuePacket extends IQ { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/packet/MessageEvent.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/packet/MessageEvent.java index a58c65474..0a571a288 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/packet/MessageEvent.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/packet/MessageEvent.java @@ -76,7 +76,7 @@ public class MessageEvent implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "x" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return ELEMENT; @@ -86,7 +86,7 @@ public class MessageEvent implements ExtensionElement { * Returns the XML namespace of the extension sub-packet root element. * According the specification the namespace is always "jabber:x:event" * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return NAMESPACE; @@ -153,7 +153,7 @@ public class MessageEvent implements ExtensionElement { /** * Returns the unique ID of the message that requested to be notified of the event. - * The packet id is not used when the message is a request for notifications + * The stanza(/packet) id is not used when the message is a request for notifications * * @return the message id that requested to be notified of the event. */ @@ -254,7 +254,7 @@ public class MessageEvent implements ExtensionElement { /** * Sets the unique ID of the message that requested to be notified of the event. - * The packet id is not used when the message is a request for notifications + * The stanza(/packet) id is not used when the message is a request for notifications * * @param packetID the message id that requested to be notified of the event. */ diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/provider/MessageEventProvider.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/provider/MessageEventProvider.java index ba2304b96..8d0aa3368 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/provider/MessageEventProvider.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/provider/MessageEventProvider.java @@ -33,7 +33,7 @@ import org.xmlpull.v1.XmlPullParserException; public class MessageEventProvider extends ExtensionElementProvider { /** - * Parses a MessageEvent packet (extension sub-packet). + * Parses a MessageEvent stanza(/packet) (extension sub-packet). * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/packet/RosterExchange.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/packet/RosterExchange.java index 1baed7bda..d7e234384 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/packet/RosterExchange.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/packet/RosterExchange.java @@ -108,7 +108,7 @@ public class RosterExchange implements ExtensionElement { * Returns the XML element name of the extension sub-packet root element. * Always returns "x" * - * @return the XML element name of the packet extension. + * @return the XML element name of the stanza(/packet) extension. */ public String getElementName() { return RosterExchangeManager.ELEMENT; @@ -119,7 +119,7 @@ public class RosterExchange implements ExtensionElement { * According the specification the namespace is always "jabber:x:roster" * (which is not to be confused with the 'jabber:iq:roster' namespace * - * @return the XML namespace of the packet extension. + * @return the XML namespace of the stanza(/packet) extension. */ public String getNamespace() { return RosterExchangeManager.NAMESPACE; diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/provider/RosterExchangeProvider.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/provider/RosterExchangeProvider.java index 9eca95521..2296956f8 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/provider/RosterExchangeProvider.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/provider/RosterExchangeProvider.java @@ -35,7 +35,7 @@ import org.xmlpull.v1.XmlPullParserException; public class RosterExchangeProvider extends ExtensionElementProvider { /** - * Parses a RosterExchange packet (extension sub-packet). + * Parses a RosterExchange stanza(/packet) (extension sub-packet). * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. diff --git a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java index 0812fa5f4..4f28dc633 100644 --- a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java +++ b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java @@ -597,7 +597,7 @@ public class XMPPTCPConnection extends AbstractXMPPConnection { } /** - * Initializes the connection by creating a packet reader and writer and opening a + * Initializes the connection by creating a stanza(/packet) reader and writer and opening a * XMPP stream to the server. * * @throws XMPPException if establishing a connection to the server fails. @@ -955,7 +955,7 @@ public class XMPPTCPConnection extends AbstractXMPPConnection { } /** - * Shuts the packet reader down. This method simply sets the 'done' flag to true. + * Shuts the stanza(/packet) reader down. This method simply sets the 'done' flag to true. */ void shutdown() { done = true; @@ -1176,7 +1176,7 @@ public class XMPPTCPConnection extends AbstractXMPPConnection { XMPPTCPConnection.this); /** - * If set, the packet writer is shut down + * If set, the stanza(/packet) writer is shut down */ protected volatile Long shutdownTimestamp = null; @@ -1254,7 +1254,7 @@ public class XMPPTCPConnection extends AbstractXMPPConnection { } /** - * Shuts down the packet writer. Once this method has been called, no further + * Shuts down the stanza(/packet) writer. Once this method has been called, no further * packets will be written to the server. */ void shutdown(boolean instant) { diff --git a/smack-tcp/src/test/java/org/jivesoftware/smack/tcp/PacketWriterTest.java b/smack-tcp/src/test/java/org/jivesoftware/smack/tcp/PacketWriterTest.java index 5b501b634..204f3ddb8 100644 --- a/smack-tcp/src/test/java/org/jivesoftware/smack/tcp/PacketWriterTest.java +++ b/smack-tcp/src/test/java/org/jivesoftware/smack/tcp/PacketWriterTest.java @@ -33,7 +33,7 @@ public class PacketWriterTest { volatile boolean prematureUnblocked; /** - * Make sure that packet writer does block once the queue reaches + * Make sure that stanza(/packet) writer does block once the queue reaches * {@link PacketWriter#QUEUE_SIZE} and that * {@link PacketWriter#sendStanza(org.jivesoftware.smack.tcp.packet.Packet)} does unblock after the * interrupt.