diff options
| author | Sebastien Vincent <seb@jitsi.org> | 2010-10-04 09:33:50 +0000 |
|---|---|---|
| committer | Sebastien Vincent <seb@jitsi.org> | 2010-10-04 09:33:50 +0000 |
| commit | 303c3dfbd6a2ef57a2ea7ffacc49dcf7aea62c90 (patch) | |
| tree | 6442696d17ffa6a496b014185aa68cf0904cdc99 | |
| parent | f7078b197ba877dc981592b927886f8d9a7fd143 (diff) | |
| download | jitsi-303c3dfbd6a2ef57a2ea7ffacc49dcf7aea62c90.zip jitsi-303c3dfbd6a2ef57a2ea7ffacc49dcf7aea62c90.tar.gz jitsi-303c3dfbd6a2ef57a2ea7ffacc49dcf7aea62c90.tar.bz2 | |
Fixes warnings and javadocs.
148 files changed, 1153 insertions, 381 deletions
diff --git a/src/net/java/sip/communicator/impl/browserlauncher/BrowserLauncherActivator.java b/src/net/java/sip/communicator/impl/browserlauncher/BrowserLauncherActivator.java index f898e29..3afae0c 100644 --- a/src/net/java/sip/communicator/impl/browserlauncher/BrowserLauncherActivator.java +++ b/src/net/java/sip/communicator/impl/browserlauncher/BrowserLauncherActivator.java @@ -29,6 +29,12 @@ public class BrowserLauncherActivator private static final Logger logger = Logger.getLogger(BrowserLauncherActivator.class); + /** + * Initialize and start the service. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if initializing and starting this service fails + */ public void start(BundleContext bundleContext) throws Exception { @@ -48,6 +54,12 @@ public class BrowserLauncherActivator logger.info("Browser Launcher Service REGISTERED"); } + /** + * Stops this bundle. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bundleContext) throws Exception { diff --git a/src/net/java/sip/communicator/impl/configuration/ConfigurationActivator.java b/src/net/java/sip/communicator/impl/configuration/ConfigurationActivator.java index 27ce711..b19772e 100644 --- a/src/net/java/sip/communicator/impl/configuration/ConfigurationActivator.java +++ b/src/net/java/sip/communicator/impl/configuration/ConfigurationActivator.java @@ -34,7 +34,7 @@ public class ConfigurationActivator /** * Starts the configuration service - * + * * @param bundleContext the <tt>BundleContext</tt> as provided by the OSGi * framework. * @throws Exception if anything goes wrong diff --git a/src/net/java/sip/communicator/impl/credentialsstorage/AESCrypto.java b/src/net/java/sip/communicator/impl/credentialsstorage/AESCrypto.java index 5f1d3fd..5a35f89 100644 --- a/src/net/java/sip/communicator/impl/credentialsstorage/AESCrypto.java +++ b/src/net/java/sip/communicator/impl/credentialsstorage/AESCrypto.java @@ -66,7 +66,7 @@ public class AESCrypto /** * Creates the encryption and decryption objects and the key. - * + * * @param masterPassword used to derive the key. Can be null. */ public AESCrypto(String masterPassword) @@ -117,9 +117,10 @@ public class AESCrypto * * @param masterPassword used to derive the key. Can be null. * @param keyLength Length of the key in bits. - * @throws InvalidKeyException - * @throws NoSuchAlgorithmException - * @throws InvalidKeySpecException + * @throws InvalidKeyException if the key is invalid (bad encoding, + * wrong length, uninitialized, etc). + * @throws NoSuchAlgorithmException if the algorithm chosen does not exist + * @throws InvalidKeySpecException if the key specifications are invalid */ private void initKey(String masterPassword, int keyLength) throws InvalidKeyException, @@ -153,7 +154,7 @@ public class AESCrypto /** * Decrypts the cyphertext using the key. - * + * * @param ciphertext base64 encoded encrypted data * @return decrypted data * @throws CryptoException when the ciphertext cannot be decrypted with the @@ -178,9 +179,9 @@ public class AESCrypto /** * Encrypts the plaintext using the key. - * + * * @param plaintext data to be encrypted - * @return base64 encoded encrypted data + * @return base64 encoded encrypted data * @throws CryptoException on encryption error */ public String encrypt(String plaintext) throws CryptoException diff --git a/src/net/java/sip/communicator/impl/fileaccess/FileAccessActivator.java b/src/net/java/sip/communicator/impl/fileaccess/FileAccessActivator.java index c9ea718..0c59fa0 100644 --- a/src/net/java/sip/communicator/impl/fileaccess/FileAccessActivator.java +++ b/src/net/java/sip/communicator/impl/fileaccess/FileAccessActivator.java @@ -12,23 +12,40 @@ import net.java.sip.communicator.service.fileaccess.*; /** * Invoke "Service Binder" to parse the service XML and register all services. - * + * * @author Alexander Pelov * @author Lubomir Marinov */ public class FileAccessActivator implements BundleActivator { + /** + * The service registration. + */ private ServiceRegistration serviceRegistration; + /** + * Initialize and start file service + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if initializing and starting file service fails + */ public void start(BundleContext bundleContext) + throws Exception { serviceRegistration = bundleContext.registerService(FileAccessService.class.getName(), new FileAccessServiceImpl(), null); } + /** + * Stops this bundle. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bundleContext) + throws Exception { if (serviceRegistration != null) { diff --git a/src/net/java/sip/communicator/impl/fileaccess/FileAccessServiceImpl.java b/src/net/java/sip/communicator/impl/fileaccess/FileAccessServiceImpl.java index c25caab..0615463 100644 --- a/src/net/java/sip/communicator/impl/fileaccess/FileAccessServiceImpl.java +++ b/src/net/java/sip/communicator/impl/fileaccess/FileAccessServiceImpl.java @@ -20,7 +20,7 @@ import net.java.sip.communicator.util.*; * @author Alexander Pelov * @author Lubomir Marinov */ -public class FileAccessServiceImpl implements FileAccessService +public class FileAccessServiceImpl implements FileAccessService { /** @@ -70,6 +70,12 @@ public class FileAccessServiceImpl implements FileAccessService return retVal; } + /** + * Returns the temporary directory. + * + * @return the created temporary directory + * @throws IOException if the temporary directory cannot not be created + */ public File getTemporaryDirectory() throws IOException { File file = getTemporaryFile(); @@ -249,7 +255,7 @@ public class FileAccessServiceImpl implements FileAccessService return scHomeDirName; } - + /** * Returns the location of the directory where SIP Communicator is to store * user specific data such as configuration files, message and call history @@ -322,13 +328,13 @@ public class FileAccessServiceImpl implements FileAccessService homedir = homedir.trim(); if (!homedir.endsWith(File.separator)) - { + { homedir += File.separator; } file = new File(homedir + fileName); if (file.canRead() || file.canWrite()) - { + { return file; } @@ -340,7 +346,7 @@ public class FileAccessServiceImpl implements FileAccessService logger.debug("Creating home directory : " + homedirFile.getAbsolutePath()); if (!homedirFile.mkdirs()) - { + { String message = "Could not create the home directory : " + homedirFile.getAbsolutePath(); @@ -367,8 +373,9 @@ public class FileAccessServiceImpl implements FileAccessService /** * Returns the default download directory. - * + * * @return the default download directory + * @throws IOException if it I/O error occurred */ public File getDefaultDownloadDirectory() throws IOException @@ -379,7 +386,7 @@ public class FileAccessServiceImpl implements FileAccessService // would be the home directory (i.e. the Desktop folder). if (OSUtils.IS_WINDOWS && getMajorOSVersion() <= 5) { - FileSystemView fsv = FileSystemView.getFileSystemView(); + FileSystemView fsv = FileSystemView.getFileSystemView(); downloadDir = fsv.getHomeDirectory(); } @@ -425,9 +432,9 @@ public class FileAccessServiceImpl implements FileAccessService /** * Creates a failsafe transaction which can be used to safely store * informations into a file. - * + * * @param file The file concerned by the transaction, null if file is null. - * + * * @return A new failsafe transaction related to the given file. */ public FailSafeTransaction createFailSafeTransaction(File file) diff --git a/src/net/java/sip/communicator/impl/filehistory/FileHistoryActivator.java b/src/net/java/sip/communicator/impl/filehistory/FileHistoryActivator.java index db0fd9a..0655d68 100644 --- a/src/net/java/sip/communicator/impl/filehistory/FileHistoryActivator.java +++ b/src/net/java/sip/communicator/impl/filehistory/FileHistoryActivator.java @@ -18,16 +18,23 @@ import net.java.sip.communicator.util.*; public class FileHistoryActivator implements BundleActivator { + /** + * The <tt>Logger</tt> instance used by the + * <tt>FileHistoryActivator</tt> class and its instances for logging output. + */ private static Logger logger = Logger.getLogger(FileHistoryActivator.class); + /** + * A <tt>FileHistoryService</tt> service reference. + */ private FileHistoryServiceImpl fileHistoryService = null; /** * Initialize and start file history * * @param bundleContext BundleContext - * @throws Exception + * @throws Exception if initializing and starting file history fails */ public void start(BundleContext bundleContext) throws Exception { @@ -62,6 +69,12 @@ public class FileHistoryActivator } + /** + * Stops this bundle. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bundleContext) throws Exception { if(fileHistoryService != null) diff --git a/src/net/java/sip/communicator/impl/filehistory/FileHistoryServiceImpl.java b/src/net/java/sip/communicator/impl/filehistory/FileHistoryServiceImpl.java index bdfcaa1..05e6812 100644 --- a/src/net/java/sip/communicator/impl/filehistory/FileHistoryServiceImpl.java +++ b/src/net/java/sip/communicator/impl/filehistory/FileHistoryServiceImpl.java @@ -51,10 +51,13 @@ public class FileHistoryServiceImpl */ private BundleContext bundleContext = null; + /** + * The <tt>HistoryService</tt> reference. + */ private HistoryService historyService = null; /** - * Starts the service. Check the current registerd protocol providers + * Starts the service. Check the current registered protocol providers * which supports FileTransfer and adds a listener to them. * * @param bc BundleContext diff --git a/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationActivator.java b/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationActivator.java index e4de5c8..a273354 100644 --- a/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationActivator.java +++ b/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationActivator.java @@ -28,6 +28,11 @@ public class GrowlNotificationActivator */ public static BundleContext bundleContext; + /** + * The <tt>Logger</tt> instance used by the + * <tt>GrowlNotificationActivator</tt> class and its instances for logging + * output. + */ private static final Logger logger = Logger.getLogger(GrowlNotificationActivator.class); @@ -35,7 +40,7 @@ public class GrowlNotificationActivator * A reference to the configuration service. */ private static ConfigurationService configService; - + /** * A reference to the resource management service. */ @@ -45,38 +50,44 @@ public class GrowlNotificationActivator * A reference to the Growl notification service */ private static GrowlNotificationServiceImpl handler; - + /** * Initialize and start Growl Notifications Service * * @param bc BundleContext - * @throws Exception + * @throws Exception if initializing and starting this service fails */ public void start(BundleContext bc) throws Exception { if (logger.isInfoEnabled()) logger.info("Growl Notification ...[Starting]"); bundleContext = bc; - + getConfigurationService(); handler = new GrowlNotificationServiceImpl(); - + if (handler.isGrowlInstalled()) { handler.start(bc); bc.registerService(PopupMessageHandler.class.getName(), handler, null); - } else + } else { if (logger.isInfoEnabled()) logger.info("Growl Notification ...[Aborted]"); return; } - + if (logger.isInfoEnabled()) logger.info("Growl Notification ...[Started]"); } + /** + * Stops this bundle. + * + * @param bContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bContext) throws Exception { handler.stop(bContext); @@ -102,7 +113,7 @@ public class GrowlNotificationActivator return configService; } - + /** * Returns the <tt>ResourceManagementService</tt> obtained from the bundle * context. diff --git a/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationServiceImpl.java b/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationServiceImpl.java index 70244d4..5ce201f 100644 --- a/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationServiceImpl.java +++ b/src/net/java/sip/communicator/impl/growlnotification/GrowlNotificationServiceImpl.java @@ -35,12 +35,15 @@ public class GrowlNotificationServiceImpl Logger.getLogger(GrowlNotificationServiceImpl.class); /** - * A variable that acts as a buffer to temporarily keep all PopupMessages + * A variable that acts as a buffer to temporarily keep all PopupMessages * that were sent to Growl Daemon. */ - private static final HashMap<Long, PopupMessage> shownPopups = + private static final HashMap<Long, PopupMessage> shownPopups = new HashMap<Long, PopupMessage>(10); + /** + * The <tt>Growl</tt> object. + */ private Growl growl = null; /** @@ -54,7 +57,7 @@ public class GrowlNotificationServiceImpl { if (logger.isDebugEnabled()) logger.debug("Starting the Growl Notification implementation."); - + if(Growl.isGrowlRunning()) { String[] dict = { "Default", "Welcome message" }; @@ -63,11 +66,11 @@ public class GrowlNotificationServiceImpl growl = new Growl ("SIP Communicator", "net.sip-communicator", sipIcon, dict, dict); growl.addClickedNotificationsListener(this); - growl.notifyGrowlOf("SIP Communicator", - "http://www.sip-communicator.org/", - "Welcome message", + growl.notifyGrowlOf("SIP Communicator", + "http://www.sip-communicator.org/", + "Welcome message", null, null); - } + } } /** @@ -82,20 +85,20 @@ public class GrowlNotificationServiceImpl growl.doFinalCleanUp(); } } - + /** * Checks if Growl is present on the system - * @return <code>true</code> if Growl is installed and <code>false</code> otherwise + * @return <tt>true</tt> if Growl is installed and <tt>false</tt>otherwise */ public boolean isGrowlInstalled() { return Growl.isGrowlInstalled(); } - + /** * Checks if Growl is running * - * @return <code>true</code> if Growl is running and <code>false</code> otherwise + * @return <tt>true</tt> if Growl is running and <tt>false</tt> otherwise */ public boolean isGrowlRunning() { @@ -116,15 +119,15 @@ public class GrowlNotificationServiceImpl String messageBody = popupMessage.getMessage(); String messageTitle = popupMessage.getMessageTitle(); - + // remove eventual HTML code before showing the pop-up message messageBody = messageBody.replaceAll("</?\\w++[^>]*+>", ""); messageTitle = messageTitle.replaceAll("</?\\w++[^>]*+>", ""); - - growl.notifyGrowlOf(messageTitle, - messageBody, - "Default", - popupMessage.getIcon(), + + growl.notifyGrowlOf(messageTitle, + messageBody, + "Default", + popupMessage.getIcon(), timestamp); } @@ -141,7 +144,7 @@ public class GrowlNotificationServiceImpl shownPopups.remove(context); } if (logger.isTraceEnabled()) - logger.trace("Growl notification timed-out :" + + logger.trace("Growl notification timed-out :" + m.getMessageTitle() + ": " + m.getMessage()); } } @@ -158,14 +161,15 @@ public class GrowlNotificationServiceImpl synchronized(shownPopups) { shownPopups.remove(context); } - - firePopupMessageClicked(new SystrayPopupMessageEvent(this, m.getTag())); + + firePopupMessageClicked(new SystrayPopupMessageEvent(this, + m.getTag())); if (logger.isTraceEnabled()) - logger.trace("Growl message clicked :" + + logger.trace("Growl message clicked :" + m.getMessageTitle() + ": " + m.getMessage()); } } - + /** * Implements <tt>toString</tt> from <tt>PopupMessageHandler</tt>. * @@ -179,8 +183,8 @@ public class GrowlNotificationServiceImpl } /** - * Implements <tt>getPreferenceIndex</tt> from <tt>PopupMessageHandler</tt>. - * This handler is able to show images, detect clicks, match a click to a + * Implements <tt>getPreferenceIndex</tt> from <tt>PopupMessageHandler</tt>. + * This handler is able to show images, detect clicks, match a click to a * message, and use a native popup mechanism, thus the index is 4. * * @return a preference index diff --git a/src/net/java/sip/communicator/impl/history/HistoryActivator.java b/src/net/java/sip/communicator/impl/history/HistoryActivator.java index aefdaa8..b7971bb 100644 --- a/src/net/java/sip/communicator/impl/history/HistoryActivator.java +++ b/src/net/java/sip/communicator/impl/history/HistoryActivator.java @@ -12,15 +12,24 @@ import net.java.sip.communicator.service.history.*; /** * Invoke "Service Binder" to parse the service XML and register all services. - * + * * @author Alexander Pelov * @author Lubomir Marinov */ public class HistoryActivator implements BundleActivator { + /** + * The service registration. + */ private ServiceRegistration serviceRegistration; + /** + * Initialize and start history service + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if initializing and starting history service fails + */ public void start(BundleContext bundleContext) throws Exception { serviceRegistration = @@ -28,7 +37,14 @@ public class HistoryActivator new HistoryServiceImpl(bundleContext), null); } + /** + * Stops this bundle. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bundleContext) + throws Exception { if (serviceRegistration != null) { diff --git a/src/net/java/sip/communicator/impl/keybindings/KeybindingSetImpl.java b/src/net/java/sip/communicator/impl/keybindings/KeybindingSetImpl.java index 070aab3..d6cd0b6 100644 --- a/src/net/java/sip/communicator/impl/keybindings/KeybindingSetImpl.java +++ b/src/net/java/sip/communicator/impl/keybindings/KeybindingSetImpl.java @@ -1,6 +1,6 @@ /* * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client. - * + * * Distributable under LGPL license. See terms of license at gnu.org. */ package net.java.sip.communicator.impl.keybindings; @@ -14,7 +14,7 @@ import net.java.sip.communicator.service.keybindings.KeybindingSet; /** * Default implementation for the wrapper of keybinding sets. - * + * * @author Damian Johnson */ class KeybindingSetImpl @@ -24,11 +24,15 @@ class KeybindingSetImpl private Category category; - // Destination where custom bindings are saved, null if it couldn't be - // secured + /** + * Destination where custom bindings are saved, null if it couldn't be + * secured. + */ private File customFile; - // Flag indicating that the associated service has been stopped + /** + * Flag indicating that the associated service has been stopped. + */ private boolean isInvalidated = false; KeybindingSetImpl(Map<KeyStroke, String> initial, Category category, @@ -41,7 +45,7 @@ class KeybindingSetImpl /** * Provides current keybinding mappings. - * + * * @return mapping of keystrokes to the string representation of the actions * they perform */ @@ -53,7 +57,7 @@ class KeybindingSetImpl /** * Resets the bindings and notifies the observer's listeners if they've * changed. If the bindings can be written then they will be. - * + * * @param newBindings new keybindings to be held */ public void setBindings(Map<KeyStroke, String> newBindings) @@ -68,7 +72,7 @@ class KeybindingSetImpl /** * Provides the portion of the UI to which the bindings belong. - * + * * @return binding category */ public Category getCategory() @@ -78,7 +82,7 @@ class KeybindingSetImpl /** * Provides if the keybindings can be written when changed or not. - * + * * @return true if bindings can be written when changed, false otherwise */ boolean isWritable() @@ -88,7 +92,7 @@ class KeybindingSetImpl /** * Provides the file where custom bindings are to be saved. - * + * * @return custom bindings save destination */ File getCustomFile() diff --git a/src/net/java/sip/communicator/impl/keybindings/KeybindingsActivator.java b/src/net/java/sip/communicator/impl/keybindings/KeybindingsActivator.java index fc9d86f..e78b510 100644 --- a/src/net/java/sip/communicator/impl/keybindings/KeybindingsActivator.java +++ b/src/net/java/sip/communicator/impl/keybindings/KeybindingsActivator.java @@ -13,20 +13,28 @@ import org.osgi.framework.*; /** * Enabling and disabling osgi functionality for keybindings. - * + * * @author Damian Johnson */ public class KeybindingsActivator implements BundleActivator { + /** + * The <tt>Logger</tt> instance used by the + * <tt>KeybindingsActivator</tt> class and its instances for logging + * output. + */ private static final Logger logger = Logger.getLogger(KeybindingsActivator.class); + /** + * The <tt>KeybindingsService</tt> reference. + */ private KeybindingsServiceImpl keybindingsService = null; /** * Called when this bundle is started. - * + * * @param context The execution context of the bundle being started. */ public void start(BundleContext context) @@ -46,7 +54,7 @@ public class KeybindingsActivator /** * Called when this bundle is stopped so the Framework can perform the * bundle-specific activities necessary to stop the bundle. - * + * * @param context The execution context of the bundle being stopped. */ public void stop(BundleContext context) diff --git a/src/net/java/sip/communicator/impl/keybindings/KeybindingsServiceImpl.java b/src/net/java/sip/communicator/impl/keybindings/KeybindingsServiceImpl.java index 14669ea..b09a87a 100644 --- a/src/net/java/sip/communicator/impl/keybindings/KeybindingsServiceImpl.java +++ b/src/net/java/sip/communicator/impl/keybindings/KeybindingsServiceImpl.java @@ -29,26 +29,39 @@ import net.java.sip.communicator.util.*; * </ol> * Custom bindings attempt to be written again whenever they're changed if the * service is running. Each category of keybindings are stored in its own file. - * + * * @author Damian Johnson */ class KeybindingsServiceImpl implements KeybindingsService, Observer { + /** + * The <tt>Logger</tt> instance used by the + * <tt>KeybindingsServiceImpl</tt> class and its instances for logging + * output. + */ private static final Logger logger = Logger.getLogger(KeybindingsServiceImpl.class); - // Name of the relative directory that holds default bindings + /** + * Name of the relative directory that holds default bindings. + */ private static final String DEFAULT_KEYBINDING_DIR = "/resources/config/defaultkeybindings"; - // Name of the directory that holds custom bindings + /** + * Name of the directory that holds custom bindings. + */ private static final String CUSTOM_KEYBINDING_DIR = "keybindings"; - // Flag indicating if service is running + /** + * Flag indicating if service is running. + */ private boolean isRunning = false; - // Loaded keybinding mappings, maps to null if defaults failed to be loaded + /** + * Loaded keybinding mappings, maps to null if defaults failed to be loaded. + */ private final HashMap<KeybindingSet.Category, KeybindingSetImpl> bindings = new HashMap<KeybindingSet.Category, KeybindingSetImpl>(); @@ -57,7 +70,7 @@ class KeybindingsServiceImpl * default bindings then overwriting them with any custom bindings that can * be retrieved. This writes the merged copy back if it differs from the * custom bindings. This is a no-op if the service has already been started. - * + * * @param bc the currently valid OSGI bundle context. */ synchronized void start(BundleContext bc) @@ -226,7 +239,7 @@ class KeybindingsServiceImpl /** * Provides the bindings associated with a given category. This may be null * if the default bindings failed to be loaded. - * + * * @param category segment of the UI for which bindings should be retrieved * @return mappings of keystrokes to the string representation of their * actions @@ -243,7 +256,9 @@ class KeybindingsServiceImpl return this.bindings.get(category); } - // Listens for changes in binding sets so changes can be written + /** + * Listens for changes in binding sets so changes can be written. + */ public void update(Observable obs, Object arg) { if (obs instanceof KeybindingSetImpl) diff --git a/src/net/java/sip/communicator/impl/msghistory/MessageHistoryActivator.java b/src/net/java/sip/communicator/impl/msghistory/MessageHistoryActivator.java index d0f694e..cc652c1 100644 --- a/src/net/java/sip/communicator/impl/msghistory/MessageHistoryActivator.java +++ b/src/net/java/sip/communicator/impl/msghistory/MessageHistoryActivator.java @@ -20,18 +20,30 @@ import org.osgi.framework.*; public class MessageHistoryActivator implements BundleActivator { + /** + * The <tt>Logger</tt> instance used by the + * <tt>MessageHistoryActivator</tt> class and its instances for logging + * output. + */ private static Logger logger = Logger.getLogger(MessageHistoryActivator.class); + /** + * The <tt>MessageHistoryService</tt> reference. + */ private MessageHistoryServiceImpl msgHistoryService = null; + /** + * The <tt>BundleContext</tt> of the service. + */ static BundleContext bundleContext; /** * Initialize and start message history * * @param bc the BundleContext - * @throws Exception + * @throws Exception if initializing and starting message history service + * fails */ public void start(BundleContext bc) throws Exception { @@ -67,6 +79,12 @@ public class MessageHistoryActivator } + /** + * Stops this bundle. + * + * @param bundleContext the <tt>BundleContext</tt> + * @throws Exception if the stop operation goes wrong + */ public void stop(BundleContext bundleContext) throws Exception { if(msgHistoryService != null) diff --git a/src/net/java/sip/communicator/impl/neomedia/AudioConfigurationPanel.java b/src/net/java/sip/communicator/impl/neomedia/AudioConfigurationPanel.java index 4dbbcd0..0fda997 100644 --- a/src/net/java/sip/communicator/impl/neomedia/AudioConfigurationPanel.java +++ b/src/net/java/sip/communicator/impl/neomedia/AudioConfigurationPanel.java @@ -18,6 +18,11 @@ public class AudioConfigurationPanel extends TransparentPanel { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Creates an instance of the <tt>AudioConfigurationPanel</tt>. */ public AudioConfigurationPanel() diff --git a/src/net/java/sip/communicator/impl/neomedia/VideoConfigurationPanel.java b/src/net/java/sip/communicator/impl/neomedia/VideoConfigurationPanel.java index 9124c3a..cfd5c6f 100644 --- a/src/net/java/sip/communicator/impl/neomedia/VideoConfigurationPanel.java +++ b/src/net/java/sip/communicator/impl/neomedia/VideoConfigurationPanel.java @@ -18,6 +18,11 @@ public class VideoConfigurationPanel extends TransparentPanel { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Creates an instance of the <tt>VideoConfigurationPanel</tt>. */ public VideoConfigurationPanel() diff --git a/src/net/java/sip/communicator/impl/neomedia/ZrtpConfigureTableModel.java b/src/net/java/sip/communicator/impl/neomedia/ZrtpConfigureTableModel.java index 52760ba..591f2a0 100644 --- a/src/net/java/sip/communicator/impl/neomedia/ZrtpConfigureTableModel.java +++ b/src/net/java/sip/communicator/impl/neomedia/ZrtpConfigureTableModel.java @@ -18,13 +18,18 @@ import gnu.java.zrtp.*; public class ZrtpConfigureTableModel<T extends Enum<T>> extends AbstractTableModel { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private final ZrtpConfigure active; private final ZrtpConfigure inActive; - + // used to identify the Enum class when calling ZrtpConfigure methods. - private final T algorithm; + private final T algorithm; private final Class<T> clazz; - + boolean onOff[]; public ZrtpConfigureTableModel(T algo, ZrtpConfigure act, @@ -83,7 +88,7 @@ public class ZrtpConfigureTableModel<T extends Enum<T>> } public int getRowCount() - { + { return active.getNumConfiguredAlgos(algorithm) + inActive.getNumConfiguredAlgos(algorithm); } @@ -102,7 +107,7 @@ public class ZrtpConfigureTableModel<T extends Enum<T>> row -= active.getNumConfiguredAlgos(algorithm); return (inActive.getAlgoAt(row, algorithm).name()); } - else + else return (active.getAlgoAt(row, algorithm).name()); default: return null; @@ -141,10 +146,10 @@ public class ZrtpConfigureTableModel<T extends Enum<T>> /** * Move a Configuration entry up or down one position. - * + * * The "move up" is Converted to a "move down" with modified row index * and flags. - * + * * @param row * Which row to move * @param up @@ -223,7 +228,7 @@ public class ZrtpConfigureTableModel<T extends Enum<T>> /** * Sets the ZrtpConfigure data for this algorithm to a predefined set. - * + * * The caller prepared active ZrtpConfigureto contain a standard set of * algorithms. Get the names and construct a string, then call initialize * to setup the inActive ZrtpConfigure data. diff --git a/src/net/java/sip/communicator/impl/neomedia/codec/Constants.java b/src/net/java/sip/communicator/impl/neomedia/codec/Constants.java index 1d34ce2..8ec5c59 100644 --- a/src/net/java/sip/communicator/impl/neomedia/codec/Constants.java +++ b/src/net/java/sip/communicator/impl/neomedia/codec/Constants.java @@ -40,7 +40,14 @@ public class Constants */ public static int ILBC_MODE = 30; + /** + * Default video width. + */ public static final int VIDEO_WIDTH; + + /** + * Default video height. + */ public static final int VIDEO_HEIGHT; static diff --git a/src/net/java/sip/communicator/impl/neomedia/codec/FFmpeg.java b/src/net/java/sip/communicator/impl/neomedia/codec/FFmpeg.java index d6821ec..9a6109d 100644 --- a/src/net/java/sip/communicator/impl/neomedia/codec/FFmpeg.java +++ b/src/net/java/sip/communicator/impl/neomedia/codec/FFmpeg.java @@ -139,6 +139,9 @@ public class FFmpeg */ public static native long avcodec_find_encoder(int id); + /** + * Initializes FFmpeg's avcodec. + */ public static native void avcodec_init(); /** @@ -181,7 +184,7 @@ public class FFmpeg * property is to be set by the user when encoding and is unused for * constant quantizer encoding. It is set by libavcodec when decoding and * its value is <tt>0</tt> or some bitrate if this info is available in the - * stream. + * stream. * * @param avctx the <tt>AVCodecContext</tt> to set the average bit rate of * @param bit_rate the average bit rate to be set to the specified diff --git a/src/net/java/sip/communicator/impl/neomedia/device/AudioMediaDeviceSession.java b/src/net/java/sip/communicator/impl/neomedia/device/AudioMediaDeviceSession.java index e7f236d..906c8d8 100644 --- a/src/net/java/sip/communicator/impl/neomedia/device/AudioMediaDeviceSession.java +++ b/src/net/java/sip/communicator/impl/neomedia/device/AudioMediaDeviceSession.java @@ -124,8 +124,6 @@ public class AudioMediaDeviceSession * * @param processor the processor on which track control we need * to register a level effect with. - * @throws UnsupportedPlugInException if we <tt>tc</tt> does not support - * effects. */ protected void registerLocalUserAudioLevelEffect(Processor processor) { diff --git a/src/net/java/sip/communicator/impl/neomedia/device/ScreenDeviceImpl.java b/src/net/java/sip/communicator/impl/neomedia/device/ScreenDeviceImpl.java index 6b5bd46..e715fd3 100644 --- a/src/net/java/sip/communicator/impl/neomedia/device/ScreenDeviceImpl.java +++ b/src/net/java/sip/communicator/impl/neomedia/device/ScreenDeviceImpl.java @@ -94,5 +94,15 @@ public class ScreenDeviceImpl implements ScreenDevice } return null; } + + /** + * Get the identifier of the screen. + * + * @return ID of the screen + */ + public String getName() + { + return screen.getIDstring(); + } } diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/audio/PortAudioRenderer.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/audio/PortAudioRenderer.java index f53dfa5..35527f5 100644 --- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/audio/PortAudioRenderer.java +++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/audio/PortAudioRenderer.java @@ -33,6 +33,11 @@ public class PortAudioRenderer private static final Logger logger = Logger.getLogger(PortAudioRenderer.class); + /** + * The constant which represents an empty array with + * <tt>Format</tt> element type. Explicitly defined in order to + * reduce unnecessary allocations. + */ private static final Format[] EMPTY_SUPPORTED_INPUT_FORMATS = new Format[0]; @@ -140,6 +145,9 @@ public class PortAudioRenderer */ private boolean streamIsBusy = false; + /** + * Array of supported input formats. + */ private Format[] supportedInputFormats; /** diff --git a/src/net/java/sip/communicator/impl/neomedia/notify/AudioNotifierServiceImpl.java b/src/net/java/sip/communicator/impl/neomedia/notify/AudioNotifierServiceImpl.java index a27c24e..71a5b2e 100644 --- a/src/net/java/sip/communicator/impl/neomedia/notify/AudioNotifierServiceImpl.java +++ b/src/net/java/sip/communicator/impl/neomedia/notify/AudioNotifierServiceImpl.java @@ -23,9 +23,15 @@ public class AudioNotifierServiceImpl implements AudioNotifierService, PropertyChangeListener { + /** + * Map of differents audio clips. + */ private static final Map<String, SCAudioClipImpl> audioClips = new HashMap<String, SCAudioClipImpl>(); + /** + * If the sound is currently disabled. + */ private boolean isMute; /** @@ -48,6 +54,7 @@ public class AudioNotifierServiceImpl * available audio-s. * * @param uri the path where the audio file could be found + * @return a newly created <tt>SCAudioClip</tt> from <tt>uri</tt> */ public SCAudioClipImpl createAudio(String uri) { @@ -77,7 +84,7 @@ public class AudioNotifierServiceImpl return null; } } - + try { if(getDeviceConfiguration().getAudioSystem().equals( @@ -90,7 +97,7 @@ public class AudioNotifierServiceImpl { audioClip = new PortAudioClipImpl(url, this); } - else + else return null; } catch (Throwable e) diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/ChatRoomConfigurationFormJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/ChatRoomConfigurationFormJabberImpl.java index 92871c2..3c0d36c 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/ChatRoomConfigurationFormJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/ChatRoomConfigurationFormJabberImpl.java @@ -18,25 +18,28 @@ import org.jivesoftware.smackx.muc.*; /** * The Jabber implementation of the <tt>ChatRoomConfigurationForm</tt> * interface. - * + * * @author Yana Stamcheva */ public class ChatRoomConfigurationFormJabberImpl implements ChatRoomConfigurationForm { + /** + * The logger of this class. + */ private Logger logger = Logger.getLogger(ChatRoomConfigurationFormJabberImpl.class); - + /** * The smack chat room configuration form. */ private Form smackConfigForm; - + /** * The form that will be filled out and submitted by user. */ private Form smackSubmitForm; - + /** * The smack multi user chat is the one to which we'll send the form once * filled out. @@ -47,7 +50,7 @@ public class ChatRoomConfigurationFormJabberImpl * Creates an instance of <tt>ChatRoomConfigurationFormJabberImpl</tt> by * specifying the corresponding smack multi user chat and smack * configuration form. - * + * * @param multiUserChat the smack multi user chat, to which we'll send the * configuration form once filled out * @param smackConfigForm the smack configuration form @@ -59,38 +62,38 @@ public class ChatRoomConfigurationFormJabberImpl this.smackConfigForm = smackConfigForm; this.smackSubmitForm = smackConfigForm.createAnswerForm(); } - + /** * Returns an Iterator over a list of * <tt>ChatRoomConfigurationFormFields</tt>. - * + * * @return an Iterator over a list of * <tt>ChatRoomConfigurationFormFields</tt> */ public Iterator<ChatRoomConfigurationFormField> getConfigurationSet() { Vector<ChatRoomConfigurationFormField> configFormFields = new Vector<ChatRoomConfigurationFormField>(); - + Iterator<FormField> smackFormFields = smackConfigForm.getFields(); - + while(smackFormFields.hasNext()) { FormField smackFormField = smackFormFields.next(); - + if(smackFormField == null || smackFormField.getType().equals(FormField.TYPE_HIDDEN)) continue; - + ChatRoomConfigurationFormFieldJabberImpl jabberConfigField = new ChatRoomConfigurationFormFieldJabberImpl( smackFormField, smackSubmitForm); - + configFormFields.add(jabberConfigField); } - + return Collections.unmodifiableList(configFormFields).iterator(); } - + /** * Sends the ready smack configuration form to the multi user chat. */ @@ -99,7 +102,7 @@ public class ChatRoomConfigurationFormJabberImpl { if (logger.isTraceEnabled()) logger.trace("Sends chat room configuration form to the server."); - + try { smackMultiUserChat.sendConfigurationForm(smackSubmitForm); @@ -107,10 +110,10 @@ public class ChatRoomConfigurationFormJabberImpl catch (XMPPException e) { logger.error("Failed to submit the configuration form.", e); - + throw new OperationFailedException( "Failed to submit the configuration form.", OperationFailedException.GENERAL_ERROR); } - } + } } diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetMultiUserChatJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetMultiUserChatJabberImpl.java index 07aef4f9..62d7ca0 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetMultiUserChatJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetMultiUserChatJabberImpl.java @@ -629,7 +629,8 @@ public class OperationSetMultiUserChatJabberImpl * passes to it the chat room for which it will listen for rejection * events. * - * @param chatRoom + * @param chatRoom chat room for which this intance will listen for + * rejection events */ public SmackInvitationRejectionListener(ChatRoom chatRoom) { diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetWhiteboardingJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetWhiteboardingJabberImpl.java index 7882caf..a9256e8 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetWhiteboardingJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/OperationSetWhiteboardingJabberImpl.java @@ -29,6 +29,9 @@ import org.jivesoftware.smack.util.StringUtils; public class OperationSetWhiteboardingJabberImpl implements OperationSetWhiteboarding { + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(OperationSetWhiteboardingJabberImpl.class); @@ -191,7 +194,7 @@ public class OperationSetWhiteboardingJabberImpl */ public WhiteboardSession createWhiteboardSession( String sessionName, - Hashtable sessionProperties) + Hashtable<Object, Object> sessionProperties) throws OperationFailedException, OperationNotSupportedException { diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/OutgoingFileTransferJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/OutgoingFileTransferJabberImpl.java index 6b9529b..bd8b560 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/OutgoingFileTransferJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/OutgoingFileTransferJabberImpl.java @@ -28,6 +28,9 @@ public class OutgoingFileTransferJabberImpl extends AbstractFileTransfer implements PacketInterceptor { + /** + * The logger of this class. + */ private final Logger logger = Logger.getLogger(OutgoingFileTransferJabberImpl.class); diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/UriHandlerJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/UriHandlerJabberImpl.java index 0a22fba..3db9680 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/UriHandlerJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/UriHandlerJabberImpl.java @@ -27,6 +27,9 @@ import net.java.sip.communicator.util.*; public class UriHandlerJabberImpl implements UriHandler, ServiceListener, AccountManagerListener { + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(UriHandlerJabberImpl.class); diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardParticipantJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardParticipantJabberImpl.java index 5321964..c540267 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardParticipantJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardParticipantJabberImpl.java @@ -1,6 +1,6 @@ /* * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client. - * + * * Distributable under LGPL license. See terms of license at gnu.org. */ package net.java.sip.communicator.impl.protocol.jabber; @@ -14,13 +14,15 @@ import net.java.sip.communicator.util.*; /** * The WhiteboardParticipantJabberImpl is a class that represents participants * in a whiteboard. - * + * * @author Julien Waechter */ public class WhiteboardParticipantJabberImpl implements WhiteboardParticipant { - + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(WhiteboardParticipantJabberImpl.class); @@ -60,10 +62,10 @@ public class WhiteboardParticipantJabberImpl /** * Creates a new whiteboard participant with address * <tt>participantAddress</tt>. - * + * * @param participant the JAIN SIP <tt>Address</tt> of the new whiteboard * participant. - * + * * @param owningWhiteboard the whiteboard that contains this whiteboard * participant. */ @@ -82,7 +84,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns the contact identifier representing this contact. - * + * * @return a String contact address */ public String getContactAddress() @@ -93,7 +95,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns an object representing the current state of that participant. * WhiteboardParticipantState may vary among CONNECTING, BUSY, CONNECTED... - * + * * @return a WhiteboardParticipantState instance representin the * participant's state. */ @@ -106,7 +108,7 @@ public class WhiteboardParticipantJabberImpl * Causes this WhiteboardParticipant to enter the specified state. The * method also sets the currentStateStartDate field and fires a * WhiteboardParticipantChangeEvent. - * + * * @param newState the state this whiteboard participant should enter. * @param reason a string that could be set to contain a human readable * explanation for the transition (particularly handy when moving @@ -130,7 +132,7 @@ public class WhiteboardParticipantJabberImpl * Causes this WhiteboardParticipant to enter the specified state. The * method also sets the currentStateStartDate field and fires a * WhiteboardParticipantChangeEvent. - * + * * @param newState the state this whiteboard participant should enter. */ protected void setState(WhiteboardParticipantState newState) @@ -141,7 +143,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns the date (time) when this whiteboard participant acquired its * current status. - * + * * @return a java.util.Date object containing the date when this whiteboard * participant entered its current state. */ @@ -152,7 +154,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns a human readable name representing this participant. - * + * * @return a String containing a name for that participant. */ public String getDisplayName() @@ -163,7 +165,7 @@ public class WhiteboardParticipantJabberImpl /** * Sets a human readable name representing this participant. - * + * * @param displayName the participant's display name */ protected void setDisplayName(String displayName) @@ -183,7 +185,7 @@ public class WhiteboardParticipantJabberImpl /** * The method returns an image representation of the whiteboard participant * (e.g. - * + * * @return byte[] a byte array containing the image or null if no image is * available. */ @@ -195,7 +197,7 @@ public class WhiteboardParticipantJabberImpl /** * Sets the byte array containing an image representation (photo or picture) * of the whiteboard participant. - * + * * @param image a byte array containing the image */ protected void setImage(byte[] image) @@ -211,7 +213,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns a unique identifier representing this participant. - * + * * @return an identifier representing this whiteboard participant. */ public String getParticipantID() @@ -222,7 +224,7 @@ public class WhiteboardParticipantJabberImpl /** * Sets the String that serves as a unique identifier of this * WhiteboardParticipant. - * + * * @param participantID the ID of this whiteboard participant. */ protected void setParticipantID(String participantID) @@ -232,7 +234,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns the chat room that this member is participating in. - * + * * @return the <tt>WhiteboardSession</tt> instance that this member * belongs to. */ @@ -243,7 +245,7 @@ public class WhiteboardParticipantJabberImpl /** * Sets the whiteboard containing this participant. - * + * * @param whiteboard the whiteboard that this whiteboard participant is * partdicipating in. */ @@ -255,7 +257,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns the protocol provider instance that this member has originated * in. - * + * * @return the <tt>ProtocolProviderService</tt> instance that created this * member and its containing cht room */ @@ -268,7 +270,7 @@ public class WhiteboardParticipantJabberImpl * Returns the contact corresponding to this participant or null if no * particular contact has been associated. * <p> - * + * * @return the <tt>Contact</tt> corresponding to this participant or null * if no particular contact has been associated. */ @@ -286,7 +288,7 @@ public class WhiteboardParticipantJabberImpl /** * Allows the user interface to register a listener interested in changes - * + * * @param listener a listener instance to register with this participant. */ public void addWhiteboardParticipantListener( @@ -301,7 +303,7 @@ public class WhiteboardParticipantJabberImpl /** * Unregisters the specified listener. - * + * * @param listener the listener to unregister. */ public void removeWhiteboardParticipantListener( @@ -321,7 +323,7 @@ public class WhiteboardParticipantJabberImpl * whiteboard participant as source, setting it to be of type * <tt>eventType</tt> and the corresponding <tt>oldValue</tt> and * <tt>newValue</tt>, - * + * * @param eventType the type of the event to create and dispatch. * @param oldValue the value of the source property before it changed. * @param newValue the current value of the source property. @@ -338,7 +340,7 @@ public class WhiteboardParticipantJabberImpl * whiteboard participant as source, setting it to be of type * <tt>eventType</tt> and the corresponding <tt>oldValue</tt> and * <tt>newValue</tt>, - * + * * @param eventType the type of the event to create and dispatch. * @param oldValue the value of the source property before it changed. * @param newValue the current value of the source property. @@ -389,7 +391,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns a string representation of the participant in the form of <br> * Display Name <address>;status=WhiteboardParticipantStatus - * + * * @return a string representation of the participant and its state. */ public String toString() @@ -399,7 +401,7 @@ public class WhiteboardParticipantJabberImpl /** * Returns the name of this member - * + * * @return the name of this member in the room (nickname). */ public String getName() @@ -409,7 +411,7 @@ public class WhiteboardParticipantJabberImpl /** * Sets the chat room that this member is participating in. - * + * * @param session */ public void setWhiteboardSession(WhiteboardSessionJabberImpl session) diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardSessionJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardSessionJabberImpl.java index 89eabbc..5137a02 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardSessionJabberImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/WhiteboardSessionJabberImpl.java @@ -30,6 +30,9 @@ public class WhiteboardSessionJabberImpl implements WhiteboardParticipantListener, WhiteboardSession { + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(WhiteboardSessionJabberImpl.class); diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/DefaultPacketExtensionProvider.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/DefaultPacketExtensionProvider.java index ed771ed..e46958e 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/DefaultPacketExtensionProvider.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/DefaultPacketExtensionProvider.java @@ -16,6 +16,7 @@ import org.xmlpull.v1.*; * A provider that parses incoming packet extensions into instances of the * {@link Class} that it has been instantiated for. * + * @param <C> Class that the packets we will be parsing belong to * @author Emil Ivov */ public class DefaultPacketExtensionProvider<C extends AbstractPacketExtension> diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationJabberUtils.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationJabberUtils.java index 5fea97f..7670cfd 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationJabberUtils.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationJabberUtils.java @@ -21,6 +21,9 @@ import net.java.sip.communicator.util.*; */ public class GeolocationJabberUtils { + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(GeolocationJabberUtils.class); diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPacketExtensionProvider.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPacketExtensionProvider.java index d2cdda5..c0ec084 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPacketExtensionProvider.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPacketExtensionProvider.java @@ -21,7 +21,9 @@ import org.xmlpull.v1.XmlPullParser; public class GeolocationPacketExtensionProvider implements PacketExtensionProvider { - + /** + * The logger of this class. + */ private static final Logger logger = Logger.getLogger(GeolocationPacketExtensionProvider.class); diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPresence.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPresence.java index 00f1e8e..b93a63e 100644 --- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPresence.java +++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/geolocation/GeolocationPresence.java @@ -12,7 +12,7 @@ import org.jivesoftware.smack.packet.*; import net.java.sip.communicator.impl.protocol.jabber.*; /** - * This class represents a Jabber presence message includin a Geolocation + * This class represents a Jabber presence message including a Geolocation * Extension. * * @author Guillaume Schreiner @@ -44,11 +44,21 @@ public class GeolocationPresence .getPresenceStatus())); } + /** + * Set the Geolocation extension packet. + * + * @param ext the <tt>GeolocationPacketExtension</tt> to set + */ public void setGeolocationExtention(GeolocationPacketExtension ext) { this.prez.addExtension(ext); } + /** + * Get the Geolocation presence message. + * + * @return the Geolocation presence message. + */ public Presence getGeolocPresence() { return this.prez; diff --git a/src/net/java/sip/communicator/impl/protocol/sip/CallPeerMediaHandlerSipImpl.java b/src/net/java/sip/communicator/impl/protocol/sip/CallPeerMediaHandlerSipImpl.java index 12ee47b..27b05fd 100644 --- a/src/net/java/sip/communicator/impl/protocol/sip/CallPeerMediaHandlerSipImpl.java +++ b/src/net/java/sip/communicator/impl/protocol/sip/CallPeerMediaHandlerSipImpl.java @@ -594,7 +594,6 @@ public class CallPeerMediaHandlerSipImpl return getPeer().getProtocolProvider().getAccountID().getUserID(); } - /** * Generates an SDP <tt>MediaDescription</tt> for <tt>MediaDevice</tt> * taking account the local streaming preference for the corresponding diff --git a/src/net/java/sip/communicator/service/argdelegation/UriHandler.java b/src/net/java/sip/communicator/service/argdelegation/UriHandler.java index d533dc1..65d6f7d 100644 --- a/src/net/java/sip/communicator/service/argdelegation/UriHandler.java +++ b/src/net/java/sip/communicator/service/argdelegation/UriHandler.java @@ -23,6 +23,8 @@ public interface UriHandler /** * Returns the protocol that this handler is responsible for. + * + * @return protocol that this handler is responsible for */ public String getProtocol(); diff --git a/src/net/java/sip/communicator/service/audionotifier/AudioNotifierService.java b/src/net/java/sip/communicator/service/audionotifier/AudioNotifierService.java index fbe69ec..75e0f63 100644 --- a/src/net/java/sip/communicator/service/audionotifier/AudioNotifierService.java +++ b/src/net/java/sip/communicator/service/audionotifier/AudioNotifierService.java @@ -26,11 +26,15 @@ public interface AudioNotifierService /** * Destroys the given audio. + * + * @param audio <tt>SCAudioClip</tt> to destroy */ public void destroyAudio(SCAudioClip audio); /** * Stops/Restores all currently playing sounds. + * + * @param isMute mute or not currently playing sounds */ public void setMute(boolean isMute); diff --git a/src/net/java/sip/communicator/service/audionotifier/SCAudioClip.java b/src/net/java/sip/communicator/service/audionotifier/SCAudioClip.java index c5b51b5..4e5a6c0 100644 --- a/src/net/java/sip/communicator/service/audionotifier/SCAudioClip.java +++ b/src/net/java/sip/communicator/service/audionotifier/SCAudioClip.java @@ -9,22 +9,23 @@ package net.java.sip.communicator.service.audionotifier; /** * SCAudioClip represents an audio clip created using the AudioNotifierService. * Like any audio it could be played, stopped or played in loop. - * + * * @author Yana Stamcheva */ public interface SCAudioClip -{ +{ /** * Plays this audio. */ public void play(); - + /** * Plays this audio in loop. * + * @param silenceInterval interval between loops */ public void playInLoop(int silenceInterval); - + /** * Stops this audio. */ diff --git a/src/net/java/sip/communicator/service/callhistory/event/CallHistoryQueryStatusEvent.java b/src/net/java/sip/communicator/service/callhistory/event/CallHistoryQueryStatusEvent.java index 9dc9601..ebcf216 100644 --- a/src/net/java/sip/communicator/service/callhistory/event/CallHistoryQueryStatusEvent.java +++ b/src/net/java/sip/communicator/service/callhistory/event/CallHistoryQueryStatusEvent.java @@ -21,6 +21,11 @@ public class CallHistoryQueryStatusEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates the type of this event. */ private final int eventType; diff --git a/src/net/java/sip/communicator/service/callhistory/event/CallRecordEvent.java b/src/net/java/sip/communicator/service/callhistory/event/CallRecordEvent.java index 476cc8f..75adeb8 100644 --- a/src/net/java/sip/communicator/service/callhistory/event/CallRecordEvent.java +++ b/src/net/java/sip/communicator/service/callhistory/event/CallRecordEvent.java @@ -20,6 +20,11 @@ public class CallRecordEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The <tt>CallRecord</tt> this event is about. */ private final CallRecord callRecord; diff --git a/src/net/java/sip/communicator/service/callhistory/event/ProgressEvent.java b/src/net/java/sip/communicator/service/callhistory/event/ProgressEvent.java index ed8e58f..a36c6ce 100644 --- a/src/net/java/sip/communicator/service/callhistory/event/ProgressEvent.java +++ b/src/net/java/sip/communicator/service/callhistory/event/ProgressEvent.java @@ -18,6 +18,11 @@ import java.util.*; public class ProgressEvent extends java.util.EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private net.java.sip.communicator.service.history.event.ProgressEvent evt; /** diff --git a/src/net/java/sip/communicator/service/configuration/ConfigPropertyVetoException.java b/src/net/java/sip/communicator/service/configuration/ConfigPropertyVetoException.java index 0652400..abd17bc 100644 --- a/src/net/java/sip/communicator/service/configuration/ConfigPropertyVetoException.java +++ b/src/net/java/sip/communicator/service/configuration/ConfigPropertyVetoException.java @@ -18,8 +18,12 @@ public class ConfigPropertyVetoException extends RuntimeException { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * A PropertyChangeEvent describing the vetoed change. - * @serial */ private final PropertyChangeEvent evt; diff --git a/src/net/java/sip/communicator/service/configuration/ConfigVetoableChangeListener.java b/src/net/java/sip/communicator/service/configuration/ConfigVetoableChangeListener.java index 17a0f96..397b9ee 100644 --- a/src/net/java/sip/communicator/service/configuration/ConfigVetoableChangeListener.java +++ b/src/net/java/sip/communicator/service/configuration/ConfigVetoableChangeListener.java @@ -10,7 +10,7 @@ package net.java.sip.communicator.service.configuration; import java.beans.*; import java.util.EventListener; -/* +/** * This interface uses SC's own ProperteyVetoException. */ public interface ConfigVetoableChangeListener extends EventListener @@ -22,4 +22,4 @@ public interface ConfigVetoableChangeListener extends EventListener * @throws ConfigPropertyVetoException if the change is vetoed by the listener */ void vetoableChange(PropertyChangeEvent e) throws ConfigPropertyVetoException; -} +} diff --git a/src/net/java/sip/communicator/service/contactlist/MetaContactListException.java b/src/net/java/sip/communicator/service/contactlist/MetaContactListException.java index 2572d2a..eb126ae 100644 --- a/src/net/java/sip/communicator/service/contactlist/MetaContactListException.java +++ b/src/net/java/sip/communicator/service/contactlist/MetaContactListException.java @@ -18,6 +18,11 @@ public class MetaContactListException extends RuntimeException { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that an error has occurred while performing a local IO * operation (e.g. while writing in a file). */ @@ -52,13 +57,13 @@ public class MetaContactListException * An error code indicating the nature of this exception. */ private int errCode = CODE_UNKNOWN_ERROR; - + /** * Indicates that the exception was caused by the fact that we tried to * remove a group that cannot be removed or an error occur during remove. */ public static final int CODE_REMOVE_GROUP_ERROR = 6; - + /** * Indicates that the exception was caused by the fact that we tried to * move a contact that cannot be moved or an error occur during move. diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactAvatarUpdateEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactAvatarUpdateEvent.java index 173d436..5151c56 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactAvatarUpdateEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactAvatarUpdateEvent.java @@ -17,6 +17,11 @@ public class MetaContactAvatarUpdateEvent extends MetaContactPropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Creates an instance of this event using the specified arguments. * * @param source the <tt>MetaContact</tt> that this event is about. diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactCapabilitiesEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactCapabilitiesEvent.java index 9ae391c..37e99e5 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactCapabilitiesEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactCapabilitiesEvent.java @@ -13,13 +13,18 @@ import net.java.sip.communicator.service.contactlist.*; /** * Represents an event/<tt>EventObject</tt> fired by * <tt>OperationSetClientCapabilities</tt> in order to notify about changes in - * the list of the <tt>OperationSet</tt> capabilities of a <tt>Contact</tt>. + * the list of the <tt>OperationSet</tt> capabilities of a <tt>Contact</tt>. * * @author Yana Stamcheva */ public class MetaContactCapabilitiesEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + /**ContactList.java * The ID of the <tt>MetaContactCapabilitiesEvent</tt> which notifies about * changes in the list of the <tt>OperationSet</tt> capabilities of a diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactEvent.java index 36fbc08..29c04c7 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactEvent.java @@ -19,6 +19,14 @@ import net.java.sip.communicator.service.contactlist.*; public class MetaContactEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** + * ID of the event. + */ private int eventID = -1; /** @@ -39,6 +47,9 @@ public class MetaContactEvent */ public static final int META_CONTACT_MOVED = 3; + /** + * The parent group of the contact. + */ private MetaContactGroup parentGroup = null; /** diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactGroupEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactGroupEvent.java index db2bf26..88d5bfb 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactGroupEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactGroupEvent.java @@ -18,6 +18,14 @@ import net.java.sip.communicator.service.protocol.*; public class MetaContactGroupEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** + * ID of the event. + */ private int eventID = -1; /** @@ -68,8 +76,15 @@ public class MetaContactGroupEvent */ public static final int META_CONTACT_GROUP_RENAMED = 7; + /** + * the ProtocolProviderService instance where this event + * occurred. + */ private ProtocolProviderService sourceProvider = null; + /** + * The proto group associated with this event. + */ private ContactGroup sourceProtoGroup = null; /** diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactModifiedEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactModifiedEvent.java index aa338e2..1aa525c 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactModifiedEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactModifiedEvent.java @@ -16,6 +16,11 @@ public class MetaContactModifiedEvent extends MetaContactPropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Name of the modification. */ private String modificationName; diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactMovedEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactMovedEvent.java index 8785775..94251aa 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactMovedEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactMovedEvent.java @@ -18,6 +18,10 @@ import net.java.sip.communicator.service.contactlist.*; public class MetaContactMovedEvent extends MetaContactPropertyChangeEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * Createas an instance of this <tt>MetaContactMovedEvent</tt> using the diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactPropertyChangeEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactPropertyChangeEvent.java index 602aba1..1b21694 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactPropertyChangeEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactPropertyChangeEvent.java @@ -20,6 +20,11 @@ public abstract class MetaContactPropertyChangeEvent extends PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that the source meta contact has moved from one location to * another. The old and new values contain the previous and the new * parent group of this meta contact. diff --git a/src/net/java/sip/communicator/service/contactlist/event/MetaContactRenamedEvent.java b/src/net/java/sip/communicator/service/contactlist/event/MetaContactRenamedEvent.java index 7fb1b57..84b27a1 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/MetaContactRenamedEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/MetaContactRenamedEvent.java @@ -16,6 +16,11 @@ public class MetaContactRenamedEvent extends MetaContactPropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Creates an instance of this event using the specified arguments. * @param source the <tt>MetaContact</tt> that this event is about. * @param oldDisplayName the new display name of this meta contact. diff --git a/src/net/java/sip/communicator/service/contactlist/event/ProtoContactEvent.java b/src/net/java/sip/communicator/service/contactlist/event/ProtoContactEvent.java index 5eaf790..5d26723 100644 --- a/src/net/java/sip/communicator/service/contactlist/event/ProtoContactEvent.java +++ b/src/net/java/sip/communicator/service/contactlist/event/ProtoContactEvent.java @@ -21,6 +21,11 @@ public class ProtoContactEvent extends PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that the MetaContactEvent instance was triggered by the * removal of a protocol specific contact from an existing MetaContact. */ diff --git a/src/net/java/sip/communicator/service/credentialsstorage/CryptoException.java b/src/net/java/sip/communicator/service/credentialsstorage/CryptoException.java index f670f5f..019a2f6 100644 --- a/src/net/java/sip/communicator/service/credentialsstorage/CryptoException.java +++ b/src/net/java/sip/communicator/service/credentialsstorage/CryptoException.java @@ -14,6 +14,9 @@ package net.java.sip.communicator.service.credentialsstorage; public class CryptoException extends Exception { + /** + * Serial version UID. + */ private static final long serialVersionUID = -5424208764356198091L; /** @@ -27,7 +30,7 @@ public class CryptoException public static final int DECRYPTION_ERROR = 2; /** - * Set when a decryption fail is caused by the wrong key. + * Set when a decryption fail is caused by the wrong key. */ public static final int WRONG_KEY = 3; @@ -38,7 +41,7 @@ public class CryptoException /** * Constructs the crypto exception. - * + * * @param code the error code * @param cause the original exception that this instance wraps */ diff --git a/src/net/java/sip/communicator/service/fileaccess/FileAccessService.java b/src/net/java/sip/communicator/service/fileaccess/FileAccessService.java index 814f0a8..a00256a 100644 --- a/src/net/java/sip/communicator/service/fileaccess/FileAccessService.java +++ b/src/net/java/sip/communicator/service/fileaccess/FileAccessService.java @@ -110,17 +110,18 @@ public interface FileAccessService { /** * Returns the default download directory depending on the operating system. - * + * * @return the default download directory depending on the operating system + * @throws IOException if it I/O error occurred */ File getDefaultDownloadDirectory() throws IOException; /** * Creates a failsafe transaction which can be used to safely store * informations into a file. - * + * * @param file The file concerned by the transaction, null if file is null. - * + * * @return A new failsafe transaction related to the given file. */ FailSafeTransaction createFailSafeTransaction(File file); diff --git a/src/net/java/sip/communicator/service/gui/event/ChatFocusEvent.java b/src/net/java/sip/communicator/service/gui/event/ChatFocusEvent.java index da476a9..b88e86b 100644 --- a/src/net/java/sip/communicator/service/gui/event/ChatFocusEvent.java +++ b/src/net/java/sip/communicator/service/gui/event/ChatFocusEvent.java @@ -13,12 +13,20 @@ import net.java.sip.communicator.service.gui.*; /** * The <tt>ChatFocusEvent</tt> indicates that a <tt>Chat</tt> has gained or lost * the current focus. - * + * * @author Yana Stamcheva */ public class ChatFocusEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** + * ID of the event. + */ private int eventID = -1; /** @@ -45,19 +53,19 @@ public class ChatFocusEvent super(source); this.eventID = eventID; } - + /** - * Returns an event id specifying what is the type of this event + * Returns an event id specifying what is the type of this event * (FOCUS_GAINED or FOCUS_LOST) * @return one of the REGISTRATION_XXX int fields of this class. */ public int getEventID(){ return eventID; } - + /** * Returns the <tt>Chat</tt> object that corresponds to this event. - * + * * @return the <tt>Chat</tt> object that corresponds to this event */ public Chat getChat() diff --git a/src/net/java/sip/communicator/service/gui/event/ContainerEvent.java b/src/net/java/sip/communicator/service/gui/event/ContainerEvent.java index 5dea232..cf71415 100644 --- a/src/net/java/sip/communicator/service/gui/event/ContainerEvent.java +++ b/src/net/java/sip/communicator/service/gui/event/ContainerEvent.java @@ -9,8 +9,16 @@ package net.java.sip.communicator.service.gui.event; import java.util.*; public class ContainerEvent - extends EventObject{ + extends EventObject +{ + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + /** + * ID of the event. + */ private int eventID = -1; /** diff --git a/src/net/java/sip/communicator/service/gui/internal/GuiServiceActivator.java b/src/net/java/sip/communicator/service/gui/internal/GuiServiceActivator.java index e9d9fe0..008d523 100644 --- a/src/net/java/sip/communicator/service/gui/internal/GuiServiceActivator.java +++ b/src/net/java/sip/communicator/service/gui/internal/GuiServiceActivator.java @@ -13,18 +13,36 @@ import org.osgi.framework.*; public class GuiServiceActivator
implements BundleActivator
{
+ /**
+ * The <tt>BundleContext</tt> of the service.
+ */
private static BundleContext bundleContext;
+ /**
+ * Returns the <tt>BundleContext</tt>.
+ *
+ * @return bundle context
+ */
public static BundleContext getBundleContext()
{
return bundleContext;
}
+ /**
+ * Initialize and start GUI service
+ *
+ * @param bundleContext the <tt>BundleContext</tt>
+ */
public void start(BundleContext bundleContext)
{
GuiServiceActivator.bundleContext = bundleContext;
}
+ /**
+ * Stops this bundle.
+ *
+ * @param bundleContext the <tt>BundleContext</tt>
+ */
public void stop(BundleContext bundleContext)
{
if (GuiServiceActivator.bundleContext == bundleContext)
diff --git a/src/net/java/sip/communicator/service/history/BidirectionalIterator.java b/src/net/java/sip/communicator/service/history/BidirectionalIterator.java index 0394755..1e5a04f 100644 --- a/src/net/java/sip/communicator/service/history/BidirectionalIterator.java +++ b/src/net/java/sip/communicator/service/history/BidirectionalIterator.java @@ -13,24 +13,25 @@ import java.util.*; * the contents of a collection in one way only. This interface defines a * bi-directional iterator, permiting the user to go forwards and backwards in a * collection. - * + * * @author Alexander Pelov */ -public interface BidirectionalIterator<T> extends Iterator<T> { +public interface BidirectionalIterator<T> extends Iterator<T> +{ /** * Returns true if the iteration has elements preceeding the current one. * (In other words, returns true if <tt>prev</tt> would return an element * rather than throwing an exception.) - * + * * @return true if the iterator has preceeding elements. */ boolean hasPrev(); /** * Returns the previous element in the iteration. - * + * * @return the previous element in the iteration. - * + * * @throws NoSuchElementException * iteration has no more elements. */ diff --git a/src/net/java/sip/communicator/service/history/event/HistoryQueryStatusEvent.java b/src/net/java/sip/communicator/service/history/event/HistoryQueryStatusEvent.java index 786db5f..5103532 100644 --- a/src/net/java/sip/communicator/service/history/event/HistoryQueryStatusEvent.java +++ b/src/net/java/sip/communicator/service/history/event/HistoryQueryStatusEvent.java @@ -21,6 +21,11 @@ public class HistoryQueryStatusEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that a query has been completed. */ public static final int QUERY_COMPLETED = 0; diff --git a/src/net/java/sip/communicator/service/history/event/HistoryRecordEvent.java b/src/net/java/sip/communicator/service/history/event/HistoryRecordEvent.java index c32a377..7419916 100644 --- a/src/net/java/sip/communicator/service/history/event/HistoryRecordEvent.java +++ b/src/net/java/sip/communicator/service/history/event/HistoryRecordEvent.java @@ -21,6 +21,11 @@ public class HistoryRecordEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The <tt>HistoryRecord</tt> this event is about. */ private final HistoryRecord historyRecord; diff --git a/src/net/java/sip/communicator/service/history/event/ProgressEvent.java b/src/net/java/sip/communicator/service/history/event/ProgressEvent.java index 037658f..1fb9ef5 100644 --- a/src/net/java/sip/communicator/service/history/event/ProgressEvent.java +++ b/src/net/java/sip/communicator/service/history/event/ProgressEvent.java @@ -24,6 +24,11 @@ public class ProgressEvent extends java.util.EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The start date in the search condition. */ private Date startDate = null; diff --git a/src/net/java/sip/communicator/service/msghistory/event/ProgressEvent.java b/src/net/java/sip/communicator/service/msghistory/event/ProgressEvent.java index 16685d6..eb3e324 100644 --- a/src/net/java/sip/communicator/service/msghistory/event/ProgressEvent.java +++ b/src/net/java/sip/communicator/service/msghistory/event/ProgressEvent.java @@ -18,6 +18,11 @@ import java.util.*; public class ProgressEvent extends java.util.EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private net.java.sip.communicator.service.history.event.ProgressEvent evt; /** diff --git a/src/net/java/sip/communicator/service/neomedia/MediaException.java b/src/net/java/sip/communicator/service/neomedia/MediaException.java index f49e3ed..393a418 100644 --- a/src/net/java/sip/communicator/service/neomedia/MediaException.java +++ b/src/net/java/sip/communicator/service/neomedia/MediaException.java @@ -18,6 +18,11 @@ public class MediaException extends Exception { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The error code value which specifies that the <tt>MediaException</tt> * carrying it does not give more information about its specifics. */ diff --git a/src/net/java/sip/communicator/service/neomedia/MediaService.java b/src/net/java/sip/communicator/service/neomedia/MediaService.java index 8173a88..baa96b2 100644 --- a/src/net/java/sip/communicator/service/neomedia/MediaService.java +++ b/src/net/java/sip/communicator/service/neomedia/MediaService.java @@ -155,10 +155,10 @@ public interface MediaService /** * Creates a new <tt>Recorder</tt> instance that can be used to record a * call which captures and plays back media using a specific - * <tt>MediaDevice</tt>. + * <tt>MediaDevice</tt>. * * @param device the <tt>MediaDevice</tt> which is used for media capture - * and playback by the call to be recorded + * and playback by the call to be recorded * @return a new <tt>Recorder</tt> instance that can be used to record a * call which captures and plays back media using the specified * <tt>MediaDevice</tt> diff --git a/src/net/java/sip/communicator/service/neomedia/MediaUseCase.java b/src/net/java/sip/communicator/service/neomedia/MediaUseCase.java index afcc140..4c9a71a 100644 --- a/src/net/java/sip/communicator/service/neomedia/MediaUseCase.java +++ b/src/net/java/sip/communicator/service/neomedia/MediaUseCase.java @@ -32,7 +32,6 @@ public enum MediaUseCase /** * Name of this <tt>MediaUseCase</tt>. - * */ private final String mediaUseCase; diff --git a/src/net/java/sip/communicator/service/neomedia/device/ScreenDevice.java b/src/net/java/sip/communicator/service/neomedia/device/ScreenDevice.java index f4edef4..6540648 100644 --- a/src/net/java/sip/communicator/service/neomedia/device/ScreenDevice.java +++ b/src/net/java/sip/communicator/service/neomedia/device/ScreenDevice.java @@ -10,14 +10,14 @@ import java.awt.*; /** * The <tt>ScreenDevice</tt> interface represent physical screen display. - * + * * @author Sebastien Vincent */ -public interface ScreenDevice +public interface ScreenDevice { /** * Get current resolution of <tt>ScreenDevice</tt> device. - * + * * @return current resolution of the screen */ public Dimension getSize(); diff --git a/src/net/java/sip/communicator/service/neomedia/event/DTMFToneEvent.java b/src/net/java/sip/communicator/service/neomedia/event/DTMFToneEvent.java index b99d92c..252f16c 100644 --- a/src/net/java/sip/communicator/service/neomedia/event/DTMFToneEvent.java +++ b/src/net/java/sip/communicator/service/neomedia/event/DTMFToneEvent.java @@ -20,6 +20,11 @@ public class DTMFToneEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The tone that this event is pertaining to. */ private final DTMFTone dtmfTone; diff --git a/src/net/java/sip/communicator/service/neomedia/event/RTCPFeedbackEvent.java b/src/net/java/sip/communicator/service/neomedia/event/RTCPFeedbackEvent.java index f2fe199..8e2e6eb 100644 --- a/src/net/java/sip/communicator/service/neomedia/event/RTCPFeedbackEvent.java +++ b/src/net/java/sip/communicator/service/neomedia/event/RTCPFeedbackEvent.java @@ -18,6 +18,11 @@ public class RTCPFeedbackEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Transport layer type (payload type). */ public static final int PT_TL = 205; diff --git a/src/net/java/sip/communicator/service/neomedia/event/SizeChangeVideoEvent.java b/src/net/java/sip/communicator/service/neomedia/event/SizeChangeVideoEvent.java index 0130d6f..9ffe5bf 100644 --- a/src/net/java/sip/communicator/service/neomedia/event/SizeChangeVideoEvent.java +++ b/src/net/java/sip/communicator/service/neomedia/event/SizeChangeVideoEvent.java @@ -18,6 +18,11 @@ public class SizeChangeVideoEvent extends VideoEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The type of a <tt>VideoEvent</tt> which notifies about an update to the * size of a specific visual <tt>Component</tt> depicting video. */ diff --git a/src/net/java/sip/communicator/service/neomedia/event/VideoEvent.java b/src/net/java/sip/communicator/service/neomedia/event/VideoEvent.java index e3690e3..7b75d7e 100644 --- a/src/net/java/sip/communicator/service/neomedia/event/VideoEvent.java +++ b/src/net/java/sip/communicator/service/neomedia/event/VideoEvent.java @@ -19,6 +19,10 @@ import java.util.*; public class VideoEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * The video origin of a <tt>VideoEvent</tt> which is local to the executing diff --git a/src/net/java/sip/communicator/service/netaddr/event/ChangeEvent.java b/src/net/java/sip/communicator/service/netaddr/event/ChangeEvent.java index a31d9fc..0b9675d 100644 --- a/src/net/java/sip/communicator/service/netaddr/event/ChangeEvent.java +++ b/src/net/java/sip/communicator/service/netaddr/event/ChangeEvent.java @@ -15,6 +15,11 @@ public class ChangeEvent extends java.util.EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Event type for interface going up. */ public static final int IFACE_DOWN = 0; @@ -22,7 +27,7 @@ public class ChangeEvent /** * Event type for interface going down. */ - public static final int IFACE_UP = 1; + public static final int IFACE_UP = 1; /** * The type of the current event. diff --git a/src/net/java/sip/communicator/service/notification/event/NotificationActionTypeEvent.java b/src/net/java/sip/communicator/service/notification/event/NotificationActionTypeEvent.java index e6ca109..5f82ead 100644 --- a/src/net/java/sip/communicator/service/notification/event/NotificationActionTypeEvent.java +++ b/src/net/java/sip/communicator/service/notification/event/NotificationActionTypeEvent.java @@ -19,21 +19,26 @@ public class NotificationActionTypeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that a new action is added to an event type. */ public static final String ACTION_ADDED = "ActionAdded"; - + /** * Indicates that an action was removed for a given event type. */ public static final String ACTION_REMOVED = "ActionRemoved"; - + /** * Indicates that an action for a given event type has changed. For example * the action descriptor is changed. */ public static final String ACTION_CHANGED = "ActionChanged"; - + /** * The type of the notification action that is being added. */ @@ -55,15 +60,15 @@ public class NotificationActionTypeEvent * The type of this event. One of the static field constants declared in * this class. */ - private String eventType = null; - + private String eventType = null; + /** * Creates an instance of this event according to the specified type. - * + * * @param source the <tt>NotificationService</tt> that dispatched this event * @param eventType the type of this event. One of the static fields * declared in this class - * @param sourceEventType the event type for which this event occured + * @param sourceEventType the event type for which this event occured * @param sourceActionType the action type corresponding to this event * @param actionHandler the <tt>NotificationActionHandler</tt> that handles * the given action @@ -75,7 +80,7 @@ public class NotificationActionTypeEvent NotificationActionHandler actionHandler) { super(source); - + this.eventType = eventType; this.sourceEventType = sourceEventType; this.sourceActionType = sourceActionType; @@ -84,7 +89,7 @@ public class NotificationActionTypeEvent /** * Returns the action type, for which this event is about. - * + * * @return the action type, for which this event is about. */ public String getSourceActionType() @@ -94,7 +99,7 @@ public class NotificationActionTypeEvent /** * Returns the event type, to which the given action belongs. - * + * * @return the event type, to which the given action belongs */ public String getSourceEventType() @@ -105,7 +110,7 @@ public class NotificationActionTypeEvent /** * Returns the <tt>NotificationActionHandler</tt> that handles the action, * for which this event is about. - * + * * @return the <tt>NotificationActionHandler</tt> that handles the action, * for which this event is about. */ @@ -117,7 +122,7 @@ public class NotificationActionTypeEvent /** * The type of this event. One of ACTION_XXX constants declared in this * class. - * + * * @return the type of this event */ public String getEventType() diff --git a/src/net/java/sip/communicator/service/notification/event/NotificationEventTypeEvent.java b/src/net/java/sip/communicator/service/notification/event/NotificationEventTypeEvent.java index 218961e..c908410 100644 --- a/src/net/java/sip/communicator/service/notification/event/NotificationEventTypeEvent.java +++ b/src/net/java/sip/communicator/service/notification/event/NotificationEventTypeEvent.java @@ -17,17 +17,22 @@ import net.java.sip.communicator.service.notification.*; */ public class NotificationEventTypeEvent extends EventObject -{ +{ + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + /** * Indicates that a new event type is added. */ public static final String EVENT_TYPE_ADDED = "EventTypeAdded"; - + /** * Indicates that an event type was removed. */ public static final String EVENT_TYPE_REMOVED = "EventTypeRemoved"; - + /** * The type of the event that a new action is being added for. */ @@ -37,11 +42,11 @@ public class NotificationEventTypeEvent * The type of this event. One of the static field constants declared in * this class. */ - private String eventType = null; - + private String eventType = null; + /** * Creates an instance of this event according to the specified type. - * + * * @param source the <tt>NotificationService</tt> that dispatched this event * @param eventType the type of this event. One of the static fields * declared in this class @@ -52,14 +57,14 @@ public class NotificationEventTypeEvent String sourceEventType) { super(source); - + this.eventType = eventType; - this.sourceEventType = sourceEventType; + this.sourceEventType = sourceEventType; } /** * Returns the <tt>eventType</tt>, for which this event is about. - * + * * @return the <tt>eventType</tt>, for which this event is about. */ public String getSourceEventType() @@ -70,7 +75,7 @@ public class NotificationEventTypeEvent /** * The type of this event. One of EVENT_TYPE_XXX constants declared in this * class. - * + * * @return the type of this event */ public String getEventType() diff --git a/src/net/java/sip/communicator/service/protocol/AuthorizationRequest.java b/src/net/java/sip/communicator/service/protocol/AuthorizationRequest.java index 43b8a66..f89f85b 100644 --- a/src/net/java/sip/communicator/service/protocol/AuthorizationRequest.java +++ b/src/net/java/sip/communicator/service/protocol/AuthorizationRequest.java @@ -26,6 +26,10 @@ package net.java.sip.communicator.service.protocol; */ public class AuthorizationRequest { + /** + * The reason phrase that should be sent to the user we're demanding for + * authorization. + */ private String reason = ""; /** diff --git a/src/net/java/sip/communicator/service/protocol/OperationFailedException.java b/src/net/java/sip/communicator/service/protocol/OperationFailedException.java index 26ad9b5..6afabf2 100644 --- a/src/net/java/sip/communicator/service/protocol/OperationFailedException.java +++ b/src/net/java/sip/communicator/service/protocol/OperationFailedException.java @@ -22,6 +22,11 @@ public class OperationFailedException extends Exception { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Set when no other error code can describe the exception that occurred. */ public static final int GENERAL_ERROR = 1; diff --git a/src/net/java/sip/communicator/service/protocol/OperationNotSupportedException.java b/src/net/java/sip/communicator/service/protocol/OperationNotSupportedException.java index 827bc9d..6159a59 100644 --- a/src/net/java/sip/communicator/service/protocol/OperationNotSupportedException.java +++ b/src/net/java/sip/communicator/service/protocol/OperationNotSupportedException.java @@ -9,13 +9,16 @@ package net.java.sip.communicator.service.protocol; /** * The OperationNotSupportedException is used by telephony providers as an * indication that a requested operation is not supported or implemented. - * + * * @author Emil Ivov * @author Lubomir Marinov */ public class OperationNotSupportedException extends Exception { + /** + * Serial version UID. + */ private static final long serialVersionUID = 0L; /** @@ -31,7 +34,7 @@ public class OperationNotSupportedException /** * Creates an OperationNotSupportedException instance with the specified * reason phrase. - * + * * @param message * a detailed message explaining any particular details as to why * is not the specified operation supported or null if no diff --git a/src/net/java/sip/communicator/service/protocol/OperationSetInstantMessageFiltering.java b/src/net/java/sip/communicator/service/protocol/OperationSetInstantMessageFiltering.java index b76d15e..202d431 100644 --- a/src/net/java/sip/communicator/service/protocol/OperationSetInstantMessageFiltering.java +++ b/src/net/java/sip/communicator/service/protocol/OperationSetInstantMessageFiltering.java @@ -6,22 +6,21 @@ */ package net.java.sip.communicator.service.protocol; +import net.java.sip.communicator.service.protocol.event.*; + /** - * An operation set that allows plugins to register filters which could - * intercept instant messages and determine whether or not they should be + * An operation set that allows plugins to register filters which could + * intercept instant messages and determine whether or not they should be * dispatched to regular listeners. <tt>EventFilter</tt>-s allow implementating - * features that use standard instant messaging channels to exchange - * + * features that use standard instant messaging channels to exchange + * * @author Keio Kraaner */ - -import net.java.sip.communicator.service.protocol.event.*; - public interface OperationSetInstantMessageFiltering extends OperationSet { /** - * Registeres an <tt>EventFilter</tt> with this operation set so that + * Registeres an <tt>EventFilter</tt> with this operation set so that * events, that do not need processing, are filtered out. * * @param filter the <tt>EventFilter</tt> to register. @@ -29,7 +28,7 @@ public interface OperationSetInstantMessageFiltering public void addEventFilter(EventFilter filter); /** - * Unregisteres an <tt>EventFilter</tt> so that it won't check any more + * Unregisteres an <tt>EventFilter</tt> so that it won't check any more * if an event should be filtered out. * * @param filter the <tt>EventFilter</tt> to unregister. diff --git a/src/net/java/sip/communicator/service/protocol/OperationSetWhiteboarding.java b/src/net/java/sip/communicator/service/protocol/OperationSetWhiteboarding.java index 3eeb103..9fdfb02 100644 --- a/src/net/java/sip/communicator/service/protocol/OperationSetWhiteboarding.java +++ b/src/net/java/sip/communicator/service/protocol/OperationSetWhiteboarding.java @@ -66,7 +66,7 @@ public interface OperationSetWhiteboarding */ public WhiteboardSession createWhiteboardSession( String sessionName, - Hashtable sessionProperties) + Hashtable<Object, Object> sessionProperties) throws OperationFailedException, OperationNotSupportedException; /** diff --git a/src/net/java/sip/communicator/service/protocol/ProtocolProviderFactory.java b/src/net/java/sip/communicator/service/protocol/ProtocolProviderFactory.java index 420a4bb..caa0667 100644 --- a/src/net/java/sip/communicator/service/protocol/ProtocolProviderFactory.java +++ b/src/net/java/sip/communicator/service/protocol/ProtocolProviderFactory.java @@ -327,6 +327,12 @@ public abstract class ProtocolProviderFactory protected final Hashtable<AccountID, ServiceRegistration> registeredAccounts = new Hashtable<AccountID, ServiceRegistration>(); + /** + * Creates a new <tt>ProtocolProviderFactory</tt>. + * + * @param bundleContext the bundle context reference of the service + * @param protocolName the name of the protocol + */ protected ProtocolProviderFactory(BundleContext bundleContext, String protocolName) { @@ -947,6 +953,11 @@ public abstract class ProtocolProviderFactory protocolProviderService.shutdown(); } + /** + * Get the <tt>AccountManager</tt> of the protocol. + * + * @return <tt>AccountManager</tt> of the protocol + */ private AccountManager getAccountManager() { BundleContext bundleContext = getBundleContext(); diff --git a/src/net/java/sip/communicator/service/protocol/UserCredentials.java b/src/net/java/sip/communicator/service/protocol/UserCredentials.java index a74b0db..ed3b2cb 100644 --- a/src/net/java/sip/communicator/service/protocol/UserCredentials.java +++ b/src/net/java/sip/communicator/service/protocol/UserCredentials.java @@ -16,8 +16,19 @@ package net.java.sip.communicator.service.protocol; public class UserCredentials { + /** + * The user name. + */ private String userName = null; + + /** + * The user password. + */ private char[] password = null; + + /** + * If we will store the password persistently. + */ private boolean storePassword = false; /** @@ -73,7 +84,7 @@ public class UserCredentials /** * Specifies whether or not the password associated with this credentials - * object is to be sored persistently (insecure!) or not. + * object is to be stored persistently (insecure!) or not. * <p> * @param storePassword indicates whether passwords contained by this * credentials object are to be stored persistently. @@ -85,10 +96,10 @@ public class UserCredentials /** * Determines whether or not the password associated with this credentials - * object is to be sored persistently (insecure!) or not. + * object is to be stored persistently (insecure!) or not. * <p> * @return true if the underlying protocol provider is to persistently - * (and possiblu insecurely) store the password and false otherwise. + * (and possibly insecurely) store the password and false otherwise. */ public boolean isPasswordPersistent() { diff --git a/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java b/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java index 30c2f9e..16817f4 100644 --- a/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java @@ -12,12 +12,16 @@ import net.java.sip.communicator.service.protocol.*; /**
* Represents a notifying event fired by a specific {@link AccountManager}.
- *
+ *
* @author Lubomir Marinov
*/
public class AccountManagerEvent
extends EventObject
{
+ /**
+ * Serial version UID.
+ */
+ private static final long serialVersionUID = 0L;
/**
* The type of event notifying that the loading of the stored accounts of a
@@ -42,7 +46,7 @@ public class AccountManagerEvent * specific <code>AccountManager</code> in order to notify of an event of a
* specific type occurring while working on a specific
* <code>ProtocolProviderFactory</code>.
- *
+ *
* @param accountManager the <code>AccountManager</code> issuing the
* notification i.e. the source of the event
* @param type the type of the event which is one of
@@ -62,7 +66,7 @@ public class AccountManagerEvent /**
* Gets the <code>ProtocolProviderFactory</code> being worked on at the time
* this event has been fired.
- *
+ *
* @return the <code>ProtocolProviderFactory</code> being worked on at the
* time this event has been fired
*/
@@ -74,7 +78,7 @@ public class AccountManagerEvent /**
* Gets the (detail) type of this event which is one of
* <code>STORED_ACCOUNTS_LOADED</code>.
- *
+ *
* @return the (detail) type of this event which is one of
* <code>STORED_ACCOUNTS_LOADED</code>
*/
diff --git a/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomParticipantPresenceChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomParticipantPresenceChangeEvent.java index eb3795d..759fbc4 100644 --- a/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomParticipantPresenceChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/AdHocChatRoomParticipantPresenceChangeEvent.java @@ -11,7 +11,7 @@ import net.java.sip.communicator.service.protocol.*; /** * Dispatched to notify interested parties that a change in the presence of an - * ad-hoc chat room participant has occurred. Changes may include the + * ad-hoc chat room participant has occurred. Changes may include the * participant being join, left... * * @author Valentin Martinet @@ -65,10 +65,10 @@ public class AdHocChatRoomParticipantPresenceChangeEvent * Creates an <tt>AdHocChatRoomParticipantPresenceChangeEvent</tt> * representing that a change in the presence of an <tt>Contact</tt> * has occurred. Changes may include the participant being join, left, etc. - * - * @param sourceAdHocRoom the <tt>AdHocChatRoom</tt> that produced this + * + * @param sourceAdHocRoom the <tt>AdHocChatRoom</tt> that produced this * event - * @param sourceParticipant the <tt>Contact</tt> that this event is about + * @param sourceParticipant the <tt>Contact</tt> that this event is about * @param eventType the event type; one of the CONTACT_XXX constants * @param reason the reason explaining why this event might have occurred */ @@ -96,7 +96,7 @@ public class AdHocChatRoomParticipantPresenceChangeEvent /** * Returns the participant that this event is about. - * + * * @return the <tt>Contact</tt> that this event is about. */ public Contact getParticipant() @@ -118,7 +118,7 @@ public class AdHocChatRoomParticipantPresenceChangeEvent /** * Gets the indicator which determines whether this event has occurred with * the well-known reason of listing all users in a <code>ChatRoom</code>. - * + * * @return <tt>true</tt> if this event has occurred with the well-known * reason of listing all users in a <code>ChatRoom</code> i.e. * {@link #getReason()} returns a value of {@link #REASON_USER_LIST}; @@ -143,6 +143,8 @@ public class AdHocChatRoomParticipantPresenceChangeEvent /** * Returns a String representation of this event. + * + * @return string representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/AvatarEvent.java b/src/net/java/sip/communicator/service/protocol/event/AvatarEvent.java index 90c8677..0428e37 100644 --- a/src/net/java/sip/communicator/service/protocol/event/AvatarEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/AvatarEvent.java @@ -12,13 +12,18 @@ import net.java.sip.communicator.service.protocol.*; /** * Instances of this class represent a change avatar of a protocol - * + * * @author Damien Roth */ public class AvatarEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The new avatar */ private byte[] newAvatar; @@ -31,7 +36,7 @@ public class AvatarEvent /** * Creates an event instance indicating that the specified protocol * has changed its avatar to <tt>newAvatar</tt>. - * + * * @param sourceOp the operation set that generated this event * @param sourceProvider the protocol provider that the contact belongs to * @param newAvatar the new avatar @@ -77,7 +82,7 @@ public class AvatarEvent /** * Returns a String representation of this AvatarEvent - * + * * @return a <tt>String</tt> representation of this <tt>AvatarEvent</tt>. */ public String toString() diff --git a/src/net/java/sip/communicator/service/protocol/event/CallChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallChangeEvent.java index d43e17c..374afaa 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallChangeEvent.java @@ -19,6 +19,9 @@ import net.java.sip.communicator.service.protocol.*; public class CallChangeEvent extends java.beans.PropertyChangeEvent { + /** + * Serial version UID. + */ private static final long serialVersionUID = 0L; /** diff --git a/src/net/java/sip/communicator/service/protocol/event/CallEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallEvent.java index b6ee61b..83ca589 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallEvent.java @@ -20,6 +20,11 @@ public class CallEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event id value indicating that this event has been triggered as a * result of an outgoing call. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerChangeEvent.java index 29f7c0d..c684107 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerChangeEvent.java @@ -33,6 +33,11 @@ public class CallPeerChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the corresponding event is caused by a * change of the CallPeer's status. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerConferenceEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerConferenceEvent.java index 8c58c7e..ede9bd2 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerConferenceEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerConferenceEvent.java @@ -21,6 +21,10 @@ import net.java.sip.communicator.service.protocol.*; public class CallPeerConferenceEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * The ID of <code>CallPeerConferenceEvent</code> which notifies diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerControlEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerControlEvent.java index 824c6e3..45ab215 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerControlEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerControlEvent.java @@ -26,6 +26,11 @@ import net.java.sip.communicator.service.protocol.*; public class CallPeerControlEvent extends java.util.EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private final String targetURI; /** diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerEvent.java index 68cbeb6..ed3923d 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerEvent.java @@ -18,6 +18,11 @@ public class CallPeerEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The call that the source call peer is associated with. */ private final Call sourceCall; diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityMessageEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityMessageEvent.java index 1afc111..dbd14c8 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityMessageEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityMessageEvent.java @@ -21,6 +21,11 @@ public class CallPeerSecurityMessageEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * This is a information message. Security will be established. */ public static final int INFORMATION = 0; diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOffEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOffEvent.java index b9684af..330389a 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOffEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOffEvent.java @@ -17,6 +17,10 @@ import net.java.sip.communicator.service.protocol.*; public class CallPeerSecurityOffEvent extends CallPeerSecurityStatusEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * The event constructor. diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOnEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOnEvent.java index da22635..c02b24c 100755 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOnEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityOnEvent.java @@ -18,6 +18,11 @@ import net.java.sip.communicator.service.protocol.*; public class CallPeerSecurityOnEvent extends CallPeerSecurityStatusEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private final String securityString; private final boolean isVerified; diff --git a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityStatusEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityStatusEvent.java index 76e07e7..d36297b 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityStatusEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallPeerSecurityStatusEvent.java @@ -17,6 +17,11 @@ public abstract class CallPeerSecurityStatusEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Constant value defining that security is enabled. */ public static final int AUDIO_SESSION = 1; diff --git a/src/net/java/sip/communicator/service/protocol/event/CallReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/CallReceivedEvent.java index 91ba5d7..5317a98 100644 --- a/src/net/java/sip/communicator/service/protocol/event/CallReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/CallReceivedEvent.java @@ -18,6 +18,9 @@ import net.java.sip.communicator.service.protocol.*; public class CallReceivedEvent extends EventObject { + /** + * Serial version UID. + */ private static final long serialVersionUID = 0L; public CallReceivedEvent(Call call) diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationReceivedEvent.java index fae17d1..38ad202 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationReceivedEvent.java @@ -12,7 +12,7 @@ import net.java.sip.communicator.service.protocol.*; /** * <tt>ChatRoomInvitationReceivedEvent</tt>s indicate reception of an * invitation to join a chat room. - * + * * @author Emil Ivov * @author Stephane Remy * @author Yana Stamcheva @@ -21,10 +21,15 @@ public class ChatRoomInvitationReceivedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The invitation corresponding to this event. */ private final ChatRoomInvitation invitation; - + /** * A timestamp indicating the exact date when the event occurred. */ @@ -50,17 +55,17 @@ public class ChatRoomInvitationReceivedEvent this.invitation = invitation; this.timestamp = timestamp; } - + /** * Returns the multi user chat operation set that dispatches this event. - * + * * @return the multi user chat operation set that dispatches this event. */ public OperationSetMultiUserChat getSourceOperationSet() { return (OperationSetMultiUserChat) getSource(); } - + /** * Returns the <tt>ChatRoomInvitation</tt> that this event is for. * @@ -70,7 +75,7 @@ public class ChatRoomInvitationReceivedEvent { return invitation; } - + /** * A timestamp indicating the exact date when the event ocurred. * diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationRejectedEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationRejectedEvent.java index ed953d7..6559e1c 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationRejectedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomInvitationRejectedEvent.java @@ -21,26 +21,31 @@ public class ChatRoomInvitationRejectedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The <tt>ChatRoom</tt> for which the initial invitation was. */ private ChatRoom chatRoom; - + /** * The invitee that rejected the invitation. */ private String invitee; - + /** * The reason why this invitation is rejected or null if there is no reason * specified. */ private String reason; - + /** * The exact date at which this event occured. */ private Date timestamp; - + /** * Creates a <tt>ChatRoomInvitationRejectedEvent</tt> representing the * rejection of an invitation, rejected by the given <tt>invitee</tt>. @@ -60,33 +65,33 @@ public class ChatRoomInvitationRejectedEvent Date timestamp) { super(source); - + this.chatRoom = chatRoom; this.invitee = invitee; this.reason = reason; this.timestamp = timestamp; } - + /** * Returns the multi user chat operation set that dispatches this event. - * + * * @return the multi user chat operation set that dispatches this event */ public OperationSetMultiUserChat getSourceOperationSet() { return (OperationSetMultiUserChat)getSource(); } - + /** * Returns the <tt>ChatRoom</tt> for which the initial invitation was. - * + * * @return the <tt>ChatRoom</tt> for which the initial invitation was */ public ChatRoom getChatRoom() { return chatRoom; } - + /** * Returns the name of the invitee that rejected the invitation. * @@ -96,7 +101,7 @@ public class ChatRoomInvitationRejectedEvent { return invitee; } - + /** * Returns the reason for which the <tt>ChatRoomInvitation</tt> is rejected. * @@ -106,7 +111,7 @@ public class ChatRoomInvitationRejectedEvent { return reason; } - + /** * A timestamp indicating the exact date when the event ocurred. * @return a Date indicating when the event ocurred. diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomLocalUserRoleChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomLocalUserRoleChangeEvent.java index 8acac38..f7ba6c8 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomLocalUserRoleChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomLocalUserRoleChangeEvent.java @@ -13,7 +13,7 @@ import net.java.sip.communicator.service.protocol.*; * Dispatched to notify interested parties that a change in our role in the * source chat room has occurred. Changes may include us being granted admin * permissions, or other permissions. - * + * * @see ChatRoomMemberRole * * @author Emil Ivov @@ -21,35 +21,40 @@ import net.java.sip.communicator.service.protocol.*; */ public class ChatRoomLocalUserRoleChangeEvent extends EventObject -{ +{ + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + /** * The previous role that local participant had. */ private ChatRoomMemberRole previousRole = null; - + /** * The new role that local participant get. */ private ChatRoomMemberRole newRole = null; - + /** * Creates a <tt>ChatRoomLocalUserRoleChangeEvent</tt> representing that * a change in local participant role in the source chat room has * occured. - * + * * @param sourceRoom the <tt>ChatRoom</tt> that produced the event * @param previousRole the previous role that local participant had * @param newRole the new role that local participant get */ public ChatRoomLocalUserRoleChangeEvent(ChatRoom sourceRoom, ChatRoomMemberRole previousRole, - ChatRoomMemberRole newRole) + ChatRoomMemberRole newRole) { super(sourceRoom); this.previousRole = previousRole; this.newRole = newRole; } - + /** * Returns the new role the local participant get. * @@ -59,7 +64,7 @@ public class ChatRoomLocalUserRoleChangeEvent { return newRole; } - + /** * Returns the previous role that local participant had. * @@ -69,7 +74,7 @@ public class ChatRoomLocalUserRoleChangeEvent { return previousRole; } - + /** * Returns the <tt>ChatRoom</tt>, where this event occured. * diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPresenceChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPresenceChangeEvent.java index a4ac041..220b7d0 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPresenceChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPresenceChangeEvent.java @@ -21,6 +21,11 @@ public class ChatRoomMemberPresenceChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that this event was triggered as a result of the participant * joining the source chat room. */ @@ -78,9 +83,9 @@ public class ChatRoomMemberPresenceChangeEvent * Creates a <tt>ChatRoomMemberPresenceChangeEvent</tt> representing that * a change in the presence of a <tt>ChatRoomMember</tt> has occurred. * Changes may include the participant being kicked, join, left, etc. - * + * * @param sourceRoom the <tt>ChatRoom</tt> that produced this event - * @param sourceMember the <tt>ChatRoomMember</tt> that this event is about + * @param sourceMember the <tt>ChatRoomMember</tt> that this event is about * @param eventType the event type; one of the MEMBER_XXX constants * @param reason the reason explaining why this event might have occurred */ @@ -96,11 +101,11 @@ public class ChatRoomMemberPresenceChangeEvent * Creates a <tt>ChatRoomMemberPresenceChangeEvent</tt> representing that * a change in the presence of a <tt>ChatRoomMember</tt> has occurred. * Changes may include the participant being kicked, join, left, etc. - * + * * @param sourceRoom the <tt>ChatRoom</tt> that produced this event * @param sourceMember the <tt>ChatRoomMember</tt> that this event is about * @param actorMember the <tt>ChatRoomMember</tt> that participated as an - * actor in this event + * actor in this event * @param eventType the event type; one of the MEMBER_XXX constants * @param reason the reason explaining why this event might have occurred */ @@ -129,7 +134,7 @@ public class ChatRoomMemberPresenceChangeEvent /** * Returns the chat room member that this event is about. - * + * * @return the <tt>ChatRoomMember</tt> that this event is about. */ public ChatRoomMember getChatRoomMember() @@ -151,7 +156,7 @@ public class ChatRoomMemberPresenceChangeEvent /** * Gets the indicator which determines whether this event has occurred with * the well-known reason of listing all users in a <code>ChatRoom</code>. - * + * * @return <tt>true</tt> if this event has occurred with the well-known * reason of listing all users in a <code>ChatRoom</code> i.e. * {@link #getReason()} returns a value of {@link #REASON_USER_LIST}; @@ -176,6 +181,8 @@ public class ChatRoomMemberPresenceChangeEvent /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPropertyChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPropertyChangeEvent.java index 83f621d..458edb1 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPropertyChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberPropertyChangeEvent.java @@ -10,8 +10,8 @@ import net.java.sip.communicator.service.protocol.*; /** * A <tt>ChatRoomMemberPropertyChangeEvent</tt> is issued whenever a chat room - * member property has changed (such as the nickname for example). Event codes - * defined in this class describe properties whose changes are being announced + * member property has changed (such as the nickname for example). Event codes + * defined in this class describe properties whose changes are being announced * through this event. * * @author Emil Ivov @@ -21,6 +21,11 @@ public class ChatRoomMemberPropertyChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The nick name of the <tt>ChatRoomMember</tt> property. */ public static final String MEMBER_NICKNAME = "MemberNickname"; @@ -31,12 +36,13 @@ public class ChatRoomMemberPropertyChangeEvent private ChatRoom memberChatRoom; /** - * Creates a <tt>ChatRoomMemberPropertyChangeEvent</tt> indicating that a + * Creates a <tt>ChatRoomMemberPropertyChangeEvent</tt> indicating that a * change has occurred for property <tt>propertyName</tt> in the - * <tt>source</tt> chat room member and that its value has changed from + * <tt>source</tt> chat room member and that its value has changed from * <tt>oldValue</tt> to <tt>newValue</tt>. * <p> * @param source the <tt>ChatRoomMember</tt> whose property has changed. + * @param memberChatRoom the <tt>ChatRoom</tt> of the member * @param propertyName the name of the property that has changed. * @param oldValue the value of the property before the change occurred. * @param newValue the value of the property after the change. @@ -77,6 +83,8 @@ public class ChatRoomMemberPropertyChangeEvent /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberRoleChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberRoleChangeEvent.java index fd93f8f..398d641 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberRoleChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMemberRoleChangeEvent.java @@ -14,7 +14,7 @@ import net.java.sip.communicator.service.protocol.*; * Dispatched to notify interested parties that a change in a member role in the * source room has occurred. Changes may include member being granted admin * permissions, or other permissions. - * + * * @see ChatRoomMemberRole * * @author Emil Ivov @@ -24,24 +24,29 @@ public class ChatRoomMemberRoleChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The member that the event relates to. */ private ChatRoomMember sourceMember = null; - + /** * The previous role that this member had. */ private ChatRoomMemberRole previousRole = null; - + /** * The new role that this member get. */ private ChatRoomMemberRole newRole = null; - + /** * Creates a <tt>ChatRoomMemberRoleChangeEvent</tt> representing that * a change in member role in the source chat room has occured. - * + * * @param sourceRoom the <tt>ChatRoom</tt> that produced this event * @param sourceMember the <tt>ChatRoomMember</tt> that this event is about * @param previousRole the previous role that member had @@ -50,14 +55,14 @@ public class ChatRoomMemberRoleChangeEvent public ChatRoomMemberRoleChangeEvent(ChatRoom sourceRoom, ChatRoomMember sourceMember, ChatRoomMemberRole previousRole, - ChatRoomMemberRole newRole) + ChatRoomMemberRole newRole) { super(sourceRoom); this.sourceMember = sourceMember; this.previousRole = previousRole; this.newRole = newRole; } - + /** * Returns the new role given to the member that this event is about. * @@ -67,7 +72,7 @@ public class ChatRoomMemberRoleChangeEvent { return newRole; } - + /** * Returns the previous role the member that this event is about had. * @@ -77,7 +82,7 @@ public class ChatRoomMemberRoleChangeEvent { return previousRole; } - + /** * Returns the chat room that produced this event. * @@ -87,7 +92,7 @@ public class ChatRoomMemberRoleChangeEvent { return (ChatRoom)getSource(); } - + /** * Returns the member that this event is about. * @return the <tt>ChatRoomMember</tt> that this event is about diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveredEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveredEvent.java index 981ae34..a8d1512 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveredEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveredEvent.java @@ -21,6 +21,11 @@ public class ChatRoomMessageDeliveredEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the message being received is a standard * conversation message sent by another member of the chat room to all * current participants. diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveryFailedEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveryFailedEvent.java index f3243fe..2a3163c 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveryFailedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageDeliveryFailedEvent.java @@ -21,6 +21,11 @@ public class ChatRoomMessageDeliveryFailedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The chat room member that this message has been sent to. */ private ChatRoomMember to = null; @@ -114,7 +119,7 @@ public class ChatRoomMessageDeliveryFailedEvent { return to; } - + /** * Returns the received message. * @return the <tt>Message</tt> that triggered this event. diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageReceivedEvent.java index 0fdd67f..1fcc5d0 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomMessageReceivedEvent.java @@ -20,6 +20,11 @@ public class ChatRoomMessageReceivedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the message being received is a standard * conversation message sent by another member of the chatroom to all * current participants. diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeEvent.java index 043c1d6..cf3f052 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeEvent.java @@ -20,15 +20,20 @@ public class ChatRoomPropertyChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The name of the <tt>ChatRoom</tt> subject property. */ public static final String CHAT_ROOM_SUBJECT = "ChatRoomSubject"; - + /** * The name of the <tt>ChatRoom</tt> subject property. */ public static final String CHAT_ROOM_USER_NICKNAME = "ChatRoomUserNickname"; - + /** * Creates a <tt>ChatRoomPropertyChangeEvent</tt> indicating that a change * has occurred for property <tt>propertyName</tt> in the <tt>source</tt> @@ -58,9 +63,11 @@ public class ChatRoomPropertyChangeEvent { return (ChatRoom)getSource(); } - + /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeFailedEvent.java b/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeFailedEvent.java index 37265c6..35ce982 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeFailedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ChatRoomPropertyChangeFailedEvent.java @@ -14,28 +14,33 @@ import net.java.sip.communicator.service.protocol.*; * Dispatched to indicate that a change of a chat room property has failed. * The modification of a property could fail, because the implementation * doesn't support such a property. - * + * * @author Yana Stamcheva */ public class ChatRoomPropertyChangeFailedEvent extends PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that the current implementation doesn't support the given * property. */ public static final int PROPERTY_NOT_SUPPORTED = 0; - + /** * The reason of the failure. */ private final String reason; - + /** * Indicates why the failure occurred. */ private final int reasonCode; - + /** * Creates a <tt>ChatRoomPropertyChangeEvent</tt> indicating that a change * has occurred for property <tt>propertyName</tt> in the <tt>source</tt> @@ -49,7 +54,7 @@ public class ChatRoomPropertyChangeFailedEvent * @param reasonCode the code indicating the reason for the failure * @param reason more detailed explanation of the failure */ - public ChatRoomPropertyChangeFailedEvent( ChatRoom source, + public ChatRoomPropertyChangeFailedEvent( ChatRoom source, String propertyName, Object propertyValue, Object expectedValue, @@ -57,7 +62,7 @@ public class ChatRoomPropertyChangeFailedEvent String reason) { super(source, propertyName, propertyValue, expectedValue); - + this.reasonCode = reasonCode; this.reason = reason; } @@ -72,27 +77,27 @@ public class ChatRoomPropertyChangeFailedEvent { return (ChatRoom)getSource(); } - + /** * Returns the value of the property. - * + * * @return the value of the property. */ public Object getPropertyValue() { - return getOldValue(); + return getOldValue(); } - + /** * Return the expected after the change value of the property. - * + * * @return the expected after the change value of the property */ public Object getExpectedValue() { return getNewValue(); } - + /** * Returns the code of the failure. One of the static constants declared in * this class. @@ -103,7 +108,7 @@ public class ChatRoomPropertyChangeFailedEvent { return reasonCode; } - + /** * Returns the reason of the failure. * @return the reason of the failure @@ -112,9 +117,11 @@ public class ChatRoomPropertyChangeFailedEvent { return reason; } - + /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/ConferenceMembersSoundLevelEvent.java b/src/net/java/sip/communicator/service/protocol/event/ConferenceMembersSoundLevelEvent.java index 2436107..c716299 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ConferenceMembersSoundLevelEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ConferenceMembersSoundLevelEvent.java @@ -22,6 +22,11 @@ public class ConferenceMembersSoundLevelEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The maximum level that can be reported for a participant in a conference. * Level values should be distributed among MAX_LEVEL and MIN_LEVEL in a * way that would appear uniform to users. diff --git a/src/net/java/sip/communicator/service/protocol/event/ContactCapabilitiesEvent.java b/src/net/java/sip/communicator/service/protocol/event/ContactCapabilitiesEvent.java index ee32d90..da12de3 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ContactCapabilitiesEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ContactCapabilitiesEvent.java @@ -13,7 +13,7 @@ import net.java.sip.communicator.service.protocol.*; /** * Represents an event/<tt>EventObject</tt> fired by * <tt>OperationSetClientCapabilities</tt> in order to notify about changes in - * the list of the <tt>OperationSet</tt> capabilities of a <tt>Contact</tt>. + * the list of the <tt>OperationSet</tt> capabilities of a <tt>Contact</tt>. * * @author Lubomir Marinov */ @@ -21,6 +21,11 @@ public class ContactCapabilitiesEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The ID of the <tt>ContactCapabilitiesEvent</tt> which notifies about * changes in the list of the <tt>OperationSet</tt> capabilities of a * <tt>Contact</tt>. diff --git a/src/net/java/sip/communicator/service/protocol/event/ContactPresenceStatusChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ContactPresenceStatusChangeEvent.java index a09ee93..4ce2d1f 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ContactPresenceStatusChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ContactPresenceStatusChangeEvent.java @@ -17,9 +17,20 @@ import net.java.sip.communicator.service.protocol.*; */ public class ContactPresenceStatusChangeEvent extends PropertyChangeEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** + * The contact's <tt>ProtocolProviderService</tt>. + */ private ProtocolProviderService sourceProvider = null; - private ContactGroup parentGroup = null; + /** + * The parent group of the contact. + */ + private ContactGroup parentGroup = null; /** * Creates an event instance indicating that the specified source contact diff --git a/src/net/java/sip/communicator/service/protocol/event/ContactPropertyChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ContactPropertyChangeEvent.java index cd6ee66..6f324bc 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ContactPropertyChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ContactPropertyChangeEvent.java @@ -13,6 +13,11 @@ public class ContactPropertyChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that a change has occurred in the display name of the source * contact. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/FileTransferCreatedEvent.java b/src/net/java/sip/communicator/service/protocol/event/FileTransferCreatedEvent.java index 8656f8b..feaeff0 100644 --- a/src/net/java/sip/communicator/service/protocol/event/FileTransferCreatedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/FileTransferCreatedEvent.java @@ -13,13 +13,18 @@ import net.java.sip.communicator.service.protocol.*; /** * The <tt>FileTransferCreatedEvent</tt> indicates the creation of a file * transfer. - * + * * @author Yana Stamcheva */ public class FileTransferCreatedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The timestamp indicating the exact date when the event occurred. */ private final Date timestamp; @@ -43,7 +48,7 @@ public class FileTransferCreatedEvent /** * Returns the file transfer that triggered this event. - * + * * @return the <tt>FileTransfer</tt> that triggered this * event. */ @@ -54,7 +59,7 @@ public class FileTransferCreatedEvent /** * A timestamp indicating the exact date when the event occurred. - * + * * @return a Date indicating when the event occurred. */ public Date getTimestamp() diff --git a/src/net/java/sip/communicator/service/protocol/event/FileTransferProgressEvent.java b/src/net/java/sip/communicator/service/protocol/event/FileTransferProgressEvent.java index b8c57ef..0a8157c 100644 --- a/src/net/java/sip/communicator/service/protocol/event/FileTransferProgressEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/FileTransferProgressEvent.java @@ -13,13 +13,18 @@ import net.java.sip.communicator.service.protocol.*; /** * The <tt>FileTransferProgressEvent</tt> indicates the progress of a file * transfer. - * + * * @author Yana Stamcheva */ public class FileTransferProgressEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates the progress of a file transfer in bytes. */ private long progress; @@ -33,7 +38,7 @@ public class FileTransferProgressEvent * Creates a <tt>FileTransferProgressEvent</tt> by specifying the source * file transfer object, that triggered the event and the new progress * value. - * + * * @param fileTransfer the source file transfer object, that triggered the * event * @param timestamp when this event occured @@ -51,7 +56,7 @@ public class FileTransferProgressEvent /** * Returns the source <tt>FileTransfer</tt> that triggered this event. - * + * * @return the source <tt>FileTransfer</tt> that triggered this event */ public FileTransfer getFileTransfer() @@ -61,7 +66,7 @@ public class FileTransferProgressEvent /** * Returns the progress of the file transfer in transferred bytes. - * + * * @return the progress of the file transfer */ public long getProgress() @@ -71,7 +76,7 @@ public class FileTransferProgressEvent /** * Returns the timestamp when this event initially occured. - * + * * @return the timestamp when this event initially occured */ public long getTimestamp() diff --git a/src/net/java/sip/communicator/service/protocol/event/FileTransferRequestEvent.java b/src/net/java/sip/communicator/service/protocol/event/FileTransferRequestEvent.java index 551ac96..9c04de8 100644 --- a/src/net/java/sip/communicator/service/protocol/event/FileTransferRequestEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/FileTransferRequestEvent.java @@ -13,7 +13,7 @@ import net.java.sip.communicator.service.protocol.*; /** * The <tt>FileTransferRequestEvent</tt> indicates the reception of a file * transfer request. - * + * * @author Nicolas Riegel * @author Yana Stamcheva */ @@ -21,6 +21,11 @@ public class FileTransferRequestEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The request that triggered this event. */ private final IncomingFileTransferRequest request; @@ -53,7 +58,7 @@ public class FileTransferRequestEvent /** * Returns the <tt>OperationSetFileTransfer</tt>, where this event initially * occurred. - * + * * @return the <tt>OperationSetFileTransfer</tt>, where this event initially * occurred */ @@ -64,7 +69,7 @@ public class FileTransferRequestEvent /** * Returns the incoming file transfer request that triggered this event. - * + * * @return the <tt>IncomingFileTransferRequest</tt> that triggered this * event. */ @@ -75,7 +80,7 @@ public class FileTransferRequestEvent /** * A timestamp indicating the exact date when the event occurred. - * + * * @return a Date indicating when the event occurred. */ public Date getTimestamp() diff --git a/src/net/java/sip/communicator/service/protocol/event/FileTransferStatusChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/FileTransferStatusChangeEvent.java index ee5daf3..d886773 100644 --- a/src/net/java/sip/communicator/service/protocol/event/FileTransferStatusChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/FileTransferStatusChangeEvent.java @@ -13,13 +13,18 @@ import net.java.sip.communicator.service.protocol.*; /** * The <tt>FileTransferStatusChangeEvent</tt> is the event indicating of a * change in the state of a file transfer. - * + * * @author Yana Stamcheva */ public class FileTransferStatusChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that the file transfer has been completed. */ public static final int COMPLETED = 0; @@ -73,7 +78,7 @@ public class FileTransferStatusChangeEvent /** * Creates a <tt>FileTransferStatusChangeEvent</tt> by specifying the * source <tt>fileTransfer</tt>, the old transfer status and the new status. - * + * * @param fileTransfer the source file transfer, for which this status * change occured * @param oldStatus the old status @@ -94,7 +99,7 @@ public class FileTransferStatusChangeEvent /** * Returns the source <tt>FileTransfer</tt> that triggered this event. - * + * * @return the source <tt>FileTransfer</tt> that triggered this event */ public FileTransfer getFileTransfer() @@ -104,7 +109,7 @@ public class FileTransferStatusChangeEvent /** * Returns the state of the file transfer before this event occured. - * + * * @return the old state */ public int getOldStatus() @@ -114,7 +119,7 @@ public class FileTransferStatusChangeEvent /** * The new state of the file transfer. - * + * * @return the new state */ public int getNewStatus() diff --git a/src/net/java/sip/communicator/service/protocol/event/GeolocationEvent.java b/src/net/java/sip/communicator/service/protocol/event/GeolocationEvent.java index 2db6329..819796a 100644 --- a/src/net/java/sip/communicator/service/protocol/event/GeolocationEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/GeolocationEvent.java @@ -18,6 +18,10 @@ import net.java.sip.communicator.service.protocol.*; public class GeolocationEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * The provider that has generated the event. diff --git a/src/net/java/sip/communicator/service/protocol/event/LocalUserChatRoomPresenceChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/LocalUserChatRoomPresenceChangeEvent.java index 3a11278..ccba82d 100644 --- a/src/net/java/sip/communicator/service/protocol/event/LocalUserChatRoomPresenceChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/LocalUserChatRoomPresenceChangeEvent.java @@ -21,6 +21,11 @@ public class LocalUserChatRoomPresenceChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that this event was triggered as a result of the local * participant joining a chat room. */ @@ -43,7 +48,7 @@ public class LocalUserChatRoomPresenceChangeEvent * participant being kicked from a chat room. */ public static final String LOCAL_USER_KICKED = "LocalUserKicked"; - + /** * Indicates that this event was triggered as a result of the local * participant beeing disconnected from the server brutally, or ping timeout. @@ -54,7 +59,7 @@ public class LocalUserChatRoomPresenceChangeEvent * The <tt>ChatRoom</tt> to which the change is related. */ private ChatRoom chatRoom = null; - + /** * The type of this event. */ @@ -70,7 +75,7 @@ public class LocalUserChatRoomPresenceChangeEvent * Creates a <tt>ChatRoomLocalUserPresenceChangeEvent</tt> representing that * a change in local participant presence in the source chat room has * occured. - * + * * @param source the <tt>OperationSetMultiUserChat</tt>, which produced this * event * @param chatRoom the <tt>ChatRoom</tt> that this event is about @@ -83,7 +88,7 @@ public class LocalUserChatRoomPresenceChangeEvent String reason) { super(source); - + this.chatRoom = chatRoom; this.eventType = eventType; this.reason = reason; @@ -100,7 +105,7 @@ public class LocalUserChatRoomPresenceChangeEvent { return (OperationSetMultiUserChat) getSource(); } - + /** * Returns the <tt>ChatRoom</tt>, that this event is about. * @@ -135,6 +140,8 @@ public class LocalUserChatRoomPresenceChangeEvent /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/event/MessageDeliveredEvent.java b/src/net/java/sip/communicator/service/protocol/event/MessageDeliveredEvent.java index b1812a4..3a75227 100644 --- a/src/net/java/sip/communicator/service/protocol/event/MessageDeliveredEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/MessageDeliveredEvent.java @@ -20,6 +20,11 @@ public class MessageDeliveredEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that has sent this message. */ private Contact to = null; diff --git a/src/net/java/sip/communicator/service/protocol/event/MessageDeliveryFailedEvent.java b/src/net/java/sip/communicator/service/protocol/event/MessageDeliveryFailedEvent.java index 1146ef3..15ca49e 100644 --- a/src/net/java/sip/communicator/service/protocol/event/MessageDeliveryFailedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/MessageDeliveryFailedEvent.java @@ -20,6 +20,11 @@ public class MessageDeliveryFailedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that this message has been sent to. */ private Contact to = null; @@ -142,7 +147,7 @@ public class MessageDeliveryFailedEvent { return (Message) getSource(); } - + /** * Returns an error code descibing the reason for the failure of the * message delivery. @@ -158,7 +163,7 @@ public class MessageDeliveryFailedEvent * A timestamp indicating the exact date when the event ocurred (in this * case it is the moment when it was determined that message delivery has * failed). - * + * * @return a long indicating when the event ocurred in the form of * date timestamp. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/MessageEvent.java b/src/net/java/sip/communicator/service/protocol/event/MessageEvent.java index 2b9a7d7..3b76914 100644 --- a/src/net/java/sip/communicator/service/protocol/event/MessageEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/MessageEvent.java @@ -9,6 +9,16 @@ import java.util.*; public class MessageEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** + * Construcs a new <tt>MessageEvent</tt> instance. + * + * @param source Object on which the Event initially occurred + */ public MessageEvent(Object source) { super(source); diff --git a/src/net/java/sip/communicator/service/protocol/event/MessageReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/MessageReceivedEvent.java index be62256..c7e3246 100644 --- a/src/net/java/sip/communicator/service/protocol/event/MessageReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/MessageReceivedEvent.java @@ -19,6 +19,11 @@ public class MessageReceivedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the message being received is a standard * conversation message sent by another contact. */ @@ -62,19 +67,19 @@ public class MessageReceivedEvent */ public MessageReceivedEvent(Message source, Contact from, long timestamp) { - this(source, from, timestamp, CONVERSATION_MESSAGE_RECEIVED); + this(source, from, timestamp, CONVERSATION_MESSAGE_RECEIVED); } - + /** * Creates a <tt>MessageReceivedEvent</tt> representing reception of the * <tt>source</tt> message received from the specified <tt>from</tt> * contact. - * + * * @param source the <tt>Message</tt> whose reception this event represents. * @param from the <tt>Contact</tt> that has sent this message. * @param timestamp the exact date when the event occurred. * @param eventType the type of message event that this instance represents - * (one of the XXX_MESSAGE_RECEIVED static fields). + * (one of the XXX_MESSAGE_RECEIVED static fields). */ public MessageReceivedEvent(Message source, Contact from, long timestamp, int eventType) @@ -85,7 +90,7 @@ public class MessageReceivedEvent this.timestamp = timestamp; this.eventType = eventType; } - + /** * Returns a reference to the <tt>Contact</tt> that has send the * <tt>Message</tt> whose reception this event represents. @@ -100,7 +105,7 @@ public class MessageReceivedEvent /** * Returns the message that triggered this event - * + * * @return the <tt>Message</tt> that triggered this event. */ public Message getSourceMessage() @@ -110,19 +115,19 @@ public class MessageReceivedEvent /** * A timestamp indicating the exact date when the event occurred. - * + * * @return a Date indicating when the event occurred. */ public long getTimestamp() { return timestamp; } - + /** * Returns the type of message event represented by this event instance. * Message event type is one of the XXX_MESSAGE_RECEIVED fields of this * class. - * + * * @return one of the XXX_MESSAGE_RECEIVED fields of this class indicating * the type of this event. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/ProviderPresenceStatusChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ProviderPresenceStatusChangeEvent.java index ceac4f9..5d448a7 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ProviderPresenceStatusChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ProviderPresenceStatusChangeEvent.java @@ -17,6 +17,10 @@ import net.java.sip.communicator.service.protocol.*; */ public class ProviderPresenceStatusChangeEvent extends PropertyChangeEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * Creates an event instance indicating a change of the property diff --git a/src/net/java/sip/communicator/service/protocol/event/ProviderStatusChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/ProviderStatusChangeEvent.java index e52521f..304cf24 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ProviderStatusChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ProviderStatusChangeEvent.java @@ -17,6 +17,10 @@ import net.java.sip.communicator.service.protocol.*; */ public class ProviderStatusChangeEvent extends PropertyChangeEvent { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; /** * Creates an event instance indicating a change of the property diff --git a/src/net/java/sip/communicator/service/protocol/event/RegistrationStateChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/RegistrationStateChangeEvent.java index 4469363..e2e93ec 100644 --- a/src/net/java/sip/communicator/service/protocol/event/RegistrationStateChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/RegistrationStateChangeEvent.java @@ -30,6 +30,11 @@ import net.java.sip.communicator.service.protocol.*; public class RegistrationStateChangeEvent extends PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that no reason is specified for this event transition. */ public static final int REASON_NOT_SPECIFIED = -1; diff --git a/src/net/java/sip/communicator/service/protocol/event/ServerStoredGroupEvent.java b/src/net/java/sip/communicator/service/protocol/event/ServerStoredGroupEvent.java index daf823a..c3e25a0 100644 --- a/src/net/java/sip/communicator/service/protocol/event/ServerStoredGroupEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/ServerStoredGroupEvent.java @@ -20,6 +20,11 @@ public class ServerStoredGroupEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that a contact group has been successfully created. */ public static final int GROUP_CREATED_EVENT = 1; diff --git a/src/net/java/sip/communicator/service/protocol/event/SizeChangeVideoEvent.java b/src/net/java/sip/communicator/service/protocol/event/SizeChangeVideoEvent.java index f868303..8ecea31 100644 --- a/src/net/java/sip/communicator/service/protocol/event/SizeChangeVideoEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/SizeChangeVideoEvent.java @@ -18,6 +18,11 @@ public class SizeChangeVideoEvent extends VideoEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The type of a <tt>VideoEvent</tt> which notifies about an update to the * size of a specific visual <tt>Component</tt> depicting video. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/SoundLevelChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/SoundLevelChangeEvent.java index f6aa124..c27956f 100644 --- a/src/net/java/sip/communicator/service/protocol/event/SoundLevelChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/SoundLevelChangeEvent.java @@ -28,6 +28,11 @@ public class SoundLevelChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The maximum level that can be reported for a participant. * Level values should be distributed among MAX_LEVEL and MIN_LEVEL in a * way that would appear uniform to users. diff --git a/src/net/java/sip/communicator/service/protocol/event/SubscriptionEvent.java b/src/net/java/sip/communicator/service/protocol/event/SubscriptionEvent.java index 3d480a1..3469db4 100644 --- a/src/net/java/sip/communicator/service/protocol/event/SubscriptionEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/SubscriptionEvent.java @@ -22,6 +22,11 @@ import net.java.sip.communicator.service.protocol.*; public class SubscriptionEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private int eventID = -1; /** diff --git a/src/net/java/sip/communicator/service/protocol/event/SubscriptionMovedEvent.java b/src/net/java/sip/communicator/service/protocol/event/SubscriptionMovedEvent.java index 85c9c2c..a4bfc88 100644 --- a/src/net/java/sip/communicator/service/protocol/event/SubscriptionMovedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/SubscriptionMovedEvent.java @@ -22,6 +22,11 @@ import net.java.sip.communicator.service.protocol.*; public class SubscriptionMovedEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private ContactGroup oldParent = null; private ContactGroup newParent = null; private ProtocolProviderService sourceProvider = null; diff --git a/src/net/java/sip/communicator/service/protocol/event/TypingNotificationEvent.java b/src/net/java/sip/communicator/service/protocol/event/TypingNotificationEvent.java index 9b2a8f2..f5e3917 100644 --- a/src/net/java/sip/communicator/service/protocol/event/TypingNotificationEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/TypingNotificationEvent.java @@ -21,6 +21,11 @@ import net.java.sip.communicator.service.protocol.*; public class TypingNotificationEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + private int typingState = OperationSetTypingNotifications.STATE_UNKNOWN; /** diff --git a/src/net/java/sip/communicator/service/protocol/event/VideoEvent.java b/src/net/java/sip/communicator/service/protocol/event/VideoEvent.java index 19ca41c..28c97f7 100644 --- a/src/net/java/sip/communicator/service/protocol/event/VideoEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/VideoEvent.java @@ -19,6 +19,10 @@ import java.util.*; public class VideoEvent
extends EventObject
{
+ /**
+ * Serial version UID.
+ */
+ private static final long serialVersionUID = 0L;
/**
* The video origin of a <code>VideoEvent</code> which is local to the
diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardChangeEvent.java index 3eebaa1..c4c8bd0 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardChangeEvent.java @@ -21,6 +21,11 @@ public class WhiteboardChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the corresponding event is caused by a * change of the Whiteboard state. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationReceivedEvent.java index 127ed68..28cb530 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationReceivedEvent.java @@ -12,17 +12,22 @@ import net.java.sip.communicator.service.protocol.*; /** * <tt>WhiteboardInvitationReceivedEvent</tt>s indicate reception of an * invitation to join a whiteboard. - * + * * @author Yana Stamcheva */ public class WhiteboardInvitationReceivedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The invitation corresponding to this event. */ private WhiteboardInvitation invitation; - + /** * A timestamp indicating the exact date when the event occurred. */ @@ -49,17 +54,17 @@ public class WhiteboardInvitationReceivedEvent this.invitation = invitation; this.timestamp = timestamp; } - + /** * Returns the whiteboarding operation set that dispatches this event. - * + * * @return the whiteboarding operation set that dispatches this event. */ public OperationSetWhiteboarding getSourceOperationSet() { return (OperationSetWhiteboarding) getSource(); } - + /** * Returns the <tt>WhiteboardInvitation</tt> that this event is for. * @@ -69,7 +74,7 @@ public class WhiteboardInvitationReceivedEvent { return invitation; } - + /** * A timestamp indicating the exact date when the event ocurred. * diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationRejectedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationRejectedEvent.java index d5ee190..b313c62 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationRejectedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardInvitationRejectedEvent.java @@ -19,26 +19,31 @@ public class WhiteboardInvitationRejectedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The <tt>WhiteboardSession</tt> for which the initial invitation was. */ private WhiteboardSession whiteboardSession; - + /** * The invitee that rejected the invitation. */ private String invitee; - + /** * The reason why this invitation is rejected or null if there is no reason * specified. */ private String reason; - + /** * The exact date at which this event occured. */ private Date timestamp; - + /** * Creates a <tt>WhiteboardInvitationRejectedEvent</tt> representing the * rejection of an invitation, rejected by the given <tt>invitee</tt>. @@ -65,21 +70,21 @@ public class WhiteboardInvitationRejectedEvent this.reason = reason; this.timestamp = timestamp; } - + /** * Returns the whiteboarding operation set that dispatches this event. - * + * * @return the whiteboarding operation set that dispatches this event */ public OperationSetWhiteboarding getSourceOperationSet() { return (OperationSetWhiteboarding) getSource(); } - + /** * Returns the <tt>WhiteboardSession</tt> for which the initial invitation * was. - * + * * @return the <tt>WhiteboardSession</tt> for which the initial invitation * was */ @@ -87,7 +92,7 @@ public class WhiteboardInvitationRejectedEvent { return whiteboardSession; } - + /** * Returns the name of the invitee that rejected the invitation. * @@ -97,7 +102,7 @@ public class WhiteboardInvitationRejectedEvent { return invitee; } - + /** * Returns the reason for which the <tt>ChatRoomInvitation</tt> is rejected. * @@ -107,7 +112,7 @@ public class WhiteboardInvitationRejectedEvent { return reason; } - + /** * A timestamp indicating the exact date when the event ocurred. * @return a Date indicating when the event ocurred. diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeletedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeletedEvent.java index 838d67f..bd44706 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeletedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeletedEvent.java @@ -21,20 +21,25 @@ public class WhiteboardObjectDeletedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that has sent this wbObject. */ private Contact from = null; - + /** * A timestamp indicating the exact date when the event occurred. */ private Date timestamp = null; - + /** * A String that uniquely identifies this WhiteboardObject. */ private String id; - + /** * Creates a <tt>WhiteboardObjectReceivedEvent</tt> * representing reception of the <tt>source</tt> WhiteboardObject @@ -60,7 +65,7 @@ public class WhiteboardObjectDeletedEvent /** * Returns the source white-board session, to which the received object * belongs. - * + * * @return the source white-board session, to which the received object * belongs */ @@ -80,7 +85,7 @@ public class WhiteboardObjectDeletedEvent { return from; } - + /** * Returns the identification of the deleted WhiteboardObject * that triggered this event @@ -91,7 +96,7 @@ public class WhiteboardObjectDeletedEvent { return id; } - + /** * A timestamp indicating the exact date when the event ocurred. * @return a Date indicating when the event ocurred. diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveredEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveredEvent.java index 4f6e4fa..359c8ad 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveredEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveredEvent.java @@ -22,6 +22,11 @@ public class WhiteboardObjectDeliveredEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that has sent this wbObject. */ private Contact to = null; diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveryFailedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveryFailedEvent.java index d6de770..7a05f44 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveryFailedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectDeliveryFailedEvent.java @@ -22,6 +22,11 @@ public class WhiteboardObjectDeliveryFailedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that this whiteboard object has been sent to. */ private Contact to = null; diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectModifiedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectModifiedEvent.java index bb69030..3308fdd 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectModifiedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectModifiedEvent.java @@ -22,6 +22,11 @@ public class WhiteboardObjectModifiedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that has sent this wbObject. */ private Contact from = null; @@ -59,7 +64,7 @@ public class WhiteboardObjectModifiedEvent /** * Returns the source white-board session, to which the received object * belongs. - * + * * @return the source white-board session, to which the received object * belongs */ diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectReceivedEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectReceivedEvent.java index e118a5f..398eead 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectReceivedEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardObjectReceivedEvent.java @@ -22,6 +22,11 @@ public class WhiteboardObjectReceivedEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * The contact that has sent this wbObject. */ private Contact from = null; @@ -60,7 +65,7 @@ public class WhiteboardObjectReceivedEvent /** * Returns the source white-board session, to which the received object * belongs. - * + * * @return the source white-board session, to which the received object * belongs */ diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantChangeEvent.java index a4267fb..80c67cb 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantChangeEvent.java @@ -29,6 +29,11 @@ public class WhiteboardParticipantChangeEvent extends java.beans.PropertyChangeEvent { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event type indicating that the corresponding event is caused by a * change of the WhiteboardParticipant's status. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantEvent.java index dfebb50..ee97955 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardParticipantEvent.java @@ -21,6 +21,11 @@ public class WhiteboardParticipantEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * An event id value indicating that this event is about the fact that * the source whiteboard participant has joined the source whiteboard. */ diff --git a/src/net/java/sip/communicator/service/protocol/event/WhiteboardSessionPresenceChangeEvent.java b/src/net/java/sip/communicator/service/protocol/event/WhiteboardSessionPresenceChangeEvent.java index 4b445e7..f75d083 100644 --- a/src/net/java/sip/communicator/service/protocol/event/WhiteboardSessionPresenceChangeEvent.java +++ b/src/net/java/sip/communicator/service/protocol/event/WhiteboardSessionPresenceChangeEvent.java @@ -20,6 +20,11 @@ public class WhiteboardSessionPresenceChangeEvent extends EventObject { /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + + /** * Indicates that this event was triggered as a result of the local * participant joining a whiteboard. */ @@ -42,7 +47,7 @@ public class WhiteboardSessionPresenceChangeEvent * participant being kicked from a whiteboard. */ public static final String LOCAL_USER_KICKED = "LocalUserKicked"; - + /** * Indicates that this event was triggered as a result of the local * participant beeing disconnected from the server brutally, or ping timeout. @@ -53,7 +58,7 @@ public class WhiteboardSessionPresenceChangeEvent * The <tt>WhiteboardSession</tt> to which the change is related. */ private WhiteboardSession whiteboardSession = null; - + /** * The type of this event. */ @@ -69,7 +74,7 @@ public class WhiteboardSessionPresenceChangeEvent * Creates a <tt>WhiteboardSessionPresenceChangeEvent</tt> representing that * a change in local participant presence in the source white-board has * occured. - * + * * @param source the <tt>OperationSetWhiteboarding</tt>, which produced this * event * @param session the <tt>WhiteboardSession</tt> that this event is about @@ -82,7 +87,7 @@ public class WhiteboardSessionPresenceChangeEvent String reason) { super(source); - + this.whiteboardSession = session; this.eventType = eventType; this.reason = reason; @@ -99,7 +104,7 @@ public class WhiteboardSessionPresenceChangeEvent { return (OperationSetWhiteboarding) getSource(); } - + /** * Returns the <tt>WhiteboardSession</tt>, that this event is about. * @@ -134,6 +139,8 @@ public class WhiteboardSessionPresenceChangeEvent /** * Returns a String representation of this event. + * + * @return String representation of this event */ public String toString() { diff --git a/src/net/java/sip/communicator/service/protocol/icqconstants/IcqStatusEnum.java b/src/net/java/sip/communicator/service/protocol/icqconstants/IcqStatusEnum.java index be6a0cf..78d8ce9 100644 --- a/src/net/java/sip/communicator/service/protocol/icqconstants/IcqStatusEnum.java +++ b/src/net/java/sip/communicator/service/protocol/icqconstants/IcqStatusEnum.java @@ -26,7 +26,10 @@ import net.java.sip.communicator.util.*; public class IcqStatusEnum extends PresenceStatus { - + /** + * The <tt>Logger</tt> used by the <tt>IcqStatusEnum</tt> class and its + * instances for logging output. + */ private static Logger logger = Logger.getLogger(IcqStatusEnum.class); /** @@ -100,7 +103,7 @@ public class IcqStatusEnum /** * The minimal set of states that any ICQ implementation must support. */ - public static final ArrayList<IcqStatusEnum> icqStatusSet + public static final ArrayList<IcqStatusEnum> icqStatusSet = new ArrayList<IcqStatusEnum>(); static{ icqStatusSet.add(FREE_FOR_CHAT); diff --git a/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java b/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java index 87c3030..bcdd995 100644 --- a/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java +++ b/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java @@ -1,6 +1,6 @@ /* * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client. - * + * * Distributable under LGPL license. See terms of license at gnu.org. */ package net.java.sip.communicator.service.protocol.jabberconstants; @@ -16,7 +16,7 @@ import net.java.sip.communicator.util.*; * The <tt>JabberStatusEnum</tt> gives access to presence states for the Sip * protocol. All status icons corresponding to presence states are located with * the help of the <tt>imagePath</tt> parameter - * + * * @author Emil Ivov * @author Yana Stamcheva * @author Lubomir Marinov @@ -53,7 +53,7 @@ public class JabberStatusEnum * communicate. */ public static final String FREE_FOR_CHAT = "Free For Chat"; - + /** * The Free For Chat status. Indicates that the user is eager to * communicate. @@ -99,7 +99,7 @@ public class JabberStatusEnum * Indicates an Offline status or status with 0 connectivity. */ private final JabberPresenceStatus offlineStatus; - + /** * Indicates an Extended Away status or status. */ @@ -117,38 +117,38 @@ public class JabberStatusEnum * not. */ private final JabberPresenceStatus unknownStatus; - + private static final Map<String, JabberStatusEnum> existingEnums = new Hashtable<String, JabberStatusEnum>(); /** - * Returns an instance of JabberStatusEnum for the specified + * Returns an instance of JabberStatusEnum for the specified * <tt>iconPath</tt> or creates a new one if it doesn't already exist. - * - * @param iconPath the location containing the status icons that should + * + * @param iconPath the location containing the status icons that should * be used by this enumeration. - * + * * @return the newly created JabberStatusEnum instance. */ public static JabberStatusEnum getJabberStatusEnum(String iconPath) { JabberStatusEnum statusEnum = existingEnums.get(iconPath); - + if(statusEnum != null) return statusEnum; - + statusEnum = new JabberStatusEnum(iconPath); - + existingEnums.put(iconPath, statusEnum); - + return statusEnum; } - + /** * Creates a new instance of JabberStatusEnum using <tt>iconPath</tt> as the * root path where it should be reading status icons from. - * - * @param iconPath the location containing the status icons that should + * + * @param iconPath the location containing the status icons that should * be used by this enumeration. */ private JabberStatusEnum(String iconPath) @@ -160,7 +160,7 @@ public class JabberStatusEnum this.doNotDisturbStatus = new JabberPresenceStatus(30, DO_NOT_DISTURB, loadIcon(iconPath + "/status16x16-dnd.png")); - + this.extendedAwayStatus = new JabberPresenceStatus(35, EXTENDED_AWAY, loadIcon(iconPath + "/status16x16-xa.png")); @@ -192,7 +192,7 @@ public class JabberStatusEnum /** * Returns the offline Jabber status. - * + * * @param statusName the name of the status. * @return the offline Jabber status. */ @@ -217,7 +217,7 @@ public class JabberStatusEnum /** * Returns an iterator over all status instances supported by the sip * provider. - * + * * @return an <tt>Iterator</tt> over all status instances supported by the * sip provider. */ @@ -226,6 +226,11 @@ public class JabberStatusEnum return supportedStatusSet.iterator(); } + /** + * Get all status name as array. + * + * @return array of <tt>String</tt> representing the different status name + */ public static String[] getStatusNames() { return new String[] @@ -234,7 +239,7 @@ public class JabberStatusEnum /** * Loads an image from a given image path. - * + * * @param imagePath The path to the image resource. * @return The image extracted from the resource at the specified path. */ @@ -306,7 +311,7 @@ public class JabberStatusEnum /** * Creates an instance of <tt>JabberPresenceStatus</tt> with the * specified parameters. - * + * * @param status the connectivity level of the new presence status * instance * @param statusName the name of the presence status. diff --git a/src/net/java/sip/communicator/service/protocol/msnconstants/MsnStatusEnum.java b/src/net/java/sip/communicator/service/protocol/msnconstants/MsnStatusEnum.java index 45d535e..9f7b3ad 100644 --- a/src/net/java/sip/communicator/service/protocol/msnconstants/MsnStatusEnum.java +++ b/src/net/java/sip/communicator/service/protocol/msnconstants/MsnStatusEnum.java @@ -26,6 +26,10 @@ import net.java.sip.communicator.util.*; public class MsnStatusEnum extends PresenceStatus { + /** + * The <tt>Logger</tt> used by the <tt>MsnStatusEnum</tt> class and its + * instances for logging output. + */ private static Logger logger = Logger.getLogger(MsnStatusEnum.class); /** diff --git a/src/net/java/sip/communicator/service/protocol/yahooconstants/YahooStatusEnum.java b/src/net/java/sip/communicator/service/protocol/yahooconstants/YahooStatusEnum.java index eda1d04..c105729 100644 --- a/src/net/java/sip/communicator/service/protocol/yahooconstants/YahooStatusEnum.java +++ b/src/net/java/sip/communicator/service/protocol/yahooconstants/YahooStatusEnum.java @@ -26,8 +26,12 @@ import net.java.sip.communicator.util.*; public class YahooStatusEnum extends PresenceStatus { + /** + * The <tt>Logger</tt> used by the <tt>YahooStatusEnum</tt> class and its + * instances for logging output. + */ private static Logger logger = Logger.getLogger(YahooStatusEnum.class); - + /** * The Online status. Indicate that the user is able and willing to * communicate. @@ -73,7 +77,7 @@ public class YahooStatusEnum public static final YahooStatusEnum NOT_AT_HOME = new YahooStatusEnum(38, "Not at home", loadIcon("resources/images/protocol/yahoo/yahoo16x16-na.png")); - + /** * The On the phone status. Indicates that the user is talking to the phone. */ @@ -82,13 +86,13 @@ public class YahooStatusEnum loadIcon("resources/images/protocol/yahoo/yahoo16x16-phone.png")); /** - * The Not at desk status. Indicates that the user is not at his desk, but + * The Not at desk status. Indicates that the user is not at his desk, but * somewhere in the office. */ public static final YahooStatusEnum NOT_AT_DESK = new YahooStatusEnum(36, "Not at desk", loadIcon("resources/images/protocol/yahoo/yahoo16x16-na.png")); - + /** * The Not Available status. Indicates that the user has connectivity * but might not be able to immediately act (i.e. even less immediately than @@ -105,15 +109,15 @@ public class YahooStatusEnum public static final YahooStatusEnum NOT_IN_OFFICE = new YahooStatusEnum(34, "Not in office", loadIcon("resources/images/protocol/yahoo/yahoo16x16-na.png")); - + /** - * The On vacation status. Indicates that the user is somewhere on the + * The On vacation status. Indicates that the user is somewhere on the * beach or skiing. */ public static final YahooStatusEnum ON_VACATION = new YahooStatusEnum(33, "On vacation", loadIcon("resources/images/protocol/yahoo/yahoo16x16-vacation.png")); - + /** * The DND status. Indicates that the user has connectivity but prefers * not to be contacted. diff --git a/src/net/java/sip/communicator/service/systray/event/SystrayPopupMessageEvent.java b/src/net/java/sip/communicator/service/systray/event/SystrayPopupMessageEvent.java index 716f54a..220f577 100644 --- a/src/net/java/sip/communicator/service/systray/event/SystrayPopupMessageEvent.java +++ b/src/net/java/sip/communicator/service/systray/event/SystrayPopupMessageEvent.java @@ -11,15 +11,25 @@ import java.util.*; /** * The <tt>SystrayPopupMessageEvent</tt>s are posted when user clicks on the * system tray popup message. - * + * * @author Yana Stamcheva */ public class SystrayPopupMessageEvent extends EventObject { + /** + * Serial version UID. + */ + private static final long serialVersionUID = 0L; + /** an object to distinguish this <tt>SystrayPopupMessageEvent</tt> */ private Object tag; + /** + * Constructs a new <tt>SystrayPopupMessageEvent</tt> object. + * + * @param source object on which the Event initially occurred + */ public SystrayPopupMessageEvent(Object source) { super(source); diff --git a/src/net/java/sip/communicator/util/SortedProperties.java b/src/net/java/sip/communicator/util/SortedProperties.java index 9c1ea18..1d2bfdb 100644 --- a/src/net/java/sip/communicator/util/SortedProperties.java +++ b/src/net/java/sip/communicator/util/SortedProperties.java @@ -25,6 +25,8 @@ public class SortedProperties extends Properties * Get an enumeration of keys hold by the <tt>Properties</tt> object.
* Contrary to the original <tt>Properties</tt> implementation, it forces
* the keys to be sorted alphabetically.
+ *
+ * @return enumeration of the keys hold by the <tt>Properties</tt>.
*/
public synchronized Enumeration<Object> keys()
{
diff --git a/src/net/java/sip/communicator/util/xml/XMLException.java b/src/net/java/sip/communicator/util/xml/XMLException.java index 660776b..c00ee21 100644 --- a/src/net/java/sip/communicator/util/xml/XMLException.java +++ b/src/net/java/sip/communicator/util/xml/XMLException.java @@ -16,6 +16,9 @@ package net.java.sip.communicator.util.xml; public class XMLException extends Exception { + /** + * Serial version UID. + */ private static final long serialVersionUID = 0L; /** |