1
0
Fork 0
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:
Guus der Kinderen 2024-09-06 21:52:50 +02:00
parent 38c6dd21b4
commit c85bcadd81
140 changed files with 270 additions and 265 deletions

View file

@ -540,7 +540,7 @@ public class JingleManager implements JingleSessionListener {
// }
/**
* When the session request is acceptable, this method should be invoked. It
* will create an JingleSession which allows the negotiation to procede.
* will create an JingleSession which allows the negotiation to proceed.
*
* @param request the remote request that is being accepted.
* @return the session which manages the rest of the negotiation.
@ -560,7 +560,7 @@ public class JingleManager implements JingleSessionListener {
/**
* When the session request is acceptable, this method should be invoked. It
* will create an JingleSession which allows the negotiation to procede.
* will create an JingleSession which allows the negotiation to proceed.
* This method use JingleMediaManager to select the supported Payload types.
*
* @param request the remote request that is being accepted.

View file

@ -221,7 +221,7 @@ public abstract class JingleNegotiator {
* <transport>
*
* This way, each segment of a Jingle stanza 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.
* part of the Jingle packet. It also allows us to support Jingle packets of arbitrary 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).

View file

@ -431,7 +431,7 @@ public final class JingleSession extends JingleNegotiator implements MediaReceiv
/**
* Complete and send a packet. Complete all the null fields in a Jingle
* reponse, using the session information we have.
* response, using the session information we have.
*
* @param jout
* the Jingle stanza we want to complete and send
@ -445,7 +445,7 @@ public final class JingleSession extends JingleNegotiator implements MediaReceiv
/**
* Complete and send a packet. Complete all the null fields in a Jingle
* reponse, using the session information we have or some info from the
* response, using the session information we have or some info from the
* incoming packet.
*
* @param iq The Jingle stanza we are responding to
@ -1097,7 +1097,7 @@ public final class JingleSession extends JingleNegotiator implements MediaReceiv
}
/**
* This is the starting point for intitiating a new session.
* This is the starting point for initiating a new session.
*
* @throws IllegalStateException if an illegal state was encountered
* @throws SmackException if Smack detected an exceptional situation.

View file

@ -56,7 +56,7 @@ public abstract class JingleSessionState {
/**
* Process an incoming Jingle Packet.
* When you look at the GoF State pattern this method roughly corresponds to example on p310: ProcessOctect()
* When you look at the GoF State pattern this method roughly corresponds to example on p310: ProcessOctet()
*
* @param session the jingle session.
* @param jingle the jingle stanza.

View file

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.jingleold.listeners;
import org.jivesoftware.smackx.jingleold.JingleSession;
/**
* Inteface used to dispatch a event when a Jingle session is created.
* Interface used to dispatch an event when a Jingle session is created.
*
* @author Thiago Camargo
*/

View file

@ -33,7 +33,7 @@ public interface JingleSessionListener extends JingleListener {
* Notification that the session has been established. Arguments specify
* the payload type and transport to use.
*
* @param pt the Payload tyep to use
* @param pt the Payload type to use
* @param remoteCandidate the remote candidate to use for connecting to the remote
* service.
* @param localCandidate the local candidate where we must listen for connections

View file

@ -25,7 +25,7 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
/**
* Public Abstract Class provides a clear interface between Media Session and Jingle API.
* <p>
* When a Jingle Session is fully stablished, we will have a Payload Type and two transport candidates defined for it.
* When a Jingle Session is fully established, we will have a Payload Type and two transport candidates defined for it.
* Smack Jingle API don't implement Media Transmit and Receive methods.
* But provides an interface to let the user implements it using another API. For instance: JMF.
* </p>
@ -153,7 +153,7 @@ public abstract class JingleMediaSession {
public abstract void startReceive();
/**
* Set transmit activity. If the active is true, the instance should trasmit.
* Set transmit activity. If the active is true, the instance should transmit.
* If it is set to false, the instance should pause transmit.
*
* @param active TODO javadoc me please
@ -173,7 +173,7 @@ public abstract class JingleMediaSession {
/**
* Called when new Media is received.
*
* @param participant the particpant.
* @param participant the participant.
*/
public void mediaReceived(String participant) {
for (MediaReceivedListener mediaReceivedListener : mediaReceivedListeners) {

View file

@ -322,7 +322,7 @@ public class PayloadType {
}
/**
* Set tha sampling clockRate for a playload type.
* Set tha sampling clockRate for a payload type.
*
* @param rate The sampling clockRate
*/

View file

@ -322,7 +322,7 @@ public class AudioChannel {
String encoding = codecFormat.getEncoding();
if (encoding.equalsIgnoreCase(AudioFormat.GSM) ||
encoding.equalsIgnoreCase(AudioFormat.GSM_RTP)) {
return milliseconds * 4; // 1 byte per millisec
return milliseconds * 4; // 1 byte per millisecond
}
else if (encoding.equalsIgnoreCase(AudioFormat.ULAW) ||
encoding.equalsIgnoreCase(AudioFormat.ULAW_RTP)) {

View file

@ -71,7 +71,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
* @throws NoProcessorException if there is no media processor.
* @throws UnsupportedFormatException if the format is not supported.
* @throws IOException if an I/O error occurred.
* @throws GeneralSecurityException if there was a geneeral security exception.
* @throws GeneralSecurityException if there was a general security exception.
*/
public static MediaSession createSession(String localhost, int localPort, String remoteHost, int remotePort, MediaSessionListener eventHandler, int quality, boolean secure, boolean micOn) throws NoProcessorException, UnsupportedFormatException, IOException, GeneralSecurityException {

View file

@ -95,7 +95,7 @@ public abstract class TransportNegotiator extends JingleNegotiator {
*
* @param session The Jingle session
* @param transResolver The JingleTransportManager to use
* @param parentNegotiator the parent ngeotiator.
* @param parentNegotiator the parent negotiator.
*/
public TransportNegotiator(JingleSession session, TransportResolver transResolver, ContentNegotiator parentNegotiator) {
super(session);

View file

@ -236,7 +236,7 @@ public abstract class TransportResolver {
}
/**
* Trigger a event notifying the initialization of the resolution process.
* Trigger an event notifying the initialization of the resolution process.
*/
private void triggerResolveInit() {
Iterator<TransportResolverListener> iter = getListenersList().iterator();
@ -250,7 +250,7 @@ public abstract class TransportResolver {
}
/**
* Trigger a event notifying the obtainment of all the candidates.
* Trigger an event notifying the obtainment of all the candidates.
*/
private void triggerResolveEnd() {
Iterator<TransportResolverListener> iter = getListenersList().iterator();

View file

@ -88,7 +88,7 @@ public abstract class JingleTransportProvider extends ExtensionElementProvider<J
public static class Ice extends JingleTransportProvider {
/**
* Defauls constructor.
* Default constructor.
*/
public Ice() {
super();
@ -183,7 +183,7 @@ public abstract class JingleTransportProvider extends ExtensionElementProvider<J
public static class RawUdp extends JingleTransportProvider {
/**
* Defauls constructor.
* Default constructor.
*/
public RawUdp() {
super();