From ebe5c49e92e1376d2513951529edeaf245b8de5f Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Sat, 23 May 2020 22:35:27 +0200 Subject: [PATCH] [checkstyle] Tighten JavadocMethod checkstyle rule --- config/checkstyle/checkstyle.xml | 4 --- .../smack/provider/ProviderManagerTest.java | 1 + .../jivesoftware/smack/DummyConnection.java | 3 ++ .../httpfileupload/HttpFileUploadManager.java | 5 ++- .../usertune/element/UserTuneElement.java | 32 +++++++++---------- .../bytestreams/socks5/Socks5ProxyTest.java | 4 +-- .../jivesoftware/smack/roster/RosterTest.java | 10 ++++++ .../smack/roster/RosterVersioningTest.java | 3 ++ .../rosterstore/DirectoryRosterStoreTest.java | 3 ++ .../smackx/caps/EntityCapsTest.java | 6 +--- .../smackx/omemo/SignalOmemoStoreTest.java | 2 +- .../smack/tcp/PacketWriterTest.java | 6 ++-- 12 files changed, 45 insertions(+), 34 deletions(-) diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml index c62f00a71..c9f04d7aa 100644 --- a/config/checkstyle/checkstyle.xml +++ b/config/checkstyle/checkstyle.xml @@ -105,10 +105,6 @@ - - - - diff --git a/smack-core/src/test/java/org/jivesoftware/smack/provider/ProviderManagerTest.java b/smack-core/src/test/java/org/jivesoftware/smack/provider/ProviderManagerTest.java index 5210e6344..1c005322d 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/provider/ProviderManagerTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/provider/ProviderManagerTest.java @@ -29,6 +29,7 @@ public class ProviderManagerTest { /** * This test should be run in a clean (e.g. forked) VM + * @throws Exception if exception. */ @Test public void shouldInitializeSmackTest() throws Exception { diff --git a/smack-core/src/testFixtures/java/org/jivesoftware/smack/DummyConnection.java b/smack-core/src/testFixtures/java/org/jivesoftware/smack/DummyConnection.java index 135fd79d0..b49ab8d3e 100644 --- a/smack-core/src/testFixtures/java/org/jivesoftware/smack/DummyConnection.java +++ b/smack-core/src/testFixtures/java/org/jivesoftware/smack/DummyConnection.java @@ -150,6 +150,7 @@ public class DummyConnection extends AbstractXMPPConnection { * Returns the first stanza that's sent through {@link #sendStanza(Stanza)} * and that has not been returned by earlier calls to this method. * + * @param

the top level stream element class. * @return a sent packet. */ public

P getSentPacket() { @@ -162,6 +163,8 @@ public class DummyConnection extends AbstractXMPPConnection { * method will block for up to the specified number of seconds if no packets * have been sent yet. * + * @param wait how long to wait in seconds. + * @param

the top level stream element class. * @return a sent packet. */ @SuppressWarnings("unchecked") diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/httpfileupload/HttpFileUploadManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/httpfileupload/HttpFileUploadManager.java index 299466bbb..9a790dbc8 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/httpfileupload/HttpFileUploadManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/httpfileupload/HttpFileUploadManager.java @@ -324,8 +324,7 @@ public final class HttpFileUploadManager extends Manager { * supported by the service. * @throws InterruptedException if the calling thread was interrupted. * @throws XMPPException.XMPPErrorException if there was an XMPP error returned. - * @throws SmackException.NotConnectedException if the XMPP connection is not connected. - * @throws SmackException.NoResponseException if there was no response from the remote entity. + * @throws SmackException if smack exception. */ public Slot requestSlot(String filename, long fileSize) throws InterruptedException, XMPPException.XMPPErrorException, SmackException { @@ -348,7 +347,7 @@ public final class HttpFileUploadManager extends Manager { * @throws SmackException.NotConnectedException if the XMPP connection is not connected. * @throws InterruptedException if the calling thread was interrupted. * @throws XMPPException.XMPPErrorException if there was an XMPP error returned. - * @throws SmackException.NoResponseException if there was no response from the remote entity. + * @throws SmackException if smack exception. */ public Slot requestSlot(String filename, long fileSize, String contentType) throws SmackException, InterruptedException, XMPPException.XMPPErrorException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/usertune/element/UserTuneElement.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/usertune/element/UserTuneElement.java index 36daa66af..a564f5331 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/usertune/element/UserTuneElement.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/usertune/element/UserTuneElement.java @@ -186,8 +186,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Artist is an optional element in UserTuneElement. - * @param artist. - * @return builder. + * @param artist the artist. + * @return a reference to this builder. */ public Builder setArtist(String artist) { this.artist = artist; @@ -196,8 +196,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Length is an optional element in UserTuneElement. - * @param length. - * @return builder. + * @param length the length. + * @return a reference to this builder. */ public Builder setLength(int length) { return setLength(UInt16.from(length)); @@ -205,8 +205,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Length is an optional element in UserTuneElement. - * @param length. - * @return builder. + * @param length the length. + * @return a reference to this builder. */ public Builder setLength(UInt16 length) { this.length = length; @@ -215,8 +215,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Rating is an optional element in UserTuneElement. - * @param rating. - * @return builder. + * @param rating the rating. + * @return a reference to this builder. */ public Builder setRating(int rating) { this.rating = rating; @@ -225,8 +225,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Source is an optional element in UserTuneElement. - * @param source. - * @return builder. + * @param source the source. + * @return a reference to this builder. */ public Builder setSource(String source) { this.source = source; @@ -235,8 +235,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Title is an optional element in UserTuneElement. - * @param title. - * @return builder. + * @param title the title. + * @return a reference to this builder. */ public Builder setTitle(String title) { this.title = title; @@ -245,8 +245,8 @@ public final class UserTuneElement implements ExtensionElement { /** * Track is an optional element in UserTuneElement. - * @param track. - * @return builder. + * @param track the track. + * @return a reference to this builder. */ public Builder setTrack(String track) { this.track = track; @@ -255,8 +255,8 @@ public final class UserTuneElement implements ExtensionElement { /** * URI is an optional element in UserTuneElement. - * @param uri. - * @return builder. + * @param uri the URI. + * @return a reference to this builder. */ public Builder setUri(URI uri) { this.uri = uri; diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java index 99dd32d22..b72c35b69 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java @@ -86,7 +86,7 @@ public class Socks5ProxyTest { * When inserting new network addresses to the proxy the order should remain in the order they * were inserted. * - * @throws UnknownHostException + * @throws UnknownHostException if unknown host. */ @Test public void shouldPreserveAddressOrderOnInsertions() throws UnknownHostException { @@ -114,7 +114,7 @@ public class Socks5ProxyTest { * When replacing network addresses of the proxy the order should remain in the order if the * given list. * - * @throws UnknownHostException + * @throws UnknownHostException if unknown host. */ @Test public void shouldPreserveAddressOrderOnReplace() throws UnknownHostException { diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterTest.java index 8bd98748c..adb75cb09 100644 --- a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterTest.java +++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterTest.java @@ -95,6 +95,8 @@ public class RosterTest extends InitSmackIm { * Test a simple roster initialization according to the example in * RFC3921: Retrieving One's Roster on Login. + * + * @throws Exception in case of an exception. */ @Test public void testSimpleRosterInitialization() throws Exception { @@ -131,6 +133,8 @@ public class RosterTest extends InitSmackIm { * Test adding a roster item according to the example in * RFC3921: Adding a Roster Item. + * + * @throws Throwable in case a throwable is thrown. */ @Test public void testAddRosterItem() throws Throwable { @@ -203,6 +207,8 @@ public class RosterTest extends InitSmackIm { * Test updating a roster item according to the example in * RFC3921: Updating a Roster Item. + * + * @throws Throwable in case a throwable is thrown. */ @Test public void testUpdateRosterItem() throws Throwable { @@ -279,6 +285,7 @@ public class RosterTest extends InitSmackIm { * Test deleting a roster item according to the example in * RFC3921: Deleting a Roster Item. + * @throws Throwable if throwable is thrown. */ @Test public void testDeleteRosterItem() throws Throwable { @@ -327,6 +334,7 @@ public class RosterTest extends InitSmackIm { * Test a simple roster push according to the example in * RFC3921bis-03: Roster Push. + * @throws Throwable in case a throwable is thrown. */ @Test public void testSimpleRosterPush() throws Throwable { @@ -398,6 +406,7 @@ public class RosterTest extends InitSmackIm { * Test if adding an user with an empty group is equivalent with providing * no group. * + * @throws Throwable in case a throwable is thrown. * @see SMACK-294 */ @Test(timeout = 5000) @@ -466,6 +475,7 @@ public class RosterTest extends InitSmackIm { * Test processing a roster push with an empty group is equivalent with providing * no group. * + * @throws Throwable in case a throwable is thrown. * @see SMACK-294 */ @Test diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java index 91be648ed..aa2a51687 100644 --- a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java +++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java @@ -97,6 +97,8 @@ public class RosterVersioningTest { * by all entries of the roster store. * @throws SmackException if Smack detected an exceptional situation. * @throws XMPPException if an XMPP protocol error was received. + * @throws InterruptedException if interrupted. + * @throws IOException if IO exception. */ @Test(timeout = 300000) public void testEqualVersionStored() throws InterruptedException, IOException, XMPPException, SmackException { @@ -172,6 +174,7 @@ public class RosterVersioningTest { /** * Test roster versioning with roster pushes. + * @throws Throwable in case a throwable is thrown. */ @SuppressWarnings("UndefinedEquals") @Test(timeout = 5000) diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java index bf116b874..9dc9ba3c7 100644 --- a/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java +++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java @@ -57,6 +57,7 @@ public class DirectoryRosterStoreTest { /** * Tests that opening an uninitialized directory fails. + * @throws IOException if IO exception. */ @Test public void testStoreUninitialized() throws IOException { @@ -66,6 +67,7 @@ public class DirectoryRosterStoreTest { /** * Tests that an initialized directory is empty. + * @throws IOException if IO exception. */ @Test public void testStoreInitializedEmpty() throws IOException { @@ -80,6 +82,7 @@ public class DirectoryRosterStoreTest { /** * Tests adding and removing entries. + * @throws IOException if IO exception. */ @Test public void testStoreAddRemove() throws IOException { diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/caps/EntityCapsTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/caps/EntityCapsTest.java index 2ab7110a4..4c373a9ce 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/caps/EntityCapsTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/caps/EntityCapsTest.java @@ -125,11 +125,7 @@ public class EntityCapsTest extends AbstractSmackIntegrationTest { /** * Test if entity caps actually prevent a disco info request and reply. * - * @throws XMPPException if an XMPP protocol error was received. - * @throws InterruptedException if the calling thread was interrupted. - * @throws NotConnectedException if the XMPP connection is not connected. - * @throws NoResponseException if there was no response from the remote entity. - * + * @throws Exception if exception. */ @SmackIntegrationTest public void testPreventDiscoInfo() throws Exception { diff --git a/smack-omemo-signal/src/test/java/org/jivesoftware/smackx/omemo/SignalOmemoStoreTest.java b/smack-omemo-signal/src/test/java/org/jivesoftware/smackx/omemo/SignalOmemoStoreTest.java index 37b493a26..a4a9bedea 100644 --- a/smack-omemo-signal/src/test/java/org/jivesoftware/smackx/omemo/SignalOmemoStoreTest.java +++ b/smack-omemo-signal/src/test/java/org/jivesoftware/smackx/omemo/SignalOmemoStoreTest.java @@ -60,7 +60,7 @@ public class SignalOmemoStoreTest extends OmemoStoreTest