1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-09-09 18:29:45 +02:00

Enable javadoc checkstyle

and fix violations.
This commit is contained in:
Florian Schmaus 2015-03-29 12:15:32 +02:00
parent 57260b2a44
commit 64d134052d
198 changed files with 529 additions and 501 deletions

View file

@ -36,6 +36,8 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleContent;
/**
* Content negotiator.
*
* @author Jeff Williams
*/
public class ContentNegotiator extends JingleNegotiator {
@ -106,7 +108,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
* Get the JingleMediaSession of this Jingle Session
* Get the JingleMediaSession of this Jingle Session.
*
* @return the JingleMediaSession
*/
@ -119,6 +121,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
* Set jingle transport manager.
* @param jingleTransportManager
*/
public void setJingleTransportManager(JingleTransportManager jingleTransportManager) {
@ -126,6 +129,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
* Get jingle transport manager.
* @return the JingleTransportManager
*/
public JingleTransportManager getTransportManager() {
@ -156,7 +160,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
* Obtain the description negotiator for this session
* Obtain the description negotiator for this session.
*
* @return the description negotiator
*/
@ -216,7 +220,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
* Return true if the transport and content negotiators have finished
* Return true if the transport and content negotiators have finished.
*/
public boolean isFullyEstablished() {
boolean result = true;

View file

@ -204,7 +204,7 @@ public class JingleManager implements JingleSessionListener {
private List<JingleMediaManager> jingleMediaManagers;
/**
* Default constructor with a defined XMPPConnection, Transport Resolver and a Media Manager
* Default constructor with a defined XMPPConnection, Transport Resolver and a Media Manager.
* If a fully implemented JingleMediaSession is entered, JingleManager manage Jingle signalling and jmf
*
* @param connection XMPP XMPPConnection to be used
@ -321,7 +321,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
* Get the Media Managers of this Jingle Manager
* Get the Media Managers of this Jingle Manager.
*
* @return the list of JingleMediaManagers
*/
@ -330,7 +330,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
* Set the Media Managers of this Jingle Manager
* Set the Media Managers of this Jingle Manager.
*
* @param jingleMediaManagers JingleMediaManager to be used for open, close, start and stop jmf streamings
*/
@ -473,7 +473,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
* Disconnect all Jingle Sessions
* Disconnect all Jingle Sessions.
*/
public void disconnectAllSessions() {

View file

@ -64,7 +64,7 @@ public abstract class JingleNegotiator {
}
/**
* Default constructor with a Connection
* Default constructor with a Connection.
*
* @param session the jingle session
*/
@ -129,7 +129,7 @@ public abstract class JingleNegotiator {
// Acks management
/**
* Add expected ID
* Add expected ID.
*
* @param id
*/
@ -138,7 +138,7 @@ public abstract class JingleNegotiator {
}
/**
* Check if the passed ID is the expected ID
* Check if the passed ID is the expected ID.
*
* @param id
* @return true if is expected id
@ -152,7 +152,7 @@ public abstract class JingleNegotiator {
}
/**
* Remove and expected ID
* Remove and expected ID.
*
* @param id
*/

View file

@ -17,6 +17,7 @@
package org.jivesoftware.smackx.jingleold;
/**
* Jingle negotiator state.
* @author Jeff Williams
*/
public enum JingleNegotiatorState {

View file

@ -96,7 +96,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
private Map<String, JingleMediaSession> mediaSessionMap;
/**
* Full featured JingleSession constructor
* Full featured JingleSession constructor.
*
* @param conn
* the XMPPConnection which is used
@ -132,7 +132,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* JingleSession constructor (for an outgoing Jingle session)
* JingleSession constructor (for an outgoing Jingle session).
*
* @param conn
* Connection
@ -150,7 +150,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Get the session initiator
* Get the session initiator.
*
* @return the initiator
*/
@ -163,7 +163,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Set the session initiator
* Set the session initiator.
*
* @param initiator
* the initiator to set
@ -173,7 +173,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Get the Media Manager of this Jingle Session
* Get the Media Manager of this Jingle Session.
*
* @return the JingleMediaManagers
*/
@ -182,7 +182,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Set the Media Manager of this Jingle Session
* Set the Media Manager of this Jingle Session.
*
* @param jingleMediaManagers
*/
@ -191,7 +191,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Get the session responder
* Get the session responder.
*
* @return the responder
*/
@ -210,7 +210,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Get the session ID
* Get the session ID.
*
* @return the sid
*/
@ -251,7 +251,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Return true if all of the media managers have finished
* Return true if all of the media managers have finished.
*/
public boolean isFullyEstablished() {
boolean result = true;
@ -740,7 +740,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
// Listeners
/**
* Add a listener for jmf negotiation events
* Add a listener for jmf negotiation events.
*
* @param li
* The listener
@ -755,7 +755,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Remove a listener for jmf negotiation events
* Remove a listener for jmf negotiation events.
*
* @param li
* The listener
@ -769,7 +769,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Add a listener for transport negotiation events
* Add a listener for transport negotiation events.
*
* @param li
* The listener
@ -783,7 +783,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Remove a listener for transport negotiation events
* Remove a listener for transport negotiation events.
*
* @param li
* The listener

View file

@ -24,6 +24,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleError;
/**
* Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/

View file

@ -23,6 +23,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleError;
/**
* Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/

View file

@ -23,6 +23,7 @@ import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smackx.jingleold.packet.Jingle;
/**
* Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/

View file

@ -35,6 +35,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleError;
import org.jivesoftware.smackx.jingleold.packet.JingleTransport;
/**
* Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/

View file

@ -35,7 +35,7 @@ public interface JingleMediaListener extends JingleListener {
public void mediaEstablished(PayloadType pt) throws NotConnectedException, InterruptedException;
/**
* Notification that a payload type must be cancelled
* Notification that a payload type must be cancelled.
*
* @param cand The payload type that must be closed
*/

View file

@ -51,14 +51,14 @@ public abstract class JingleMediaManager {
}
/**
* Return all supported Payloads for this Manager
* Return all supported Payloads for this Manager.
*
* @return The Payload List
*/
public abstract List<PayloadType> getPayloads();
/**
* Returns the Preferred PayloadType of the Media Manager
* Returns the Preferred PayloadType of the Media Manager.
*
* @return The PayloadType
*/
@ -67,7 +67,7 @@ public abstract class JingleMediaManager {
}
/**
* Create a Media Session Implementation
* Create a Media Session Implementation.
*
* @param payloadType
* @param remote

View file

@ -67,7 +67,7 @@ public abstract class JingleMediaSession {
}
/**
* Returns the PayloadType of the Media Session
* Returns the PayloadType of the Media Session.
*
* @return the PayloadType
*/
@ -76,7 +76,7 @@ public abstract class JingleMediaSession {
}
/**
* Returns the Media Session local Candidate
* Returns the Media Session local Candidate.
*
* @return the TransportCandidate
*/
@ -85,7 +85,7 @@ public abstract class JingleMediaSession {
}
/**
* Returns the Media Session remote Candidate
* Returns the Media Session remote Candidate.
*
* @return the TransportCandidate
*/
@ -94,7 +94,7 @@ public abstract class JingleMediaSession {
}
/**
* Return the media locator or null if not defined
* Return the media locator or null if not defined.
*
* @return media locator
*/
@ -103,7 +103,7 @@ public abstract class JingleMediaSession {
}
/**
* Set the media locator
* Set the media locator.
*
* @param mediaLocator media locator or null to use default
*/
@ -112,7 +112,7 @@ public abstract class JingleMediaSession {
}
/**
* Adds a Media Received Listener
* Adds a Media Received Listener.
*
* @param mediaReceivedListener
*/
@ -121,7 +121,7 @@ public abstract class JingleMediaSession {
}
/**
* Removes a Media Received Listener
* Removes a Media Received Listener.
*
* @param mediaReceivedListener
*/
@ -130,7 +130,7 @@ public abstract class JingleMediaSession {
}
/**
* Removes all Media Received Listeners
* Removes all Media Received Listeners.
*/
public void removeAllMediaReceivedListener() {
mediaReceivedListeners.clear();
@ -142,12 +142,12 @@ public abstract class JingleMediaSession {
public abstract void initialize();
/**
* Starts a RTP / UDP / TCP Transmission to the remote Candidate
* Starts a RTP / UDP / TCP Transmission to the remote Candidate.
*/
public abstract void startTrasmit();
/**
* Starts a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate
* Starts a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate.
*/
public abstract void startReceive();
@ -160,12 +160,12 @@ public abstract class JingleMediaSession {
public abstract void setTrasmit(boolean active);
/**
* Stops a RTP / UDP / TCP Transmission to the remote Candidate
* Stops a RTP / UDP / TCP Transmission to the remote Candidate.
*/
public abstract void stopTrasmit();
/**
* Stops a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate
* Stops a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate.
*/
public abstract void stopReceive();
@ -179,7 +179,7 @@ public abstract class JingleMediaSession {
}
/**
* Gets associated JingleSession
* Gets associated JingleSession.
* @return associated JingleSession
*/
public JingleSession getJingleSession() {

View file

@ -515,7 +515,7 @@ public class MediaNegotiator extends JingleNegotiator {
}
/**
* Terminate the jmf negotiator
* Terminate the jmf negotiator.
*/
public void close() {
super.close();

View file

@ -17,7 +17,7 @@
package org.jivesoftware.smackx.jingleold.media;
/**
* Listener for new Incoming Media Streams
* Listener for new Incoming Media Streams.
*/
public interface MediaReceivedListener {

View file

@ -36,7 +36,7 @@ public class PayloadType {
private int channels;
/**
* Constructor with Id, name and number of channels
* Constructor with Id, name and number of channels.
*
* @param id The identifier
* @param name A name
@ -57,7 +57,7 @@ public class PayloadType {
}
/**
* Constructor with Id and name
* Constructor with Id and name.
*
* @param id The identification
* @param name A name
@ -67,7 +67,7 @@ public class PayloadType {
}
/**
* Copy constructor
* Copy constructor.
*
* @param pt The other payload type.
*/
@ -130,7 +130,7 @@ public class PayloadType {
}
/**
* Return true if the Payload type is not valid
* Return true if the Payload type is not valid.
*
* @return true if the payload type is invalid
*/
@ -247,7 +247,7 @@ public class PayloadType {
private int clockRate;
/**
* Constructor with all the attributes of an Audio payload type
* Constructor with all the attributes of an Audio payload type.
*
* @param id The identifier
* @param name The name assigned to this payload type
@ -260,7 +260,7 @@ public class PayloadType {
}
/**
* Constructor with all the attributes of an Audio payload type
* Constructor with all the attributes of an Audio payload type.
*
* @param id The identifier
* @param name The name assigned to this payload type
@ -280,7 +280,7 @@ public class PayloadType {
}
/**
* Constructor with Id and name
* Constructor with Id and name.
*
* @param id the Id for the payload type
* @param name the name of the payload type
@ -291,7 +291,7 @@ public class PayloadType {
}
/**
* Copy constructor
* Copy constructor.
*
* @param pt the other payload type
*/
@ -301,7 +301,7 @@ public class PayloadType {
}
/**
* Copy constructor
* Copy constructor.
*
* @param pt the other payload type
*/
@ -311,7 +311,7 @@ public class PayloadType {
}
/**
* Get the sampling clockRate for a payload type
* Get the sampling clockRate for a payload type.
*
* @return The sampling clockRate
*/

View file

@ -45,7 +45,7 @@ public class AudioMediaSession extends JingleMediaSession {
private AudioChannel audioChannel;
/**
* Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates
* Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
@ -59,7 +59,7 @@ public class AudioMediaSession extends JingleMediaSession {
}
/**
* Initialize the Audio Channel to make it able to send and receive audio
* Initialize the Audio Channel to make it able to send and receive audio.
*/
public void initialize() {

View file

@ -40,7 +40,7 @@ import javax.media.rtp.event.StreamMappedEvent;
import org.jivesoftware.smackx.jingleold.media.JingleMediaSession;
/**
* This class implements receive methods and listeners to be used in AudioChannel
* This class implements receive methods and listeners to be used in AudioChannel.
*
* @author Thiago Camargo
*/
@ -70,7 +70,7 @@ public class AudioReceiver implements ReceiveStreamListener, SessionListener,
}
/**
* ReceiveStreamListener
* ReceiveStreamListener.
*/
public synchronized void update(ReceiveStreamEvent evt) {

View file

@ -49,7 +49,7 @@ public class JmfMediaManager extends JingleMediaManager {
private String mediaLocator = null;
/**
* Creates a Media Manager instance
* Creates a Media Manager instance.
*/
public JmfMediaManager(JingleTransportManager transportManager) {
super(transportManager);
@ -57,7 +57,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
* Creates a Media Manager instance
* Creates a Media Manager instance.
*
* @param mediaLocator Media Locator
*/
@ -68,7 +68,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
* Returns a new jingleMediaSession
* Returns a new jingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
@ -89,7 +89,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
* Return all supported Payloads for this Manager
* Return all supported Payloads for this Manager.
*
* @return The Payload List
*/
@ -98,7 +98,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
* Return the media locator or null if not defined
* Return the media locator or null if not defined.
*
* @return media locator
*/
@ -107,7 +107,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
* Set the media locator
* Set the media locator.
*
* @param mediaLocator media locator or null to use default
*/

View file

@ -57,7 +57,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
private MediaSession mediaSession;
/**
* Create a Session using Speex Codec
* Create a Session using Speex Codec.
*
* @param localhost localHost
* @param localPort localPort
@ -96,7 +96,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
/**
* Creates a org.jivesoftware.jingleaudio.jspeex.AudioMediaSession with defined payload type, remote and local candidates
* Creates a org.jivesoftware.jingleaudio.jspeex.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
@ -110,7 +110,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
}
/**
* Initialize the Audio Channel to make it able to send and receive audio
* Initialize the Audio Channel to make it able to send and receive audio.
*/
public void initialize() {

View file

@ -53,7 +53,7 @@ public class SpeexMediaManager extends JingleMediaManager {
}
/**
* Returns a new jingleMediaSession
* Returns a new jingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
@ -72,7 +72,7 @@ public class SpeexMediaManager extends JingleMediaManager {
}
/**
* Return all supported Payloads for this Manager
* Return all supported Payloads for this Manager.
*
* @return The Payload List
*/

View file

@ -71,7 +71,7 @@ public class MultiMediaManager extends JingleMediaManager {
}
/**
* Returns a new JingleMediaSession
* Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate

View file

@ -66,7 +66,7 @@ public class ScreenShareMediaManager extends JingleMediaManager {
}
/**
* Returns a new JingleMediaSession
* Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate

View file

@ -58,7 +58,7 @@ public class ScreenShareSession extends JingleMediaSession {
private int height = 600;
/**
* Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates
* Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.

View file

@ -25,7 +25,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Implements a default PNG Encoder
* Implements a default PNG Encoder.
*/
public class DefaultEncoder implements ImageEncoder{
private static final Logger LOGGER = Logger.getLogger(DefaultEncoder.class.getName());

View file

@ -21,7 +21,7 @@ import java.io.ByteArrayInputStream;
import java.io.IOException;
/**
* Image Decoder Interface use this interface if you want to change the default decoder
* Image Decoder Interface use this interface if you want to change the default decoder.
*
* @author Thiago Rocha Camargo
*/

View file

@ -20,7 +20,7 @@ import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
/**
* Image Encoder Interface use this interface if you want to change the default encoder
* Image Encoder Interface use this interface if you want to change the default encoder.
*
* @author Thiago Rocha Camargo
*/

View file

@ -183,7 +183,7 @@ public class ImageTransmitter implements Runnable {
}
/**
* Set Transmit Enabled/Disabled
* Set Transmit Enabled/Disabled.
*
* @param transmit boolean Enabled/Disabled
*/
@ -192,7 +192,7 @@ public class ImageTransmitter implements Runnable {
}
/**
* Get the encoder used to encode Images Tiles
* Get the encoder used to encode Images Tiles.
*
* @return encoder
*/
@ -201,7 +201,7 @@ public class ImageTransmitter implements Runnable {
}
/**
* Set the encoder used to encode Image Tiles
* Set the encoder used to encode Image Tiles.
*
* @param encoder encoder
*/
@ -210,7 +210,7 @@ public class ImageTransmitter implements Runnable {
}
/**
* Stops Transmitter
* Stops Transmitter.
*/
public void stop() {
this.transmit = false;

View file

@ -51,7 +51,7 @@ public class PixelUtils {
private static Random randomGenerator = new Random();
/**
* Clamp a value to the range 0..255
* Clamp a value to the range 0..255.
*/
public static int clamp(int c) {
if (c < 0)

View file

@ -68,7 +68,7 @@ public class QuantizeFilter extends WholeImageFilter {
}
/**
* Return the dithering setting
* Return the dithering setting.
* @return the current setting
*/
public boolean getDither() {
@ -84,7 +84,7 @@ public class QuantizeFilter extends WholeImageFilter {
}
/**
* Return the serpentine setting
* Return the serpentine setting.
* @return the current setting
*/
public boolean getSerpentine() {

View file

@ -58,7 +58,7 @@ public class TestMediaManager extends JingleMediaManager {
}
/**
* Returns a new JingleMediaSession
* Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate

View file

@ -29,7 +29,7 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
public class TestMediaSession extends JingleMediaSession {
/**
* Creates a TestMediaSession with defined payload type, remote and local candidates
* Creates a TestMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.

View file

@ -28,7 +28,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A very Simple HTTP Server
* A very Simple HTTP Server.
*/
public class HttpServer {

View file

@ -86,7 +86,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the ID
* Get the ID.
*
* @return the id
*/
@ -95,7 +95,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the ID
* Set the ID.
*
* @param id the id to set
*/
@ -104,7 +104,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the protocol used for the transmission
* Get the protocol used for the transmission.
*
* @return the protocol used for transmission
*/
@ -113,7 +113,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the protocol for the transmission
* Set the protocol for the transmission.
*
* @param proto the protocol to use
*/
@ -122,7 +122,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the network interface used for this connection
* Get the network interface used for this connection.
*
* @return the interface number
*/
@ -131,7 +131,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the interface for this connection
* Set the interface for this connection.
*
* @param network the interface number
*/
@ -140,7 +140,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the username for this transportElement in ICE
* Get the username for this transportElement in ICE.
*
* @return a username string
*/
@ -149,7 +149,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the channel
* Get the channel.
*
* @return the channel associated
*/
@ -158,7 +158,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the channel for this transportElement
* Set the channel for this transportElement.
*
* @param channel the new channel
*/
@ -167,7 +167,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the username for this transportElement in ICE
* Set the username for this transportElement in ICE.
*
* @param username the username used in ICE
*/
@ -176,7 +176,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the preference number for this transportElement
* Get the preference number for this transportElement.
*
* @return the preference for this transportElement
*/
@ -185,7 +185,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the preference order for this transportElement
* Set the preference order for this transportElement.
*
* @param preference a number identifying the preference (as defined in
* ICE)
@ -195,7 +195,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Get the Candidate Type
* Get the Candidate Type.
*
* @return candidate Type
*/
@ -204,7 +204,7 @@ public class ICECandidate extends TransportCandidate implements Comparable<ICECa
}
/**
* Set the Candidate Type
* Set the Candidate Type.
*
* @param type candidate type.
*/

View file

@ -48,7 +48,7 @@ public abstract class JingleTransportManager {
}
/**
* Get a new Transport Resolver to be used in a Jingle Session
* Get a new Transport Resolver to be used in a Jingle Session.
*
* @return the TransportResolver to be used
* @throws InterruptedException

View file

@ -89,7 +89,7 @@ public class RTPBridge extends IQ {
}
/**
* Creates a RTPBridge Instance with defined Session ID
* Creates a RTPBridge Instance with defined Session ID.
*
* @param sid
*/
@ -99,7 +99,7 @@ public class RTPBridge extends IQ {
}
/**
* Creates a RTPBridge Instance with defined Session ID
* Creates a RTPBridge Instance with defined Session ID.
*
* @param action
*/
@ -109,7 +109,7 @@ public class RTPBridge extends IQ {
}
/**
* Creates a RTPBridge Instance with defined Session ID
* Creates a RTPBridge Instance with defined Session ID.
*
* @param sid
* @param bridgeAction
@ -121,14 +121,14 @@ public class RTPBridge extends IQ {
}
/**
* Creates a RTPBridge Stanza(/Packet) without Session ID
* Creates a RTPBridge Stanza(/Packet) without Session ID.
*/
public RTPBridge() {
super(ELEMENT_NAME, NAMESPACE);
}
/**
* Get the attributes string
* Get the attributes string.
*/
public String getAttributes() {
StringBuilder str = new StringBuilder();
@ -155,7 +155,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the Session ID of the Stanza(/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
*/
@ -164,7 +164,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID)
* Set the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID).
*
* @param sid
*/
@ -173,7 +173,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the Host A IP Address
* Get the Host A IP Address.
*
* @return the Host A IP Address
*/
@ -182,7 +182,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the Host A IP Address
* Set the Host A IP Address.
*
* @param hostA
*/
@ -191,7 +191,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the Host B IP Address
* Get the Host B IP Address.
*
* @return the Host B IP Address
*/
@ -200,7 +200,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the Host B IP Address
* Set the Host B IP Address.
*
* @param hostB
*/
@ -209,7 +209,7 @@ public class RTPBridge extends IQ {
}
/**
* Get Side A receive port
* Get Side A receive port.
*
* @return the side A receive prot
*/
@ -218,7 +218,7 @@ public class RTPBridge extends IQ {
}
/**
* Set Side A receive port
* Set Side A receive port.
*
* @param portA
*/
@ -227,7 +227,7 @@ public class RTPBridge extends IQ {
}
/**
* Get Side B receive port
* Get Side B receive port.
*
* @return the side B receive port
*/
@ -236,7 +236,7 @@ public class RTPBridge extends IQ {
}
/**
* Set Side B receive port
* Set Side B receive port.
*
* @param portB
*/
@ -245,7 +245,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the RTP Bridge IP
* Get the RTP Bridge IP.
*
* @return the RTP Bridge IP
*/
@ -254,7 +254,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the RTP Bridge IP
* Set the RTP Bridge IP.
*
* @param ip
*/
@ -263,7 +263,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the RTP Agent Pass
* Get the RTP Agent Pass.
*
* @return the RTP Agent Pass
*/
@ -272,7 +272,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the RTP Agent Pass
* Set the RTP Agent Pass.
*
* @param pass
*/
@ -281,7 +281,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the name of the Candidate
* Get the name of the Candidate.
*
* @return the name of the Candidate
*/
@ -290,7 +290,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the name of the Candidate
* Set the name of the Candidate.
*
* @param name
*/

View file

@ -18,7 +18,7 @@
package org.jivesoftware.smackx.jingleold.nat;
/**
* Listener for ECHO Test Results
* Listener for ECHO Test Results.
*
* @author Thiago Camargo
*/

View file

@ -72,14 +72,14 @@ public class STUN extends SimpleIQ {
}
/**
* Creates a STUN IQ
* Creates a STUN IQ.
*/
public STUN() {
super(ELEMENT_NAME, NAMESPACE);
}
/**
* Get a list of STUN Servers recommended by the Server
* Get a list of STUN Servers recommended by the Server.
*
* @return the list of STUN servers
*/
@ -88,7 +88,7 @@ public class STUN extends SimpleIQ {
}
/**
* Get Public Ip returned from the XMPP server
* Get Public Ip returned from the XMPP server.
*
* @return the public IP
*/
@ -232,7 +232,7 @@ public class STUN extends SimpleIQ {
}
/**
* Provides easy abstract to store STUN Server Addresses and Ports
* Provides easy abstract to store STUN Server Addresses and Ports.
*/
public static class StunServerAddress {
@ -245,7 +245,7 @@ public class STUN extends SimpleIQ {
}
/**
* Get the Host Address
* Get the Host Address.
*
* @return the host address
*/
@ -254,7 +254,7 @@ public class STUN extends SimpleIQ {
}
/**
* Get the Server Port
* Get the Server Port.
*
* @return the server port
*/

View file

@ -92,7 +92,7 @@ public class STUNResolver extends TransportResolver {
}
/**
* Set the STUN server name and port
* Set the STUN server name and port.
*
* @param ip the STUN server name
* @param port the STUN server port

View file

@ -17,7 +17,7 @@
package org.jivesoftware.smackx.jingleold.nat;
/**
* Result of an ECHO Test
* Result of an ECHO Test.
*
* @author Thiago Camargo
*/

View file

@ -104,7 +104,7 @@ public abstract class TransportCandidate {
}
/**
* Get local IP to bind to this candidate
* Get local IP to bind to this candidate.
*
* @return the local IP
*/
@ -113,7 +113,7 @@ public abstract class TransportCandidate {
}
/**
* Set local IP to bind to this candidate
* Set local IP to bind to this candidate.
*
* @param localIp
*/
@ -140,7 +140,7 @@ public abstract class TransportCandidate {
}
/**
* Get the password used by ICE or relayed candidate
* Get the password used by ICE or relayed candidate.
*
* @return a password
*/
@ -149,7 +149,7 @@ public abstract class TransportCandidate {
}
/**
* Set the password used by ICE or relayed candidate
* Set the password used by ICE or relayed candidate.
*
* @param password a password
*/
@ -158,7 +158,7 @@ public abstract class TransportCandidate {
}
/**
* Get the XMPPConnection use to send or receive this candidate
* Get the XMPPConnection use to send or receive this candidate.
*
* @return the connection
*/
@ -167,7 +167,7 @@ public abstract class TransportCandidate {
}
/**
* Set the XMPPConnection use to send or receive this candidate
* Set the XMPPConnection use to send or receive this candidate.
*
* @param connection
*/
@ -176,7 +176,7 @@ public abstract class TransportCandidate {
}
/**
* Get the jingle's sessionId that is using this candidate
* Get the jingle's sessionId that is using this candidate.
*
* @return the session ID
*/
@ -185,7 +185,7 @@ public abstract class TransportCandidate {
}
/**
* Set the jingle's sessionId that is using this candidate
* Set the jingle's sessionId that is using this candidate.
*
* @param sessionId
*/
@ -194,14 +194,14 @@ public abstract class TransportCandidate {
}
/**
* Empty constructor
* Empty constructor.
*/
public TransportCandidate() {
this(null, 0, 0);
}
/**
* Constructor with IP address and port
* Constructor with IP address and port.
*
* @param ip The IP address.
* @param port The port number.
@ -211,7 +211,7 @@ public abstract class TransportCandidate {
}
/**
* Constructor with IP address and port
* Constructor with IP address and port.
*
* @param ip The IP address.
* @param port The port number.
@ -250,7 +250,7 @@ public abstract class TransportCandidate {
}
/**
* Set the port, using 0 for any port
* Set the port, using 0 for any port.
*
* @param port the port
*/
@ -259,7 +259,7 @@ public abstract class TransportCandidate {
}
/**
* Get the generation for a transportElement definition
* Get the generation for a transportElement definition.
*
* @return the generation
*/
@ -277,7 +277,7 @@ public abstract class TransportCandidate {
}
/**
* Get the name used for identifying this transportElement method (optional)
* Get the name used for identifying this transportElement method (optional).
*
* @return a name used for identifying this transportElement (ie,
* "myrtpvoice1")
@ -389,7 +389,7 @@ public abstract class TransportCandidate {
}
/**
* Get the list of listeners
* Get the list of listeners.
*
* @return the list of listeners
*/
@ -411,7 +411,7 @@ public abstract class TransportCandidate {
}
/**
* Fixed transport candidate
* Fixed transport candidate.
*/
public static class Fixed extends TransportCandidate {
@ -420,7 +420,7 @@ public abstract class TransportCandidate {
}
/**
* Constructor with IP address and port
* Constructor with IP address and port.
*
* @param ip The IP address.
* @param port The port number.
@ -430,7 +430,7 @@ public abstract class TransportCandidate {
}
/**
* Constructor with IP address and port
* Constructor with IP address and port.
*
* @param ip The IP address.
* @param port The port number.
@ -442,7 +442,7 @@ public abstract class TransportCandidate {
}
/**
* Type-safe enum for the transportElement protocol
* Type-safe enum for the transportElement protocol.
*/
public static class Protocol {
@ -532,7 +532,7 @@ public abstract class TransportCandidate {
}
/**
* Type-safe enum for the transportElement channel
* Type-safe enum for the transportElement channel.
*/
public static class Channel {

View file

@ -819,7 +819,7 @@ public abstract class TransportNegotiator extends JingleNegotiator {
// Subclasses
/**
* Raw-UDP transport negotiator
* Raw-UDP transport negotiator.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/

View file

@ -88,7 +88,7 @@ public abstract class TransportResolver {
}
/**
* Initialize the Resolver
* Initialize the Resolver.
* @throws InterruptedException
*/
public abstract void initialize() throws XMPPException, SmackException, InterruptedException;
@ -141,7 +141,7 @@ public abstract class TransportResolver {
}
/**
* Chack if the Transport Resolver is initialized
* Chack if the Transport Resolver is initialized.
*
* @return true if initialized
*/
@ -196,7 +196,7 @@ public abstract class TransportResolver {
}
/**
* Get the list of listeners
* Get the list of listeners.
*
* @return the list of listeners
*/
@ -282,7 +282,7 @@ public abstract class TransportResolver {
}
/**
* Get an iterator for the list of candidates
* Get an iterator for the list of candidates.
*
* @return an iterator
*/
@ -329,7 +329,7 @@ public abstract class TransportResolver {
}
/**
* Get the list of candidates
* Get the list of candidates.
*
* @return the list of transport candidates
*/
@ -344,7 +344,7 @@ public abstract class TransportResolver {
}
/**
* Get the n-th candidate
* Get the n-th candidate.
*
* @return a transport candidate
*/

View file

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.jingleold.nat;
import org.jivesoftware.smack.SmackException.NotConnectedException;
/**
* Transport resolver Interface
* Transport resolver Interface .
*/
public abstract interface TransportResolverListener {
/**
@ -32,7 +32,7 @@ public abstract interface TransportResolverListener {
public void init();
/**
* A transport candidate has been added
* A transport candidate has been added.
*
* @param cand The transport candidate.
* @throws NotConnectedException

View file

@ -144,7 +144,7 @@ public class Jingle extends IQ {
}
/**
* The default constructor
* The default constructor.
*/
public Jingle() {
super(NODENAME, NAMESPACE);
@ -196,21 +196,25 @@ public class Jingle extends IQ {
}
/**
* @return the audioInfo
* Jingle content info.
*
* @return the audioInfo.
*/
public JingleContentInfo getContentInfo() {
return contentInfo;
}
/**
* @param contentInfo the audioInfo to set
* Set content info.
*
* @param contentInfo the audioInfo to set.
*/
public void setContentInfo(final JingleContentInfo contentInfo) {
this.contentInfo = contentInfo;
}
/**
* Get an iterator for the contents
* Get an iterator for the contents.
*
* @return the contents
*/
@ -221,7 +225,7 @@ public class Jingle extends IQ {
}
/**
* Get an iterator for the content
* Get an iterator for the content.
*
* @return the contents
*/
@ -245,7 +249,7 @@ public class Jingle extends IQ {
}
/**
* Add a list of JingleContent elements
* Add a list of JingleContent elements.
*
* @param contentList the list of contents to add
*/
@ -258,7 +262,7 @@ public class Jingle extends IQ {
}
/**
* Get the action specified in the packet
* Get the action specified in the packet.
*
* @return the action
*/
@ -267,7 +271,7 @@ public class Jingle extends IQ {
}
/**
* Set the action in the packet
* Set the action in the packet.
*
* @param action the action to set
*/

View file

@ -165,7 +165,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
* Jingle audio description
* Jingle audio description.
*/
public static class Audio extends JingleContentDescription {
@ -176,7 +176,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
* Utility constructor, with a JinglePayloadType
* Utility constructor, with a JinglePayloadType.
*/
public Audio(final JinglePayloadType pt) {
super();
@ -272,7 +272,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
* Audio payload type element
* Audio payload type element.
*/
public static class Audio extends JinglePayloadType {
public Audio(final PayloadType.Audio audio) {

View file

@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smackx.jingleold.media.ContentInfo;
/**
* Jingle content info
* Jingle content info.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -38,7 +38,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
* Constructor with a jmf info
* Constructor with a jmf info.
*
* @param mediaInfoElement MediaInfo element
*/
@ -57,7 +57,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
* Get the element name
* Get the element name.
*/
public String getElementName() {
// Media info is supposed to be just a single-word command...
@ -74,7 +74,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
* Get the publilc namespace
* Get the publilc namespace.
*/
public String getNamespace() {
return namespace;

View file

@ -172,7 +172,7 @@ public abstract class JingleDescription implements ExtensionElement {
}
/**
* Jingle audio description
* Jingle audio description.
*/
public static class Audio extends JingleDescription {
@ -183,7 +183,7 @@ public abstract class JingleDescription implements ExtensionElement {
}
/**
* Utility constructor, with a PayloadType
* Utility constructor, with a PayloadType.
*/
public Audio(final PayloadType pt) {
super();

View file

@ -26,7 +26,7 @@ import java.util.Iterator;
import java.util.List;
/**
* A jingle transport extension
* A jingle transport extension.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -88,7 +88,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
* Get an iterator for the candidates
* Get an iterator for the candidates.
*
* @return an iterator
*/
@ -242,7 +242,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
* Obtain a valid XML representation of a trancport candidate
* Obtain a valid XML representation of a trancport candidate.
*
* @return A string containing the XML dump of the transport candidate.
*/
@ -263,7 +263,7 @@ public class JingleTransport implements ExtensionElement {
// Subclasses
/**
* RTP-ICE profile
* RTP-ICE profile.
*/
public static class Ice extends JingleTransport {
public static final String NAMESPACE = "urn:xmpp:tmp:jingle:transports:ice-udp";
@ -274,7 +274,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
* Add a transport candidate
* Add a transport candidate.
*
* @see org.jivesoftware.smackx.jingleold.packet.JingleTransport#addCandidate(org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportCandidate)
*/
@ -300,7 +300,7 @@ public class JingleTransport implements ExtensionElement {
public static class Candidate extends JingleTransportCandidate {
/**
* Default constructor
* Default constructor.
*/
public Candidate() {
super();
@ -356,7 +356,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
* Add a transport candidate
* Add a transport candidate.
*
* @see org.jivesoftware.smackx.jingleold.packet.JingleTransport#addCandidate(org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportCandidate)
*/
@ -386,7 +386,7 @@ public class JingleTransport implements ExtensionElement {
*/
public static class Candidate extends JingleTransportCandidate {
/**
* Default constructor
* Default constructor.
*/
public Candidate() {
super();

View file

@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* Parser for a Jingle description
* Parser for a Jingle description.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -101,7 +101,7 @@ public abstract class JingleContentDescriptionProvider extends ExtensionElementP
protected abstract JingleContentDescription getInstance();
/**
* Jingle audio
* Jingle audio.
*/
public static class Audio extends JingleContentDescriptionProvider {

View file

@ -23,14 +23,14 @@ import org.jivesoftware.smackx.jingleold.packet.JingleContentInfo;
import org.xmlpull.v1.XmlPullParser;
/**
* Jingle Audio jmf-info provider
* Jingle Audio jmf-info provider.
*
* @author Alvaro Saurin
*/
public class JingleContentInfoProvider {
/**
* JingleDescription.Audio info provider
* JingleDescription.Audio info provider.
*/
public static class Audio extends ExtensionElementProvider<ExtensionElement> {

View file

@ -21,7 +21,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleContent;
import org.xmlpull.v1.XmlPullParser;
/**
* Jingle <content> provider
* Jingle <content> provider.
*
* @author Jeff Williams
*/

View file

@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* Parser for a Jingle description
* Parser for a Jingle description.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -99,7 +99,7 @@ public abstract class JingleDescriptionProvider extends ExtensionElementProvider
protected abstract JingleDescription getInstance();
/**
* Jingle audio
* Jingle audio.
*/
public static class Audio extends JingleDescriptionProvider {

View file

@ -17,8 +17,6 @@
package org.jivesoftware.smackx.jingleold.provider;
import java.io.IOException;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.provider.IQProvider;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -31,7 +29,6 @@ import org.jivesoftware.smackx.jingleold.packet.JingleDescription;
import org.jivesoftware.smackx.jingleold.packet.JingleTransport;
import org.jxmpp.jid.Jid;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* The JingleProvider parses Jingle packets.
@ -42,9 +39,7 @@ public class JingleProvider extends IQProvider<Jingle> {
/**
* Parse a iq/jingle element.
* @throws IOException
* @throws XmlPullParserException
* @throws SmackException
* @throws Exception
*/
@Override
public Jingle parse(XmlPullParser parser, int intialDepth)

View file

@ -28,7 +28,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* Provider for a Jingle transport element
* Provider for a Jingle transport element.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -83,7 +83,7 @@ public abstract class JingleTransportProvider extends ExtensionElementProvider<J
protected abstract JingleTransportCandidate parseCandidate(final XmlPullParser parser);
/**
* RTP-ICE profile
* RTP-ICE profile.
*/
public static class Ice extends JingleTransportProvider {
@ -192,7 +192,7 @@ public abstract class JingleTransportProvider extends ExtensionElementProvider<J
}
/**
* Raw UDP profile
* Raw UDP profile.
*/
public static class RawUdp extends JingleTransportProvider {