Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-12-14 09:01:08 +01:00
Code Issues Releases Wiki Activity

Substitute 'packet' with 'stanza(/packet)' in javadoc

Browse source
This commit is contained in:
Florian Schmaus 2015-03-21 09:36:28 +01:00
parent 0ca4e8b72a
commit 5e86db4f80
168 changed files with 650 additions and 650 deletions
Download patch file Download diff file Expand all files Collapse all files

4
smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java
View file

@ -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();

36
smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java
View file

@ -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 <tt>null</tt> if no TO
* list exists.
* @param cc the collection of JIDs to include in the CC list or <tt>null</tt> 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 <tt>null</tt> if no TO list exists.
* @param cc the collection of JIDs to include in the CC list or <tt>null</tt> if no CC list exists.
* @param bcc the collection of JIDs to include in the BCC list or <tt>null</tt> 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
* <tt>null</tt> 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 <tt>null</tt>
* @param packet the stanza(/packet) to check.
* @return the MultipleRecipientInfo contained in the specified stanza(/packet) or <tt>null</tt>
* 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;

8
smack-extensions/src/main/java/org/jivesoftware/smackx/address/packet/MultipleAddresses.java
View file

@ -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<Address> addresses = new ArrayList<Address>();
/**
* 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