mirror of
https://github.com/vanitasvitae/Smack.git
synced 2025-09-09 00:59:39 +02:00
Fixes spelling (includes one API change)
Mostly benign changes. Added one new method to replace a method with a spelling mistake in its name. Kept the old method, marked as 'deprecated'.
This commit is contained in:
parent
38c6dd21b4
commit
c85bcadd81
140 changed files with 270 additions and 265 deletions
|
@ -109,7 +109,7 @@ public class FileTransferTest extends SmackTestCase {
|
|||
fail();
|
||||
}
|
||||
byte [] array = queue.take();
|
||||
assertEquals("Recieved file not equal to sent file.", testTransfer, array);
|
||||
assertEquals("Received file not equal to sent file.", testTransfer, array);
|
||||
}
|
||||
|
||||
|
||||
|
|
|
@ -50,7 +50,7 @@ public class OfflineMessageManagerTest extends SmackTestCase {
|
|||
/**
|
||||
* While user2 is connected but unavailable, user1 sends 2 messages to user1. User2 then
|
||||
* performs some "Flexible Offline Message Retrieval" checking the number of offline messages,
|
||||
* retriving the headers, then the real messages of the headers and finally removing the
|
||||
* retrieving the headers, then the real messages of the headers and finally removing the
|
||||
* loaded messages.
|
||||
*/
|
||||
public void testReadAndDelete() {
|
||||
|
|
|
@ -90,7 +90,7 @@ public class ServiceDiscoveryManagerTest extends SmackTestCase {
|
|||
*/
|
||||
public void testXHTMLFeature() {
|
||||
// Check for local XHTML service support
|
||||
// By default the XHTML service support is enabled in all the connections
|
||||
// By default,the XHTML service support is enabled in all the connections
|
||||
assertTrue(XHTMLManager.isServiceEnabled(getConnection(0)));
|
||||
assertTrue(XHTMLManager.isServiceEnabled(getConnection(1)));
|
||||
// Check for XHTML support in connection1 from connection2
|
||||
|
|
|
@ -93,7 +93,7 @@ public class MultipleAddresses implements ExtensionElement {
|
|||
|
||||
/**
|
||||
* Returns the list of addresses that matches the specified type. Examples of address
|
||||
* type are: TO, CC, BCC, etc..
|
||||
* type are: TO, CC, BCC, etc.
|
||||
*
|
||||
* @param type Examples of address type are: TO, CC, BCC, etc.
|
||||
* @return the list of addresses that matches the specified type.
|
||||
|
|
|
@ -44,13 +44,13 @@ import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
|
|||
import org.jxmpp.jid.Jid;
|
||||
|
||||
/**
|
||||
* Block communications with contancts and other entities using XEP-0191.
|
||||
* Block communications with contacts and other entities using XEP-0191.
|
||||
* Allows to
|
||||
* <ul>
|
||||
* <li>Check push notifications support</li>
|
||||
* <li>Get blocking list</li>
|
||||
* <li>Block contact</li>
|
||||
* <li>Unblock conact</li>
|
||||
* <li>Unblock contact</li>
|
||||
* <li>Unblock all</li>
|
||||
* </ul>
|
||||
*
|
||||
|
|
|
@ -103,7 +103,7 @@ public final class BookmarkManager {
|
|||
*
|
||||
* @param name the name of the conference
|
||||
* @param jid the jid of the conference
|
||||
* @param isAutoJoin whether or not to join this conference automatically on login
|
||||
* @param isAutoJoin whether to join this conference automatically on login
|
||||
* @param nickname the nickname to use for the user when joining the conference
|
||||
* @param password the password to use for the user when joining the conference
|
||||
* @throws XMPPErrorException thrown when there is an issue retrieving the current bookmarks from
|
||||
|
@ -166,7 +166,7 @@ public final class BookmarkManager {
|
|||
* Returns an unmodifiable collection of all bookmarked urls.
|
||||
*
|
||||
* @return returns an unmodifiable collection of all bookmarked urls.
|
||||
* @throws XMPPErrorException thrown when there is a problem retriving bookmarks from the server.
|
||||
* @throws XMPPErrorException thrown when there is a problem retrieving bookmarks from the server.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
|
@ -181,8 +181,8 @@ public final class BookmarkManager {
|
|||
*
|
||||
* @param URL the url of the bookmark
|
||||
* @param name the name of the bookmark
|
||||
* @param isRSS whether or not the url is an rss feed
|
||||
* @throws XMPPErrorException thrown when there is an error retriving or saving bookmarks from or to
|
||||
* @param isRSS whether the url is an RSS feed
|
||||
* @throws XMPPErrorException thrown when there is an error retrieving or saving bookmarks from or to
|
||||
* the server
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
|
@ -210,7 +210,7 @@ public final class BookmarkManager {
|
|||
* Removes a url from the bookmarks.
|
||||
*
|
||||
* @param bookmarkURL the url of the bookmark to remove
|
||||
* @throws XMPPErrorException thrown if there is an error retriving or saving bookmarks from or to
|
||||
* @throws XMPPErrorException thrown if there is an error retrieving or saving bookmarks from or to
|
||||
* the server.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
|
|
|
@ -511,7 +511,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the list of session IDs that should be ignored by the InitialtionListener
|
||||
* Returns the list of session IDs that should be ignored by the InitiationListener
|
||||
*
|
||||
* @return list of session IDs
|
||||
*/
|
||||
|
|
|
@ -139,7 +139,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
|||
/* timeout for connecting to the SOCKS5 proxy selected by the target */
|
||||
private int proxyConnectionTimeout = 10000;
|
||||
|
||||
/* blacklist of errornous SOCKS5 proxies */
|
||||
/* blacklist of erroneous SOCKS5 proxies */
|
||||
private final Set<Jid> proxyBlacklist = Collections.synchronizedSet(new HashSet<Jid>());
|
||||
|
||||
/* remember the last proxy that worked to prioritize it */
|
||||
|
@ -390,7 +390,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
|||
}
|
||||
|
||||
/**
|
||||
* Set whether or not the bytestream manager will annouce the local stream host(s), i.e. the local SOCKS5 proxy.
|
||||
* Set whether the bytestream manager will announce the local stream host(s), i.e. the local SOCKS5 proxy.
|
||||
*
|
||||
* @param announceLocalStreamHost TODO javadoc me please
|
||||
* @see #isAnnouncingLocalStreamHostEnabled()
|
||||
|
@ -580,7 +580,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
|||
proxyInfo = serviceDiscoveryManager.discoverInfo(item.getEntityID());
|
||||
}
|
||||
catch (NoResponseException | XMPPErrorException e) {
|
||||
// blacklist errornous server
|
||||
// blacklist erroneous server
|
||||
proxyBlacklist.add(item.getEntityID());
|
||||
continue;
|
||||
}
|
||||
|
@ -627,7 +627,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
|||
streamHosts.addAll(response.getStreamHosts());
|
||||
}
|
||||
catch (Exception e) {
|
||||
// blacklist errornous proxies
|
||||
// blacklist erroneous proxies
|
||||
this.proxyBlacklist.add(proxy);
|
||||
}
|
||||
}
|
||||
|
@ -796,7 +796,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the list of session IDs that should be ignored by the InitialtionListener
|
||||
* Returns the list of session IDs that should be ignored by the InitiationListener
|
||||
*
|
||||
* @return list of session IDs
|
||||
*/
|
||||
|
|
|
@ -138,7 +138,7 @@ public class Socks5Client {
|
|||
byte[] connectionRequest;
|
||||
byte[] connectionResponse;
|
||||
/*
|
||||
* use DataInputStream/DataOutpuStream to assure read and write is completed in a single
|
||||
* use DataInputStream/DataOutputStream to assure read and write is completed in a single
|
||||
* statement
|
||||
*/
|
||||
DataInputStream in = new DataInputStream(socket.getInputStream());
|
||||
|
|
|
@ -91,7 +91,7 @@ import org.jxmpp.util.cache.LruCache;
|
|||
* but XEP-0030 then XEP-0030 mechanisms are transparently used.
|
||||
* </p>
|
||||
* <p>
|
||||
* The caches used by Smack for Entity Capabilities is non-persisent per default. However, it is is also possible to set
|
||||
* The caches used by Smack for Entity Capabilities is non-persistent per default. However, it is is also possible to set
|
||||
* a persistent Entity Capabilities cache, which is recommended.
|
||||
* </p>
|
||||
* <h2>Examples</h2>
|
||||
|
@ -226,7 +226,7 @@ public final class EntityCapsManager extends Manager {
|
|||
|
||||
/**
|
||||
* Get the Node version (node#ver) of a JID. Returns a String or null if
|
||||
* EntiyCapsManager does not have any information.
|
||||
* EntityCapsManager does not have any information.
|
||||
*
|
||||
* @param jid TODO javadoc me please
|
||||
* the user (Full JID)
|
||||
|
|
|
@ -654,7 +654,7 @@ public final class AdHocCommandManager extends Manager {
|
|||
public AdHocCommandHandler getCommandInstance() throws InstantiationException,
|
||||
IllegalAccessException, IllegalArgumentException, InvocationTargetException {
|
||||
String sessionId;
|
||||
// TODO: The code below contains a race condition. Use CopncurrentHashMap.computeIfAbsent() to remove the
|
||||
// TODO: The code below contains a race condition. Use ConcurrentHashMap.computeIfAbsent() to remove the
|
||||
// race condition once Smack's minimum Android API level 24 or higher.
|
||||
int attempt = 0;
|
||||
do {
|
||||
|
|
|
@ -23,14 +23,14 @@ import org.jivesoftware.smack.packet.Stanza;
|
|||
import org.jivesoftware.smackx.delay.DelayInformationManager;
|
||||
|
||||
/**
|
||||
* Filters stanza with delay information, ie. stanzas that got delayed for some reason
|
||||
* Filters stanza with delay information, i.e. stanzas that got delayed for some reason
|
||||
*/
|
||||
public final class DelayedStanzaFilter implements StanzaFilter {
|
||||
|
||||
public static final StanzaFilter INSTANCE = new DelayedStanzaFilter();
|
||||
|
||||
/**
|
||||
* Filters stanzas that got not delayed, ie. have no delayed information
|
||||
* Filters stanzas that got not delayed, i.e. have no delayed information
|
||||
*/
|
||||
public static final StanzaFilter NOT_DELAYED_STANZA = new NotFilter(INSTANCE);
|
||||
|
||||
|
|
|
@ -294,7 +294,7 @@ public final class ServiceDiscoveryManager extends Manager {
|
|||
/**
|
||||
* Returns all identities of this client as unmodifiable Collection.
|
||||
*
|
||||
* @return all identies as set
|
||||
* @return all identities as a set
|
||||
*/
|
||||
public Set<DiscoverInfo.Identity> getIdentities() {
|
||||
Set<Identity> res = new HashSet<>(identities);
|
||||
|
|
|
@ -215,7 +215,7 @@ public class DiscoverInfo extends IQ implements DiscoverInfoView {
|
|||
*
|
||||
* @param category category the category to look for.
|
||||
* @param type type the type to look for.
|
||||
* @return a list of Identites with the given category and type.
|
||||
* @return a list of Identities with the given category and type.
|
||||
*/
|
||||
public List<Identity> getIdentities(String category, String type) {
|
||||
List<Identity> res = new ArrayList<>(identities.size());
|
||||
|
|
|
@ -51,7 +51,7 @@ import org.jivesoftware.smack.util.CloseableUtil;
|
|||
* The second way that a file can be received through this class is by invoking
|
||||
* the {@link #receiveFile(File)} method. This method returns immediately and
|
||||
* takes as its parameter a file on the local file system where the file
|
||||
* recieved from the transfer will be put.
|
||||
* received from the transfer will be put.
|
||||
*
|
||||
* @author Alexander Wenckus
|
||||
*/
|
||||
|
|
|
@ -52,7 +52,7 @@ public abstract class StreamNegotiator extends Manager {
|
|||
}
|
||||
|
||||
/**
|
||||
* A event manager for stream initiation requests send to us.
|
||||
* An event manager for stream initiation requests send to us.
|
||||
* <p>
|
||||
* Those are typical XEP-45 Open or XEP-65 Bytestream IQ requests. The even key is in the format
|
||||
* "initiationFrom + '\t' + streamId"
|
||||
|
|
|
@ -144,7 +144,7 @@
|
|||
* <li>**isDone()** - Similar to getProgress() except it returns a _boolean_. If the state is rejected, canceled, error,
|
||||
* or complete then true will be returned and false otherwise.</li>
|
||||
* <li>**getError()** - If there is an error during the file transfer this method will return the type of error that
|
||||
* occured.</li>
|
||||
* occurred.</li>
|
||||
* </ul>
|
||||
* <h3>Examples</h3>
|
||||
* <p>
|
||||
|
|
|
@ -43,7 +43,7 @@ import org.jxmpp.jid.Jid;
|
|||
* <br>
|
||||
* To publish a UserLocation, please use {@link #publishGeoLocation(GeoLocation)} method. This will publish the node.
|
||||
* <br>
|
||||
* To stop publishing a UserLocation, please use {@link #stopPublishingGeolocation()} method. This will send a disble publishing signal.
|
||||
* To stop publishing a UserLocation, please use {@link #stopPublishingGeolocation()} method. This will send a disable publishing signal.
|
||||
* <br>
|
||||
* To add a {@link PepEventListener} in order to remain updated with other users GeoLocation, use {@link #addGeoLocationListener(PepEventListener)} method.
|
||||
* <br>
|
||||
|
|
|
@ -41,7 +41,7 @@ public interface PrivateData {
|
|||
String getNamespace();
|
||||
|
||||
/**
|
||||
* Returns the XML reppresentation of the PrivateData.
|
||||
* Returns the XML representation of the PrivateData.
|
||||
*
|
||||
* @return the private data as XML.
|
||||
*/
|
||||
|
|
|
@ -52,7 +52,7 @@ import org.jxmpp.jid.FullJid;
|
|||
* | transport-info
|
||||
* | transport-reject
|
||||
* | transport-replace
|
||||
* │ initator (RECOMMENDED for session initiate, NOT RECOMMENDED otherwise, full JID, XEP-0166 § 7.1)
|
||||
* │ initiator (RECOMMENDED for session initiate, NOT RECOMMENDED otherwise, full JID, XEP-0166 § 7.1)
|
||||
* │ responder (RECOMMENDED for session accept, NOT RECOMMENDED otherwise, full JID. XEP-0166 § 7.1)
|
||||
* │ sid (REQUIRED, SHOULD match XML Nmtoken production)
|
||||
* │
|
||||
|
|
|
@ -71,7 +71,7 @@ public final class JingleContent implements XmlElement {
|
|||
private final JingleContentTransport transport;
|
||||
|
||||
/**
|
||||
* Creates a content description..
|
||||
* Creates a content description.
|
||||
*/
|
||||
private JingleContent(Creator creator, String disposition, String name, Senders senders,
|
||||
JingleContentDescription description, JingleContentTransport transport) {
|
||||
|
|
|
@ -70,7 +70,7 @@ chat.sendMessage(message);</code>
|
|||
* <ul>
|
||||
* <li>When you send a Java object as a property, only clients running Java will be able to interpret the data. So,
|
||||
* consider using a series of primitive values to transfer data instead.</li>
|
||||
* <li>Objects sent as property values must implement Serialiable. Additionally, both the sender and receiver must have
|
||||
* <li>Objects sent as property values must implement Serializable. Additionally, both the sender and receiver must have
|
||||
* identical versions of the class, or a serialization exception will occur when de-serializing the object.</li>
|
||||
* <li>Serialized objects can potentially be quite large, which will use more bandwidth and server resources.</li>
|
||||
* </ul>
|
||||
|
|
|
@ -55,10 +55,10 @@ public class Affiliate {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the affiliation of the afffiliated user. Possible affiliations are: "owner", "admin",
|
||||
* Returns the affiliation of the affiliated user. Possible affiliations are: "owner", "admin",
|
||||
* "member", "outcast". This information will always be available.
|
||||
*
|
||||
* @return the affiliation of the afffiliated user.
|
||||
* @return the affiliation of the affiliated user.
|
||||
*/
|
||||
public MUCAffiliation getAffiliation() {
|
||||
return affiliation;
|
||||
|
|
|
@ -25,7 +25,7 @@ import org.jxmpp.jid.parts.Resourcepart;
|
|||
* Default implementation of the ParticipantStatusListener interface.<p>
|
||||
*
|
||||
* This class does not provide any behavior by default. It just avoids having
|
||||
* to implement all the inteface methods if the user is only interested in implementing
|
||||
* to implement all the interface methods if the user is only interested in implementing
|
||||
* some of the methods.
|
||||
*
|
||||
* @author Gaston Dombiak
|
||||
|
|
|
@ -23,7 +23,7 @@ import org.jxmpp.jid.Jid;
|
|||
* Default implementation of the UserStatusListener interface.<p>
|
||||
*
|
||||
* This class does not provide any behavior by default. It just avoids having
|
||||
* to implement all the inteface methods if the user is only interested in implementing
|
||||
* to implement all the interface methods if the user is only interested in implementing
|
||||
* some of the methods.
|
||||
*
|
||||
* @author Gaston Dombiak
|
||||
|
|
|
@ -285,7 +285,7 @@ public class MucConfigFormManager {
|
|||
|
||||
|
||||
/**
|
||||
* Check if the room supports its visibility being controlled vioa configuration.
|
||||
* Check if the room supports its visibility being controlled via configuration.
|
||||
*
|
||||
* @return <code>true</code> if supported, <code>false</code> if not.
|
||||
*/
|
||||
|
|
|
@ -351,7 +351,7 @@ public class MultiUserChat {
|
|||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there was an XMPP error returned.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
* @see <a href="http://xmpp.org/extensions/xep-0045.html#enter">XEP-45 7.2 Entering a Room</a>
|
||||
*/
|
||||
private Presence enter(MucEnterConfiguration conf) throws NotConnectedException, NoResponseException,
|
||||
|
@ -365,7 +365,7 @@ public class MultiUserChat {
|
|||
// field is in the form "roomName@service/nickname"
|
||||
Presence joinPresence = conf.getJoinPresence(this);
|
||||
|
||||
// Setup the messageListeners and presenceListeners *before* the join presence is send.
|
||||
// Set up the messageListeners and presenceListeners *before* the join presence is sent.
|
||||
connection.addStanzaListener(messageListener, fromRoomGroupchatFilter);
|
||||
StanzaFilter presenceFromRoomFilter = new AndFilter(fromRoomFilter,
|
||||
StanzaTypeFilter.PRESENCE,
|
||||
|
@ -401,12 +401,12 @@ public class MultiUserChat {
|
|||
StanzaCollector presenceStanzaCollector = null;
|
||||
final Presence reflectedSelfPresence;
|
||||
try {
|
||||
// This stanza collector will collect the final self presence from the MUC, which also signals that we have successful entered the MUC.
|
||||
// This stanza collector will collect the final self presence from the MUC, which also signals that we have successfully entered the MUC.
|
||||
StanzaCollector selfPresenceCollector = connection.createStanzaCollectorAndSend(responseFilter, joinPresence);
|
||||
StanzaCollector.Configuration presenceStanzaCollectorConfguration = StanzaCollector.newConfiguration().setCollectorToReset(
|
||||
StanzaCollector.Configuration presenceStanzaCollectorConfiguration = StanzaCollector.newConfiguration().setCollectorToReset(
|
||||
selfPresenceCollector).setStanzaFilter(presenceFromRoomFilter);
|
||||
// This stanza collector is used to reset the timeout of the selfPresenceCollector.
|
||||
presenceStanzaCollector = connection.createStanzaCollector(presenceStanzaCollectorConfguration);
|
||||
presenceStanzaCollector = connection.createStanzaCollector(presenceStanzaCollectorConfiguration);
|
||||
reflectedSelfPresence = selfPresenceCollector.nextResultOrThrow(conf.getTimeout());
|
||||
}
|
||||
catch (NotConnectedException | InterruptedException | NoResponseException | XMPPErrorException e) {
|
||||
|
@ -423,15 +423,15 @@ public class MultiUserChat {
|
|||
synchronized (presenceListener) {
|
||||
// Only continue after we have received *and* processed the reflected self-presence. Since presences are
|
||||
// handled in an extra listener, we may return from enter() without having processed all presences of the
|
||||
// participants, resulting in a e.g. to low participant counter after enter(). Hence we wait here until the
|
||||
// participants, resulting in a e.g. to low participant counter after enter(). Hence, we wait here until the
|
||||
// processing is done.
|
||||
while (!processedReflectedSelfPresence) {
|
||||
presenceListener.wait();
|
||||
}
|
||||
}
|
||||
|
||||
// This presence must be send from a full JID. We use the resourcepart of this JID as nick, since the room may
|
||||
// performed roomnick rewriting
|
||||
// This presence must be sent from a full JID. We use the resourcepart of this JID as nick, since the room may
|
||||
// have performed roomnick rewriting
|
||||
Resourcepart receivedNickname = reflectedSelfPresence.getFrom().getResourceOrThrow();
|
||||
setNickname(receivedNickname);
|
||||
|
||||
|
@ -481,7 +481,7 @@ public class MultiUserChat {
|
|||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws MucAlreadyJoinedException if already joined the Multi-User Chat.7y
|
||||
* @throws MissingMucCreationAcknowledgeException if there MUC creation was not acknowledged by the service.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public synchronized MucCreateConfigFormHandle create(Resourcepart nickname) throws NoResponseException,
|
||||
XMPPErrorException, InterruptedException, MucAlreadyJoinedException,
|
||||
|
@ -515,7 +515,7 @@ public class MultiUserChat {
|
|||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws MucAlreadyJoinedException if already joined the Multi-User Chat.7y
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public synchronized MucCreateConfigFormHandle createOrJoin(Resourcepart nickname) throws NoResponseException, XMPPErrorException,
|
||||
InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException {
|
||||
|
@ -537,7 +537,7 @@ public class MultiUserChat {
|
|||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws MucAlreadyJoinedException if the MUC is already joined
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public synchronized MucCreateConfigFormHandle createOrJoin(MucEnterConfiguration mucEnterConfiguration)
|
||||
throws NoResponseException, XMPPErrorException, InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException {
|
||||
|
@ -610,7 +610,7 @@ public class MultiUserChat {
|
|||
* @throws XMPPErrorException if there was an XMPP error returned.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public MucCreateConfigFormHandle createOrJoinIfNecessary(Resourcepart nickname, String password) throws NoResponseException,
|
||||
XMPPErrorException, NotConnectedException, InterruptedException, NotAMucServiceException {
|
||||
|
@ -646,7 +646,7 @@ public class MultiUserChat {
|
|||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public Presence join(Resourcepart nickname) throws NoResponseException, XMPPErrorException,
|
||||
NotConnectedException, InterruptedException, NotAMucServiceException {
|
||||
|
@ -676,7 +676,7 @@ public class MultiUserChat {
|
|||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public void join(Resourcepart nickname, String password) throws XMPPErrorException, InterruptedException, NoResponseException, NotConnectedException, NotAMucServiceException {
|
||||
MucEnterConfiguration.Builder builder = getEnterConfigurationBuilder(nickname).withPassword(
|
||||
|
@ -709,7 +709,7 @@ public class MultiUserChat {
|
|||
* @throws NoResponseException if there was no response from the server.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
*/
|
||||
public synchronized Presence join(MucEnterConfiguration mucEnterConfiguration)
|
||||
throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException, NotAMucServiceException {
|
||||
|
@ -833,9 +833,9 @@ public class MultiUserChat {
|
|||
/**
|
||||
* Returns the room's configuration form that the room's owner can use.
|
||||
* The configuration form allows to set the room's language,
|
||||
* enable logging, specify room's type, etc..
|
||||
* enable logging, specify room's type, etc.
|
||||
*
|
||||
* @return the Form that contains the fields to complete together with the instrucions or
|
||||
* @return the Form that contains the fields to complete together with the instructions or
|
||||
* <code>null</code> if no configuration is possible.
|
||||
* @throws XMPPErrorException if an error occurs asking the configuration form for the room.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
|
@ -889,7 +889,7 @@ public class MultiUserChat {
|
|||
* error to the user (error code 405).
|
||||
*
|
||||
* @return the registration Form that contains the fields to complete together with the
|
||||
* instrucions or <code>null</code> if no registration is possible.
|
||||
* instructions or <code>null</code> if no registration is possible.
|
||||
* @throws XMPPErrorException if an error occurs asking the registration form for the room or a
|
||||
* 405 error if the user is not allowed to register with the room.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
|
@ -1598,7 +1598,7 @@ public class MultiUserChat {
|
|||
/**
|
||||
* Grants moderator privileges to participants or visitors. Room administrators may grant
|
||||
* moderator privileges. A moderator is allowed to kick users, grant and revoke voice, invite
|
||||
* other users, modify room's subject plus all the partcipants privileges.
|
||||
* other users, modify room's subject plus all the participant privileges.
|
||||
*
|
||||
* @param nicknames the nicknames of the occupants to grant moderator privileges.
|
||||
* @throws XMPPErrorException if an error occurs granting moderator privileges to a user.
|
||||
|
@ -1613,7 +1613,7 @@ public class MultiUserChat {
|
|||
/**
|
||||
* Grants moderator privileges to a participant or visitor. Room administrators may grant
|
||||
* moderator privileges. A moderator is allowed to kick users, grant and revoke voice, invite
|
||||
* other users, modify room's subject plus all the partcipants privileges.
|
||||
* other users, modify room's subject plus all the participant privileges.
|
||||
*
|
||||
* @param nickname the nickname of the occupant to grant moderator privileges.
|
||||
* @throws XMPPErrorException if an error occurs granting moderator privileges to a user.
|
||||
|
@ -2171,7 +2171,7 @@ public class MultiUserChat {
|
|||
/**
|
||||
* Polls for and returns the next message, or <code>null</code> if there isn't
|
||||
* a message immediately available. This method provides significantly different
|
||||
* functionalty than the {@link #nextMessage()} method since it's non-blocking.
|
||||
* functionality than the {@link #nextMessage()} method since it's non-blocking.
|
||||
* In other words, the method call will always return immediately, whereas the
|
||||
* nextMessage method will return only when a message is available (or after
|
||||
* a specific timeout).
|
||||
|
@ -2204,7 +2204,7 @@ public class MultiUserChat {
|
|||
|
||||
/**
|
||||
* Returns the next available message in the chat. The method call will block
|
||||
* (not return) until a stanza is available or the <code>timeout</code> has elapased.
|
||||
* (not return) until a stanza is available or the <code>timeout</code> has elapsed.
|
||||
* If the timeout elapses without a result, <code>null</code> will be returned.
|
||||
*
|
||||
* @param timeout the maximum amount of time to wait for the next message.
|
||||
|
|
|
@ -298,7 +298,7 @@ public final class MultiUserChatManager extends Manager {
|
|||
* {@link MultiUserChat#join(org.jxmpp.jid.parts.Resourcepart) join} the chat room. On some server implementations, the room will not be
|
||||
* created until the first person joins it.
|
||||
* <p>
|
||||
* Most XMPP servers use a sub-domain for the chat service (eg chat.example.com for the XMPP server example.com).
|
||||
* Most XMPP servers use a sub-domain for the chat service (e.g.chat.example.com for the XMPP server example.com).
|
||||
* You must ensure that the room address you're trying to connect to includes the proper chat sub-domain.
|
||||
* </p>
|
||||
*
|
||||
|
@ -481,7 +481,7 @@ public final class MultiUserChatManager extends Manager {
|
|||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC serivce.
|
||||
* @throws NotAMucServiceException if the entity is not a MUC service.
|
||||
* @since 4.3.1
|
||||
*/
|
||||
public Map<EntityBareJid, HostedRoom> getRoomsHostedBy(DomainBareJid serviceName) throws NoResponseException, XMPPErrorException,
|
||||
|
|
|
@ -129,7 +129,7 @@ public interface ParticipantStatusListener {
|
|||
/**
|
||||
* Called when an administrator grants moderator privileges to a user. This means that the user
|
||||
* will be able to kick users, grant and revoke voice, invite other users, modify room's
|
||||
* subject plus all the partcipants privileges.
|
||||
* subject plus all the participant privileges.
|
||||
*
|
||||
* @param participant the participant that was granted moderator privileges in the room
|
||||
* (e.g. room@conference.jabber.org/nick).
|
||||
|
@ -140,7 +140,7 @@ public interface ParticipantStatusListener {
|
|||
/**
|
||||
* Called when an administrator revokes moderator privileges from a user. This means that the
|
||||
* user will no longer be able to kick users, grant and revoke voice, invite other users,
|
||||
* modify room's subject plus all the partcipants privileges.
|
||||
* modify room's subject plus all the participant privileges.
|
||||
*
|
||||
* @param participant the participant that was revoked moderator privileges in the room
|
||||
* (e.g. room@conference.jabber.org/nick).
|
||||
|
|
|
@ -77,7 +77,7 @@ public class RoomInfo {
|
|||
*/
|
||||
private final boolean moderated;
|
||||
/**
|
||||
* Every presence stanza can include the JID of every occupant unless the owner deactives this
|
||||
* Every presence stanza can include the JID of every occupant unless the owner deactivates this
|
||||
* configuration.
|
||||
*/
|
||||
private final boolean nonanonymous;
|
||||
|
@ -250,7 +250,7 @@ public class RoomInfo {
|
|||
/**
|
||||
* Returns the room name.
|
||||
* <p>
|
||||
* The name returnd here was provided as value of the name attribute
|
||||
* The name returned here was provided as value of the name attribute
|
||||
* of the returned identity within the disco#info result.
|
||||
* </p>
|
||||
*
|
||||
|
@ -324,9 +324,9 @@ public class RoomInfo {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if users musy provide a valid password in order to join the room.
|
||||
* Returns true if users must provide a valid password in order to join the room.
|
||||
*
|
||||
* @return true if users musy provide a valid password in order to join the room.
|
||||
* @return true if users must provide a valid password in order to join the room.
|
||||
*/
|
||||
public boolean isPasswordProtected() {
|
||||
return passwordProtected;
|
||||
|
|
|
@ -39,7 +39,7 @@ public interface UserStatusListener {
|
|||
|
||||
/**
|
||||
* Called when a moderator kicked your user from the room. This means that you are no longer
|
||||
* participanting in the room.
|
||||
* participating in the room.
|
||||
*
|
||||
* @param actor the moderator that kicked your user from the room (e.g. user@host.org).
|
||||
* @param reason the reason provided by the actor to kick you from the room.
|
||||
|
@ -106,7 +106,7 @@ public interface UserStatusListener {
|
|||
/**
|
||||
* Called when an administrator grants moderator privileges to your user. This means that you
|
||||
* will be able to kick users, grant and revoke voice, invite other users, modify room's
|
||||
* subject plus all the partcipants privileges.
|
||||
* subject plus all the participant privileges.
|
||||
*
|
||||
*/
|
||||
default void moderatorGranted() {
|
||||
|
@ -115,7 +115,7 @@ public interface UserStatusListener {
|
|||
/**
|
||||
* Called when an administrator revokes moderator privileges from your user. This means that
|
||||
* you will no longer be able to kick users, grant and revoke voice, invite other users,
|
||||
* modify room's subject plus all the partcipants privileges.
|
||||
* modify room's subject plus all the participant privileges.
|
||||
*
|
||||
*/
|
||||
default void moderatorRevoked() {
|
||||
|
|
|
@ -534,7 +534,7 @@
|
|||
* </p>
|
||||
* <h3>Usage</h3>
|
||||
* <p>
|
||||
* In order to grant membership to a room, administrator privileges or owner priveliges just send
|
||||
* In order to grant membership to a room, administrator privileges or owner privileges just send
|
||||
* **grantMembership(String jid)**, **grantAdmin(String jid)** or **grantOwnership(String jid)** to _**MultiUserChat**_
|
||||
* respectively. Use **revokeMembership(String jid)**, **revokeAdmin(String jid)** or revokeOwnership(String jid)** to
|
||||
* revoke the membership to a room, administrator privileges or owner priveliges respectively.
|
||||
|
|
|
@ -35,7 +35,7 @@ public class Nick implements ExtensionElement {
|
|||
public static final QName QNAME = new QName(NAMESPACE, "nick");
|
||||
|
||||
/**
|
||||
* Deprected, do not use.
|
||||
* Deprecated, do not use.
|
||||
*
|
||||
* @deprecated use {@link #QNAME} instead.
|
||||
*/
|
||||
|
|
|
@ -288,7 +288,7 @@ public final class PepManager extends Manager {
|
|||
*/
|
||||
public LeafNode publish(String nodeId, Item item) throws NotConnectedException, InterruptedException,
|
||||
NoResponseException, XMPPErrorException, NotALeafNodeException {
|
||||
// PEP nodes are auto created if not existent. Hence Use PubSubManager.tryToPublishAndPossibleAutoCreate() here.
|
||||
// PEP nodes are auto created if not existent. Hence, use PubSubManager.tryToPublishAndPossibleAutoCreate() here.
|
||||
return pepPubSubManager.tryToPublishAndPossibleAutoCreate(nodeId, item);
|
||||
}
|
||||
|
||||
|
|
|
@ -150,11 +150,11 @@ public final class PingManager extends Manager {
|
|||
|
||||
// We may received an error response from an intermediate service returning an error like
|
||||
// 'remote-server-not-found' or 'remote-server-timeout' to us (which would fake the 'from' address,
|
||||
// see RFC 6120 § 8.3.1 2.). Or the recipient could became unavailable.
|
||||
// see RFC 6120 § 8.3.1 2.). Or the recipient could become unavailable.
|
||||
|
||||
// Sticking with the current rules of RFC 6120/6121, it is undecidable at this point whether we received an
|
||||
// error response from the pinged entity or not. This is because a service-unavailable error condition is
|
||||
// *required* (as per the RFCs) to be send back in both relevant cases:
|
||||
// *required* (as per the RFCs) to be sent back in both relevant cases:
|
||||
// 1. When the receiving entity is unaware of the IQ request type. RFC 6120 § 8.4.:
|
||||
// "If an intended recipient receives an IQ stanza of type "get" or
|
||||
// "set" containing a child element qualified by a namespace it does
|
||||
|
@ -244,7 +244,7 @@ public final class PingManager extends Manager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Same as calling {@link #ping(Jid, long)} with the defaultpacket reply
|
||||
* Same as calling {@link #ping(Jid, long)} with the default packet reply
|
||||
* timeout.
|
||||
*
|
||||
* @param jid The id of the entity the ping is being sent to
|
||||
|
|
|
@ -156,7 +156,7 @@
|
|||
* <p>
|
||||
* In order to handle privacy changes, clients SHOULD listen manager’s updates. When a list is changed the manager
|
||||
* notifies every added listener. Listeners MUST implement the <code>PrivacyListListener</code> interface. Clients may
|
||||
* need to react when a privacy list is modified. The <code>PrivacyListManager</code> lets you add listerners that will
|
||||
* need to react when a privacy list is modified. The <code>PrivacyListManager</code> lets you add listeners that will
|
||||
* be notified when a list has been changed. Listeners should implement the <code>PrivacyListListener</code> interface.
|
||||
* </p>
|
||||
* <p>
|
||||
|
|
|
@ -171,7 +171,7 @@ public class PrivacyItem {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets wheather the receiver allows or denies incoming messages or not.
|
||||
* Sets whether the receiver allows or denies incoming messages or not.
|
||||
*
|
||||
* @param filterMessage indicates if the receiver allows or denies incoming messages or not.
|
||||
*/
|
||||
|
|
|
@ -263,7 +263,7 @@ public final class PubSubManager extends Manager {
|
|||
DataForm submitForm = config.getDataFormToSubmit();
|
||||
request.addExtension(new FormNode(FormNodeType.CONFIGURE, submitForm));
|
||||
NodeType nodeType = config.getNodeType();
|
||||
// Note that some implementations do to have the pubsub#node_type field in their defauilt configuration,
|
||||
// Note that some implementations do to have the pubsub#node_type field in their default configuration,
|
||||
// which I believe to be a bug. However, since PubSub specifies the default node type to be 'leaf' we assume
|
||||
// leaf if the field does not exist.
|
||||
isLeafNode = nodeType == null || nodeType == NodeType.leaf;
|
||||
|
|
|
@ -66,7 +66,7 @@ public class SimplePayload implements XmlElement {
|
|||
* @param elementName The root element name (of the payload)
|
||||
* @param namespace The namespace of the payload, null if there is none
|
||||
* @param xmlPayload The payload data
|
||||
* @deprecated use {@link #SimplePayload(String)} insteas.
|
||||
* @deprecated use {@link #SimplePayload(String)} instead.
|
||||
*/
|
||||
// TODO: Remove in Smack 4.5
|
||||
@Deprecated
|
||||
|
|
|
@ -150,7 +150,7 @@ public class ReportedData {
|
|||
/**
|
||||
* Creates a new column with the specified definition.
|
||||
*
|
||||
* @param label the columns's label.
|
||||
* @param label the column's label.
|
||||
* @param variable the variable name of the column.
|
||||
* @param type the format for the returned data.
|
||||
*/
|
||||
|
|
|
@ -122,7 +122,7 @@ public final class VCard extends IQ {
|
|||
private String photoBinval;
|
||||
|
||||
/**
|
||||
* Such as DESC ROLE GEO etc.. see XEP-0054
|
||||
* Such as DESC ROLE GEO etc. see XEP-0054
|
||||
*/
|
||||
private final Map<String, String> otherSimpleFields = new HashMap<>();
|
||||
|
||||
|
@ -575,7 +575,7 @@ public final class VCard extends IQ {
|
|||
* Load VCard information for a given user. XMPPConnection should be authenticated and not anonymous.
|
||||
*
|
||||
* @param connection connection.
|
||||
* @param user user whos information we want to load.
|
||||
* @param user user whose information we want to load.
|
||||
*
|
||||
* @throws XMPPErrorException if there was an XMPP error returned.
|
||||
* @throws NoResponseException if there was no response from the server.
|
||||
|
|
|
@ -36,7 +36,7 @@ public class BooleanFormField extends SingleValueFormField {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the value of the booelan field. Note that, if no explicit boolean value is provided, in the form of "true",
|
||||
* Get the value of the boolean field. Note that, if no explicit boolean value is provided, in the form of "true",
|
||||
* "false", "0", or "1", then the default value of a boolean field is <code>false</code>, according to
|
||||
* XEP-0004 § 3.3.
|
||||
*
|
||||
|
|
|
@ -152,7 +152,7 @@
|
|||
* Before you start to send XHTML messages to a user you should discover if the user supports XHTML messages. There are
|
||||
* two ways to achieve the discovery, explicitly and implicitly. Explicit is when you first try to discover if the user
|
||||
* supports XHTML before sending any XHTML message. Implicit is when you send XHTML messages without first discovering
|
||||
* if the conversation partner's client supports XHTML and depenging on the answer (normal message or XHTML message) you
|
||||
* if the conversation partner's client supports XHTML and depending on the answer (normal message or XHTML message) you
|
||||
* find out if the user supports XHTML messages or not. This section explains how to explicitly discover for XHTML
|
||||
* support.
|
||||
* </p>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue