From e8923b9d16774ff37d20dd350cc2ef5962dfa7cc Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Wed, 9 May 2018 23:06:12 +0200 Subject: [PATCH] Enable trailing whitespace checkstyle check for all source code regions, including javadoc. --- config/checkstyle.xml | 18 +- .../smack/bosh/BOSHConfiguration.java | 2 +- .../smack/bosh/XMPPBOSHConnection.java | 14 +- .../jzlib/JzlibInputOutputStream.java | 4 +- .../java/org/jivesoftware/smack/IQTest.java | 2 +- .../org/jivesoftware/smack/LoginTest.java | 2 +- .../org/jivesoftware/smack/MessageTest.java | 4 +- .../org/jivesoftware/smack/PrivacyClient.java | 2 +- .../jivesoftware/smack/ReconnectionTest.java | 2 +- .../RosterInitializedBeforeConnectTest.java | 2 +- .../smack/RosterListenerTest.java | 2 +- .../jivesoftware/smack/RosterSmackTest.java | 8 +- .../smack/packet/PrivacyProviderTest.java | 10 +- .../smack/packet/PrivacyTest.java | 4 +- .../smack/test/SmackTestCase.java | 82 +++--- .../smack/AbstractConnectionListener.java | 2 +- .../smack/AbstractXMPPConnection.java | 52 ++-- .../smack/ConnectionConfiguration.java | 30 +- .../smack/ConnectionCreationListener.java | 2 +- .../smack/ConnectionListener.java | 2 +- .../smack/ReconnectionManager.java | 14 +- .../smack/SASLAuthentication.java | 12 +- .../smack/SmackConfiguration.java | 24 +- .../jivesoftware/smack/SmackException.java | 32 +-- .../jivesoftware/smack/StanzaCollector.java | 20 +- .../jivesoftware/smack/StanzaListener.java | 4 +- .../smack/SynchronizationPoint.java | 2 +- .../jivesoftware/smack/UnparseableStanza.java | 4 +- .../jivesoftware/smack/XMPPConnection.java | 88 +++--- .../smack/XMPPConnectionRegistry.java | 6 +- .../org/jivesoftware/smack/XMPPException.java | 12 +- .../Java7ZlibInputOutputStream.java | 8 +- .../compression/XMPPInputOutputStream.java | 2 +- .../smack/debugger/SmackDebugger.java | 14 +- .../smack/filter/IQTypeFilter.java | 4 +- .../smack/filter/MessageTypeFilter.java | 4 +- .../smack/initializer/SmackInitializer.java | 4 +- .../smack/initializer/UrlInitializer.java | 2 +- .../smack/initializer/VmArgInitializer.java | 4 +- .../smack/packet/AbstractError.java | 6 +- .../org/jivesoftware/smack/packet/Bind.java | 2 +- .../org/jivesoftware/smack/packet/IQ.java | 2 +- .../jivesoftware/smack/packet/Message.java | 4 +- .../org/jivesoftware/smack/packet/Packet.java | 10 +- .../jivesoftware/smack/packet/Presence.java | 8 +- .../org/jivesoftware/smack/packet/Stanza.java | 8 +- .../smack/packet/StanzaError.java | 6 +- .../parsing/ExceptionLoggingCallback.java | 4 +- .../parsing/ExceptionThrowingCallback.java | 4 +- .../parsing/ParsingExceptionCallback.java | 6 +- .../provider/EmbeddedExtensionProvider.java | 28 +- .../smack/provider/ExtensionProviderInfo.java | 4 +- .../smack/provider/IQProviderInfo.java | 4 +- .../jivesoftware/smack/provider/Provider.java | 2 +- .../smack/provider/ProviderFileLoader.java | 4 +- .../smack/provider/ProviderLoader.java | 4 +- .../provider/StreamFeatureProviderInfo.java | 2 +- .../proxy/HTTPProxySocketConnection.java | 4 +- .../smack/proxy/ProxyException.java | 4 +- .../jivesoftware/smack/proxy/ProxyInfo.java | 12 +- .../proxy/Socks4ProxySocketConnection.java | 8 +- .../proxy/Socks5ProxySocketConnection.java | 10 +- .../smack/sasl/SASLErrorException.java | 2 +- .../smack/sasl/SASLMechanism.java | 36 +-- .../smack/sasl/core/SASLXOauth2Mechanism.java | 8 +- .../smack/sasl/core/ScramHmac.java | 2 +- .../smack/sasl/core/ScramMechanism.java | 10 +- .../smack/sasl/core/ScramPlusMechanism.java | 2 +- .../smack/sasl/packet/SaslStreamElements.java | 6 +- .../util/ArrayBlockingQueueWithShutdown.java | 4 +- .../org/jivesoftware/smack/util/DNSUtil.java | 4 +- .../jivesoftware/smack/util/FileUtils.java | 2 +- .../smack/util/ObservableReader.java | 2 +- .../smack/util/ObservableWriter.java | 2 +- .../smack/util/PacketParserUtils.java | 30 +- .../jivesoftware/smack/util/ParserUtils.java | 2 +- .../smack/util/ReaderListener.java | 4 +- .../jivesoftware/smack/util/StringUtils.java | 2 +- .../org/jivesoftware/smack/util/TLSUtils.java | 8 +- .../smack/util/WriterListener.java | 4 +- .../smack/util/XmlStringBuilder.java | 6 +- .../smack/util/dns/HostAddress.java | 4 +- .../smack/util/dns/SRVRecord.java | 4 +- .../smack/util/stringencoder/Base32.java | 2 +- .../util/stringencoder/StringEncoder.java | 4 +- .../jivesoftware/smack/DummyConnection.java | 12 +- .../smack/StanzaCollectorTest.java | 2 +- .../smack/ThreadedDummyConnection.java | 2 +- .../smack/packet/IQResponseTest.java | 10 +- .../smack/packet/XMPPErrorTest.java | 70 ++--- .../smack/parsing/ParsingExceptionTest.java | 2 +- .../smack/util/PacketParserUtilsTest.java | 2 +- .../smackx/debugger/EnhancedDebugger.java | 4 +- .../debugger/EnhancedDebuggerWindow.java | 4 +- .../smackx/debugger/LiteDebugger.java | 12 +- .../experimental/ExperimentalInitializer.java | 2 +- .../smackx/carbons/CarbonManager.java | 34 +-- .../carbons/packet/CarbonExtension.java | 8 +- .../provider/CarbonManagerProvider.java | 2 +- .../chat_markers/ChatMarkersManager.java | 8 +- .../element/ChatMarkersElements.java | 18 +- .../chat_markers/element/package-info.java | 4 +- .../smackx/chat_markers/package-info.java | 4 +- .../provider/AcknowledgedProvider.java | 4 +- .../provider/DisplayedProvider.java | 4 +- .../provider/MarkableProvider.java | 4 +- .../provider/ReceivedProvider.java | 4 +- .../chat_markers/provider/package-info.java | 4 +- .../smackx/hints/element/NoCopyHint.java | 2 +- .../jivesoftware/smackx/hoxt/HOXTManager.java | 2 +- .../hoxt/packet/AbstractHttpOverXmpp.java | 2 +- .../smackx/hoxt/packet/HttpOverXmppReq.java | 10 +- .../smackx/hoxt/packet/HttpOverXmppResp.java | 4 +- .../AbstractHttpOverXmppProvider.java | 2 +- .../jivesoftware/smackx/iot/IoTException.java | 2 +- .../smackx/iot/control/IoTControlManager.java | 2 +- .../iot/control/element/IoTSetRequest.java | 2 +- .../smackx/iot/data/IoTDataManager.java | 2 +- .../iot/discovery/IoTClaimedException.java | 2 +- .../provisioning/IoTProvisioningManager.java | 4 +- .../jivesoftware/smackx/mam/MamManager.java | 38 +-- .../smackx/mam/element/MamElements.java | 18 +- .../smackx/mam/element/MamFinIQ.java | 12 +- .../smackx/mam/element/MamPrefsIQ.java | 12 +- .../smackx/mam/element/MamQueryIQ.java | 16 +- .../smackx/mam/element/package-info.java | 4 +- .../smackx/mam/filter/MamResultFilter.java | 4 +- .../smackx/mam/filter/package-info.java | 4 +- .../jivesoftware/smackx/mam/package-info.java | 4 +- .../smackx/mam/provider/MamFinIQProvider.java | 2 +- .../mam/provider/MamPrefsIQProvider.java | 4 +- .../mam/provider/MamQueryIQProvider.java | 4 +- .../mam/provider/MamResultProvider.java | 4 +- .../smackx/mam/provider/package-info.java | 4 +- .../message_markup/element/package-info.java | 4 +- .../smackx/message_markup/package-info.java | 4 +- .../message_markup/provider/package-info.java | 4 +- .../smackx/muclight/MUCLightAffiliation.java | 2 +- .../muclight/MUCLightRoomConfiguration.java | 10 +- .../smackx/muclight/MUCLightRoomInfo.java | 8 +- .../smackx/muclight/MultiUserChatLight.java | 32 +-- .../muclight/MultiUserChatLightManager.java | 24 +- .../element/MUCLightAffiliationsIQ.java | 8 +- .../muclight/element/MUCLightBlockingIQ.java | 8 +- .../element/MUCLightChangeAffiliationsIQ.java | 6 +- .../element/MUCLightConfigurationIQ.java | 8 +- .../muclight/element/MUCLightCreateIQ.java | 10 +- .../muclight/element/MUCLightDestroyIQ.java | 4 +- .../muclight/element/MUCLightElements.java | 38 +-- .../element/MUCLightGetAffiliationsIQ.java | 6 +- .../element/MUCLightGetConfigsIQ.java | 6 +- .../muclight/element/MUCLightGetInfoIQ.java | 6 +- .../muclight/element/MUCLightInfoIQ.java | 10 +- .../element/MUCLightSetConfigsIQ.java | 6 +- .../smackx/muclight/element/package-info.java | 4 +- .../smackx/muclight/package-info.java | 4 +- .../MUCLightAffiliationsChangeProvider.java | 2 +- .../MUCLightAffiliationsIQProvider.java | 2 +- .../provider/MUCLightBlockingIQProvider.java | 2 +- .../MUCLightConfigurationIQProvider.java | 2 +- .../MUCLightConfigurationsChangeProvider.java | 2 +- .../provider/MUCLightInfoIQProvider.java | 2 +- .../muclight/provider/package-info.java | 4 +- .../PushNotificationsManager.java | 12 +- .../element/DisablePushNotificationsIQ.java | 8 +- .../element/EnablePushNotificationsIQ.java | 10 +- .../element/PushNotificationsElements.java | 8 +- .../provider/RemoteDisablingProvider.java | 2 +- .../smackx/GroupChatInvitationTest.java | 4 +- .../smackx/MessageEventManagerTest.java | 12 +- .../smackx/RosterExchangeManagerTest.java | 10 +- .../smackx/ServiceDiscoveryManagerTest.java | 14 +- .../jivesoftware/smackx/XHTMLManagerTest.java | 8 +- .../bytestreams/ibb/InBandBytestreamTest.java | 10 +- .../socks5/Socks5ByteStreamTest.java | 14 +- .../smackx/muc/MultiUserChatTest.java | 48 ++-- .../smackx/packet/MessageEventTest.java | 8 +- .../smackx/packet/XHTMLExtensionTest.java | 2 +- .../smackx/pubsub/CarExtension.java | 4 +- .../smackx/pubsub/CarExtensionProvider.java | 2 +- .../smackx/pubsub/EntityUseCases.java | 4 +- .../pubsub/MultiUserSubscriptionUseCases.java | 2 +- .../smackx/pubsub/OwnerUseCases.java | 2 +- .../smackx/pubsub/PublisherUseCases.java | 14 +- .../smackx/pubsub/SubscriberUseCases.java | 14 +- .../jivesoftware/smackx/pubsub/TestAPI.java | 2 +- .../smackx/pubsub/TestEvents.java | 10 +- .../smackx/pubsub/TestMessageContent.java | 8 +- .../smackx/pubsub/test/PubSubTestCase.java | 2 +- .../pubsub/test/SingleUserTestCase.java | 2 +- .../extensions/ExtensionsInitializer.java | 2 +- .../smackx/address/MultipleRecipientInfo.java | 2 +- .../address/MultipleRecipientManager.java | 22 +- .../smackx/amp/AMPDeliverCondition.java | 8 +- .../smackx/amp/AMPExpireAtCondition.java | 8 +- .../jivesoftware/smackx/amp/AMPManager.java | 16 +- .../smackx/amp/AMPMatchResourceCondition.java | 8 +- .../amp/provider/AMPExtensionProvider.java | 4 +- .../attention/packet/AttentionExtension.java | 12 +- .../blocking/BlockingCommandManager.java | 12 +- .../blocking/element/BlockContactsIQ.java | 6 +- .../smackx/blocking/element/BlockListIQ.java | 6 +- .../element/BlockedErrorExtension.java | 4 +- .../blocking/element/UnblockContactsIQ.java | 8 +- .../smackx/blocking/element/package-info.java | 2 +- .../smackx/blocking/package-info.java | 2 +- .../provider/BlockContactsIQProvider.java | 2 +- .../provider/BlockListIQProvider.java | 2 +- .../BlockedErrorExtensionProvider.java | 2 +- .../provider/UnblockContactsIQProvider.java | 2 +- .../blocking/provider/package-info.java | 2 +- .../org/jivesoftware/smackx/bob/BoBData.java | 12 +- .../org/jivesoftware/smackx/bob/BoBHash.java | 16 +- .../jivesoftware/smackx/bob/BoBManager.java | 8 +- .../smackx/bob/element/BoBExtension.java | 8 +- .../smackx/bob/element/BoBIQ.java | 10 +- .../smackx/bob/element/package-info.java | 2 +- .../jivesoftware/smackx/bob/package-info.java | 2 +- .../smackx/bob/provider/BoBIQProvider.java | 2 +- .../smackx/bob/provider/package-info.java | 2 +- .../smackx/bookmarks/BookmarkManager.java | 28 +- .../bytestreams/BytestreamListener.java | 4 +- .../smackx/bytestreams/BytestreamManager.java | 14 +- .../smackx/bytestreams/BytestreamRequest.java | 16 +- .../smackx/bytestreams/BytestreamSession.java | 12 +- .../smackx/bytestreams/ibb/CloseListener.java | 4 +- .../smackx/bytestreams/ibb/DataListener.java | 4 +- .../ibb/InBandBytestreamListener.java | 4 +- .../ibb/InBandBytestreamManager.java | 68 ++--- .../ibb/InBandBytestreamRequest.java | 16 +- .../ibb/InBandBytestreamSession.java | 36 +-- .../bytestreams/ibb/InitiationListener.java | 4 +- .../smackx/bytestreams/ibb/packet/Close.java | 6 +- .../smackx/bytestreams/ibb/packet/Data.java | 6 +- .../ibb/packet/DataPacketExtension.java | 12 +- .../smackx/bytestreams/ibb/packet/Open.java | 12 +- .../ibb/provider/CloseIQProvider.java | 2 +- .../ibb/provider/DataPacketProvider.java | 2 +- .../ibb/provider/OpenIQProvider.java | 2 +- .../socks5/InitiationListener.java | 4 +- .../socks5/Socks5BytestreamListener.java | 4 +- .../socks5/Socks5BytestreamManager.java | 74 ++--- .../socks5/Socks5BytestreamRequest.java | 42 +-- .../socks5/Socks5BytestreamSession.java | 6 +- .../bytestreams/socks5/Socks5Client.java | 16 +- .../socks5/Socks5ClientForInitiator.java | 14 +- .../bytestreams/socks5/Socks5Proxy.java | 32 +-- .../bytestreams/socks5/Socks5Utils.java | 6 +- .../bytestreams/socks5/packet/Bytestream.java | 56 ++-- .../socks5/provider/BytestreamsProvider.java | 2 +- .../smackx/caps/EntityCapsManager.java | 48 ++-- .../caps/cache/EntityCapsPersistentCache.java | 2 +- .../cache/SimpleDirectoryPersistentCache.java | 18 +- .../smackx/commands/AdHocCommand.java | 64 ++--- .../smackx/commands/AdHocCommandManager.java | 40 +-- .../smackx/commands/AdHocCommandNote.java | 6 +- .../smackx/commands/LocalCommand.java | 16 +- .../smackx/commands/LocalCommandFactory.java | 10 +- .../smackx/commands/RemoteCommand.java | 8 +- .../commands/packet/AdHocCommandData.java | 2 +- .../provider/AdHocCommandDataProvider.java | 2 +- .../smackx/delay/packet/DelayInformation.java | 24 +- .../provider/DelayInformationProvider.java | 2 +- .../smackx/disco/NodeInformationProvider.java | 4 +- .../smackx/disco/ServiceDiscoveryManager.java | 166 +++++------ .../smackx/disco/packet/DiscoverInfo.java | 78 ++--- .../smackx/disco/packet/DiscoverItems.java | 74 ++--- .../filetransfer/FileTransferException.java | 6 +- .../filetransfer/FileTransferListener.java | 4 +- .../filetransfer/FileTransferManager.java | 16 +- .../filetransfer/FileTransferNegotiator.java | 16 +- .../filetransfer/FileTransferRequest.java | 28 +- .../filetransfer/IBBTransferNegotiator.java | 4 +- .../filetransfer/IncomingFileTransfer.java | 8 +- .../filetransfer/OutgoingFileTransfer.java | 2 +- .../Socks5TransferNegotiator.java | 2 +- .../smackx/filetransfer/StreamNegotiator.java | 8 +- .../smackx/forward/packet/Forwarded.java | 2 +- .../smackx/geoloc/GeoLocationManager.java | 12 +- .../smackx/geoloc/packet/GeoLocation.java | 2 +- .../smackx/iqlast/LastActivityManager.java | 36 +-- .../smackx/iqprivate/PrivateDataManager.java | 16 +- .../smackx/iqregister/AccountManager.java | 60 ++-- .../smackx/iqversion/VersionManager.java | 4 +- .../smackx/iqversion/packet/Version.java | 2 +- .../smackx/jingle/element/Jingle.java | 2 +- .../smackx/jingle/element/JingleAction.java | 4 +- .../smackx/jingle/element/JingleContent.java | 6 +- .../jiveproperties/JivePropertiesManager.java | 8 +- .../JivePropertiesExtensionProvider.java | 6 +- .../element/MessageCorrectExtension.java | 4 +- .../provider/MessageCorrectProvider.java | 2 +- .../muc/DefaultParticipantStatusListener.java | 2 +- .../smackx/muc/DefaultUserStatusListener.java | 2 +- .../smackx/muc/DiscussionHistory.java | 58 ++-- .../smackx/muc/InvitationListener.java | 6 +- .../muc/InvitationRejectionListener.java | 4 +- .../smackx/muc/MucConfigFormManager.java | 8 +- .../smackx/muc/MucEnterConfiguration.java | 22 +- .../smackx/muc/MultiUserChat.java | 272 +++++++++--------- .../smackx/muc/MultiUserChatException.java | 14 +- .../smackx/muc/MultiUserChatManager.java | 20 +- .../org/jivesoftware/smackx/muc/Occupant.java | 2 +- .../smackx/muc/ParticipantStatusListener.java | 94 +++--- .../org/jivesoftware/smackx/muc/RoomInfo.java | 4 +- .../smackx/muc/SubjectUpdatedListener.java | 4 +- .../smackx/muc/UserStatusListener.java | 70 ++--- .../smackx/muc/packet/Destroy.java | 6 +- .../muc/packet/GroupChatInvitation.java | 2 +- .../smackx/muc/packet/MUCAdmin.java | 12 +- .../smackx/muc/packet/MUCInitialPresence.java | 64 ++--- .../smackx/muc/packet/MUCItem.java | 14 +- .../smackx/muc/packet/MUCOwner.java | 14 +- .../smackx/muc/provider/MUCAdminProvider.java | 2 +- .../smackx/muc/provider/MUCOwnerProvider.java | 2 +- .../smackx/muc/provider/MUCUserProvider.java | 6 +- .../jivesoftware/smackx/nick/packet/Nick.java | 12 +- .../smackx/offline/OfflineMessageManager.java | 28 +- .../offline/packet/OfflineMessageInfo.java | 4 +- .../jivesoftware/smackx/pep/PEPListener.java | 2 +- .../jivesoftware/smackx/pep/PEPManager.java | 10 +- .../jivesoftware/smackx/ping/PingManager.java | 40 +-- .../jivesoftware/smackx/ping/packet/Ping.java | 2 +- .../smackx/privacy/PrivacyList.java | 4 +- .../smackx/privacy/PrivacyListListener.java | 4 +- .../smackx/privacy/PrivacyListManager.java | 206 ++++++------- .../smackx/privacy/packet/Privacy.java | 64 ++--- .../privacy/provider/PrivacyProvider.java | 8 +- .../smackx/pubsub/AccessModel.java | 2 +- .../smackx/pubsub/Affiliation.java | 12 +- .../smackx/pubsub/AffiliationsExtension.java | 2 +- .../pubsub/ChildrenAssociationPolicy.java | 2 +- .../smackx/pubsub/ConfigurationEvent.java | 4 +- .../smackx/pubsub/ConfigureForm.java | 128 ++++----- .../smackx/pubsub/ConfigureNodeFields.java | 66 ++--- .../pubsub/EmbeddedPacketExtension.java | 12 +- .../smackx/pubsub/EventElement.java | 4 +- .../smackx/pubsub/EventElementType.java | 2 +- .../jivesoftware/smackx/pubsub/FormNode.java | 12 +- .../smackx/pubsub/FormNodeType.java | 2 +- .../smackx/pubsub/GetItemsRequest.java | 2 +- .../org/jivesoftware/smackx/pubsub/Item.java | 12 +- .../smackx/pubsub/ItemDeleteEvent.java | 8 +- .../smackx/pubsub/ItemPublishEvent.java | 30 +- .../jivesoftware/smackx/pubsub/ItemReply.java | 2 +- .../smackx/pubsub/ItemsExtension.java | 32 +-- .../jivesoftware/smackx/pubsub/LeafNode.java | 146 +++++----- .../org/jivesoftware/smackx/pubsub/Node.java | 176 ++++++------ .../smackx/pubsub/NodeExtension.java | 12 +- .../jivesoftware/smackx/pubsub/NodeType.java | 2 +- .../smackx/pubsub/NotificationType.java | 2 +- .../smackx/pubsub/OptionsExtension.java | 4 +- .../smackx/pubsub/PayloadItem.java | 32 +-- .../smackx/pubsub/PresenceState.java | 4 +- .../smackx/pubsub/PubSubElementType.java | 2 +- .../smackx/pubsub/PubSubException.java | 6 +- .../smackx/pubsub/PubSubManager.java | 130 ++++----- .../smackx/pubsub/PublishItem.java | 6 +- .../smackx/pubsub/PublishModel.java | 4 +- .../smackx/pubsub/RetractItem.java | 4 +- .../smackx/pubsub/SimplePayload.java | 8 +- .../smackx/pubsub/SubscribeExtension.java | 2 +- .../smackx/pubsub/SubscribeForm.java | 34 +-- .../smackx/pubsub/SubscribeOptionFields.java | 16 +- .../smackx/pubsub/Subscription.java | 26 +- .../smackx/pubsub/SubscriptionEvent.java | 16 +- .../smackx/pubsub/SubscriptionsExtension.java | 10 +- .../smackx/pubsub/UnsubscribeExtension.java | 2 +- .../pubsub/listener/ItemDeleteListener.java | 12 +- .../pubsub/listener/ItemEventListener.java | 4 +- .../pubsub/listener/NodeConfigListener.java | 4 +- .../smackx/pubsub/packet/PubSub.java | 8 +- .../smackx/pubsub/packet/PubSubNamespace.java | 2 +- .../pubsub/provider/AffiliationProvider.java | 2 +- .../pubsub/provider/AffiliationsProvider.java | 2 +- .../pubsub/provider/ConfigEventProvider.java | 4 +- .../smackx/pubsub/provider/EventProvider.java | 4 +- .../pubsub/provider/FormNodeProvider.java | 2 +- .../smackx/pubsub/provider/ItemProvider.java | 2 +- .../smackx/pubsub/provider/ItemsProvider.java | 4 +- .../pubsub/provider/PubSubProvider.java | 2 +- .../pubsub/provider/RetractEventProvider.java | 4 +- .../pubsub/provider/SimpleNodeProvider.java | 2 +- .../pubsub/provider/SubscriptionProvider.java | 2 +- .../provider/SubscriptionsProvider.java | 2 +- .../smackx/pubsub/util/NodeUtils.java | 6 +- .../receipts/DeliveryReceiptManager.java | 18 +- .../receipts/ReceiptReceivedListener.java | 6 +- .../smackx/search/ReportedData.java | 12 +- .../smackx/search/UserSearch.java | 24 +- .../smackx/search/UserSearchManager.java | 24 +- .../sharedgroups/SharedGroupManager.java | 8 +- .../smackx/shim/packet/HeadersExtension.java | 4 +- .../smackx/shim/provider/HeaderProvider.java | 2 +- .../smackx/shim/provider/HeadersProvider.java | 2 +- .../si/provider/StreamInitiationProvider.java | 4 +- .../smackx/vcardtemp/VCardManager.java | 38 +-- .../smackx/vcardtemp/packet/VCard.java | 18 +- .../org/jivesoftware/smackx/xdata/Form.java | 144 +++++----- .../jivesoftware/smackx/xdata/FormField.java | 4 +- .../smackx/xdata/XDataManager.java | 2 +- .../smackx/xdata/packet/DataForm.java | 52 ++-- .../xdata/provider/DataFormProvider.java | 2 +- .../smackx/xdatalayout/packet/DataLayout.java | 16 +- .../ValidationConsistencyException.java | 2 +- .../packet/ValidateElement.java | 32 +-- .../smackx/xhtmlim/XHTMLManager.java | 22 +- .../smackx/xhtmlim/XHTMLText.java | 44 +-- .../smackx/xhtmlim/packet/XHTMLExtension.java | 8 +- .../bytestreams/ibb/CloseListenerTest.java | 4 +- .../bytestreams/ibb/DataListenerTest.java | 4 +- .../bytestreams/ibb/IBBPacketUtils.java | 6 +- .../ibb/InBandBytestreamManagerTest.java | 14 +- .../ibb/InBandBytestreamRequestTest.java | 8 +- .../InBandBytestreamSessionMessageTest.java | 24 +- .../ibb/InBandBytestreamSessionTest.java | 38 +-- .../ibb/InitiationListenerTest.java | 18 +- .../bytestreams/ibb/packet/CloseTest.java | 2 +- .../ibb/packet/DataPacketExtensionTest.java | 2 +- .../bytestreams/ibb/packet/DataTest.java | 2 +- .../bytestreams/ibb/packet/OpenTest.java | 2 +- .../ibb/provider/OpenIQProviderTest.java | 2 +- .../socks5/InitiationListenerTest.java | 16 +- .../socks5/Socks5ByteStreamManagerTest.java | 20 +- .../socks5/Socks5ByteStreamRequestTest.java | 20 +- .../socks5/Socks5ClientForInitiatorTest.java | 16 +- .../bytestreams/socks5/Socks5ClientTest.java | 14 +- .../bytestreams/socks5/Socks5PacketUtils.java | 12 +- .../bytestreams/socks5/Socks5TestProxy.java | 16 +- .../smackx/caps/EntityCapsManagerTest.java | 2 +- .../delay/provider/DelayInformationTest.java | 4 +- .../smackx/geoloc/packet/GeoLocationTest.java | 4 +- .../provider/GeoLocationProviderTest.java | 10 +- .../jivesoftware/smackx/ping/PingTest.java | 32 +-- .../smackx/pubsub/ItemValidationTest.java | 24 +- .../pubsub/provider/PubSubProviderTest.java | 6 +- .../shim/provider/HeadersProviderTest.java | 4 +- .../xdatalayout/packet/DataLayoutTest.java | 2 +- .../provider/DataValidationTest.java | 4 +- .../jivesoftware/util/ConnectionUtils.java | 12 +- .../java/org/jivesoftware/util/Protocol.java | 20 +- .../org/jivesoftware/util/Verification.java | 6 +- .../org/jivesoftware/smack/chat/Chat.java | 10 +- .../jivesoftware/smack/chat/ChatManager.java | 20 +- .../org/jivesoftware/smack/roster/Roster.java | 22 +- .../smack/roster/RosterEntry.java | 12 +- .../smack/roster/RosterGroup.java | 30 +- .../smack/roster/RosterListener.java | 2 +- .../smack/roster/packet/RosterPacket.java | 4 +- .../smack/roster/RosterOfflineTest.java | 2 +- .../jivesoftware/smack/roster/RosterTest.java | 30 +- .../smack/roster/RosterVersioningTest.java | 10 +- .../roster/SubscriptionPreApprovalTest.java | 6 +- .../inttest/TestNotPossibleException.java | 2 +- .../java/org/jivesoftware/smack/ChatTest.java | 24 +- .../smack/LoginIntegrationTest.java | 12 +- .../smackx/caps/EntityCapsTest.java | 10 +- .../smackx/iot/IoTControlIntegrationTest.java | 4 +- .../smackx/iot/IoTDataIntegrationTest.java | 4 +- .../jivesoftware/smackx/mam/package-info.java | 4 +- .../smackx/omemo/OmemoInitializationTest.java | 2 +- .../smackx/omemo/OmemoMessageSendingTest.java | 2 +- .../smackx/omemo/package-info.java | 2 +- .../jivesoftware/smackx/xdata/FormTest.java | 6 +- .../inttest/util/ResultSyncPointTest.java | 2 +- .../java7/Java7Base64UrlSafeEncoder.java | 6 +- .../smackx/jingle/PayloadTypeTest.java | 4 +- .../smackx/jingle/nat/BasicResolverTest.java | 4 +- .../jingle/provider/JingleProviderTest.java | 2 +- .../smackx/jingleold/ContentNegotiator.java | 16 +- .../smackx/jingleold/JingleActionEnum.java | 4 +- .../smackx/jingleold/JingleManager.java | 8 +- .../smackx/jingleold/JingleNegotiator.java | 12 +- .../jingleold/JingleNegotiatorState.java | 2 +- .../smackx/jingleold/JingleSession.java | 90 +++--- .../jingleold/JingleSessionRequest.java | 4 +- .../smackx/jingleold/JingleSessionState.java | 6 +- .../jingleold/JingleSessionStateActive.java | 2 +- .../jingleold/JingleSessionStateEnded.java | 2 +- .../jingleold/JingleSessionStatePending.java | 2 +- .../jingleold/JingleSessionStateUnknown.java | 8 +- .../CreatedJingleSessionListener.java | 2 +- .../jingleold/listeners/JingleListener.java | 2 +- .../listeners/JingleMediaListener.java | 4 +- .../listeners/JingleSessionListener.java | 4 +- .../listeners/JingleTransportListener.java | 6 +- .../jingleold/media/JingleMediaManager.java | 2 +- .../jingleold/media/MediaNegotiator.java | 40 +-- .../sshare/api/OctTreeQuantizer.java | 2 +- .../mediaimpl/sshare/api/Quantizer.java | 4 +- .../smackx/jingleold/nat/BasicResolver.java | 4 +- .../jingleold/nat/BasicTransportManager.java | 2 +- .../smackx/jingleold/nat/BridgedResolver.java | 4 +- .../smackx/jingleold/nat/FixedResolver.java | 4 +- .../jingleold/nat/FixedTransportManager.java | 2 +- .../smackx/jingleold/nat/ICEResolver.java | 4 +- .../jingleold/nat/JingleTransportManager.java | 4 +- .../smackx/jingleold/nat/RTPBridge.java | 20 +- .../smackx/jingleold/nat/STUN.java | 10 +- .../smackx/jingleold/nat/STUNResolver.java | 4 +- .../jingleold/nat/TransportCandidate.java | 4 +- .../jingleold/nat/TransportNegotiator.java | 24 +- .../jingleold/nat/TransportResolver.java | 16 +- .../nat/TransportResolverListener.java | 4 +- .../jingleold/packet/JingleContent.java | 22 +- .../JingleContentDescriptionProvider.java | 6 +- .../provider/JingleContentProvider.java | 2 +- .../provider/JingleDescriptionProvider.java | 12 +- .../jingleold/provider/JingleProvider.java | 4 +- .../provider/JingleTransportProvider.java | 6 +- .../smackx/workgroup/QueueUser.java | 2 +- .../smackx/workgroup/agent/Agent.java | 16 +- .../smackx/workgroup/agent/AgentRoster.java | 8 +- .../smackx/workgroup/agent/AgentSession.java | 126 ++++---- .../smackx/workgroup/agent/Offer.java | 8 +- .../workgroup/agent/TranscriptManager.java | 14 +- .../agent/TranscriptSearchManager.java | 16 +- .../workgroup/packet/MetaDataProvider.java | 4 +- .../workgroup/packet/QueueOverview.java | 2 +- .../workgroup/packet/RoomInvitation.java | 6 +- .../smackx/workgroup/packet/Transcript.java | 2 +- .../smackx/workgroup/packet/Transcripts.java | 2 +- .../packet/WorkgroupInformation.java | 4 +- .../smackx/workgroup/user/Workgroup.java | 82 +++--- .../DefaultMessageEventRequestListener.java | 4 +- .../smackx/xevent/MessageEventManager.java | 32 +-- .../MessageEventNotificationListener.java | 14 +- .../xevent/MessageEventRequestListener.java | 24 +- .../smackx/xevent/packet/MessageEvent.java | 88 +++--- .../xevent/provider/MessageEventProvider.java | 4 +- .../xroster/RosterExchangeListener.java | 4 +- .../smackx/xroster/RosterExchangeManager.java | 26 +- .../smackx/xroster/packet/RosterExchange.java | 28 +- .../provider/RosterExchangeProvider.java | 4 +- .../smackx/omemo/OmemoService.java | 6 +- .../MultipleCryptoFailedException.java | 2 +- .../smackx/omemo/exceptions/package-info.java | 2 +- .../smackx/omemo/package-info.java | 2 +- .../smack/util/dns/javax/JavaxResolver.java | 2 +- .../sasl/javax/SASLExternalMechanism.java | 2 +- .../sasl/provided/SASLExternalMechanism.java | 2 +- .../org/jivesoftware/smack/sm/SMUtils.java | 4 +- .../smack/sm/StreamManagementException.java | 6 +- .../smack/tcp/XMPPTCPConnection.java | 86 +++--- .../smack/tcp/PacketWriterTest.java | 6 +- 545 files changed, 3713 insertions(+), 3715 deletions(-) diff --git a/config/checkstyle.xml b/config/checkstyle.xml index bf564dd63..a05c12726 100644 --- a/config/checkstyle.xml +++ b/config/checkstyle.xml @@ -44,21 +44,19 @@ - + + + + diff --git a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/BOSHConfiguration.java b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/BOSHConfiguration.java index 252a49a43..a83819ad2 100644 --- a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/BOSHConfiguration.java +++ b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/BOSHConfiguration.java @@ -26,7 +26,7 @@ import org.jivesoftware.smack.proxy.ProxyInfo; /** * Configuration to use while establishing the connection to the XMPP server via * HTTP binding. - * + * * @see XMPPBOSHConnection * @author Guenther Niess */ diff --git a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java index 5cab26ccb..907d7be6f 100644 --- a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java +++ b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java @@ -64,7 +64,7 @@ import org.xmlpull.v1.XmlPullParserFactory; /** * Creates a connection to an XMPP server via HTTP binding. * This is specified in the XEP-0206: XMPP Over BOSH. - * + * * @see XMPPConnection * @author Guenther Niess */ @@ -109,7 +109,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { /** * Create a HTTP Binding connection to an XMPP server. - * + * * @param username the username to use. * @param password the password to use. * @param https true if you want to use SSL @@ -131,7 +131,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { /** * Create a HTTP Binding connection to an XMPP server. - * + * * @param config The configuration which is used for this connection. */ public XMPPBOSHConnection(BOSHConfiguration config) { @@ -191,7 +191,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { // If there is no feedback, throw an remote server timeout error if (!connected && !done) { done = true; - String errorMessage = "Timeout reached for the connection to " + String errorMessage = "Timeout reached for the connection to " + getHost() + ":" + getPort() + "."; throw new SmackException(errorMessage); } @@ -246,7 +246,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { } /** - * Closes the connection by setting presence to unavailable and closing the + * Closes the connection by setting presence to unavailable and closing the * HTTP client. The shutdown logic will be used during a planned disconnection or when * dealing with an unexpected disconnection. Unlike {@link #disconnect()} the connection's * BOSH stanza reader will not be removed; thus connection's state is kept. @@ -289,7 +289,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { /** * Send a HTTP request to the connection manager with the provided body element. - * + * * @param body the body which will be sent. * @throws BOSHException */ @@ -405,7 +405,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection { /** * A listener class which listen for a successfully established connection * and connection errors and notifies the BOSHConnection. - * + * * @author Guenther Niess */ private class BOSHConnectionListener implements BOSHClientConnListener { diff --git a/smack-compression-jzlib/src/main/java/org/jivesoftware/smack/compression/jzlib/JzlibInputOutputStream.java b/smack-compression-jzlib/src/main/java/org/jivesoftware/smack/compression/jzlib/JzlibInputOutputStream.java index f129dc991..ae231d5f5 100644 --- a/smack-compression-jzlib/src/main/java/org/jivesoftware/smack/compression/jzlib/JzlibInputOutputStream.java +++ b/smack-compression-jzlib/src/main/java/org/jivesoftware/smack/compression/jzlib/JzlibInputOutputStream.java @@ -28,10 +28,10 @@ import com.jcraft.jzlib.InflaterInputStream; /** * This class provides XMPP "zlib" compression with the help of JZLib. - * + * * @author Florian Schmaus * @see JZLib - * + * */ public class JzlibInputOutputStream extends XMPPInputOutputStream { diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java index acdc89e42..1463c0fd4 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/IQTest.java @@ -72,7 +72,7 @@ public class IQTest extends SmackTestCase { /** * Check that sending an IQ to a full JID that is offline returns an IQ ERROR instead - * of being route to some other resource of the same user. + * of being route to some other resource of the same user. */ public void testFullJIDToOfflineUser() { // Request the version from the server. diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/LoginTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/LoginTest.java index 7adc45407..07fccf8af 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/LoginTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/LoginTest.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.test.SmackTestCase; import org.jivesoftware.smack.util.StringUtils; /** - * Includes set of login tests. + * Includes set of login tests. * * @author Gaston Dombiak */ diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/MessageTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/MessageTest.java index 39406c92d..b483f9ef7 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/MessageTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/MessageTest.java @@ -213,7 +213,7 @@ public class MessageTest extends SmackTestCase { StanzaCollector collector = getConnection(0).createStanzaCollector(new MessageTypeFilter(Message.Type.chat)); StanzaCollector coll3 = conn3.createStanzaCollector(new MessageTypeFilter(Message.Type.chat)); - // User1 sends a message to the bare JID of User0 + // User1 sends a message to the bare JID of User0 Chat chat = getConnection(1).getChatManager().createChat(getBareJID(0), null); chat.sendMessage("Test 1"); chat.sendMessage("Test 2"); @@ -325,7 +325,7 @@ public class MessageTest extends SmackTestCase { StanzaCollector coll3 = conn3.createStanzaCollector(new MessageTypeFilter(Message.Type.chat)); StanzaCollector coll4 = conn4.createStanzaCollector(new MessageTypeFilter(Message.Type.chat)); - // Send a message from this resource to indicate most recent activity + // Send a message from this resource to indicate most recent activity conn3.sendStanza(new Message("admin@" + getXMPPServiceDomain())); // User1 sends a message to the bare JID of User0 diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/PrivacyClient.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/PrivacyClient.java index b9c3dd3cd..944d59c66 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/PrivacyClient.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/PrivacyClient.java @@ -22,7 +22,7 @@ import org.jivesoftware.smack.packet.PrivacyItem; /** * This class supports automated tests about privacy communication from the * server to the client. - * + * * @author Francisco Vives */ diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/ReconnectionTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/ReconnectionTest.java index f9afcf967..5cc438c33 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/ReconnectionTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/ReconnectionTest.java @@ -208,7 +208,7 @@ public class ReconnectionTest extends SmackTestCase { private CountDownLatch countDownLatch; private XMPPTCPConnectionTestListener(CountDownLatch latch) { - countDownLatch = latch; + countDownLatch = latch; } private XMPPTCPConnectionTestListener() { diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterInitializedBeforeConnectTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterInitializedBeforeConnectTest.java index 2549e5fba..4078dc2a3 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterInitializedBeforeConnectTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterInitializedBeforeConnectTest.java @@ -17,7 +17,7 @@ package org.jivesoftware.smack; /** * Run all tests defined in RosterTest but initialize the roster before connection is logged in and * authenticated. - * + * * @author Henning Staib */ public class RosterInitializedBeforeConnectTest extends RosterSmackTest { diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterListenerTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterListenerTest.java index 62deaeb37..081b15f34 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterListenerTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterListenerTest.java @@ -24,7 +24,7 @@ import org.jivesoftware.smack.test.SmackTestCase; /** * Test cases for adding the {@link RosterListener} in different connection states. - * + * * @author Henning Staib */ public class RosterListenerTest extends SmackTestCase { diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterSmackTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterSmackTest.java index 72353377b..50584edd1 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterSmackTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/RosterSmackTest.java @@ -78,7 +78,7 @@ public class RosterSmackTest extends SmackTestCase { @Override public void entriesAdded(Collection addresses) {} - }; + }; roster.addRosterListener(latchCounter); @@ -422,7 +422,7 @@ public class RosterSmackTest extends SmackTestCase { /** * Test presence management.

- * + * * 1. Log in user0 from a client and user1 from 2 clients * 2. Create presence subscription of type BOTH between 2 users * 3. Check that presence is correctly delivered to both users @@ -699,12 +699,12 @@ public class RosterSmackTest extends SmackTestCase { public void entriesUpdated(Collection addresses) {} @Override - public void entriesDeleted(Collection addresses) { + public void entriesDeleted(Collection addresses) { latch.countDown(); } @Override public void entriesAdded(Collection addresses) {} - }; + }; } diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyProviderTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyProviderTest.java index 8726c86fd..e9261f516 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyProviderTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyProviderTest.java @@ -22,9 +22,9 @@ import org.xmlpull.v1.XmlPullParserException; import java.io.StringReader; -/** +/** * Test the PrivacyProvider class with valids privacy xmls - * + * * @author Francisco Vives */ public class PrivacyProviderTest extends SmackTestCase { @@ -47,7 +47,7 @@ public class PrivacyProviderTest extends SmackTestCase { } /** - * Check the parser with an xml with all kind of stanzas. + * Check the parser with an xml with all kind of stanzas. * To create the xml string based from an xml file, replace:\n with: "\n + " */ public void testFull() { @@ -296,7 +296,7 @@ public class PrivacyProviderTest extends SmackTestCase { /** - * Check the parser with an xml with empty lists. It includes the active, + * Check the parser with an xml with empty lists. It includes the active, * default and special list. * To create the xml string based from an xml file, replace:\n with: "\n + " */ @@ -338,7 +338,7 @@ public class PrivacyProviderTest extends SmackTestCase { } /** - * Check the parser with an xml with empty lists. It includes the active, + * Check the parser with an xml with empty lists. It includes the active, * default and special list. * To create the xml string based from an xml file, replace:\n with: "\n + " */ diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyTest.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyTest.java index 26af1df83..8268d5dbe 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyTest.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/packet/PrivacyTest.java @@ -452,7 +452,7 @@ public class PrivacyTest extends SmackTestCase { // Look for the same server and original items receivedItem = privacyItems.get(j); index = 0; - while ((index < originalPrivacyItems.length) + while ((index < originalPrivacyItems.length) && (originalPrivacyItems[index].getOrder() != receivedItem.getOrder())) { index++; } @@ -484,7 +484,7 @@ public class PrivacyTest extends SmackTestCase { /** * This class supports automated tests about privacy communication from the * server to the client. - * + * * @author Francisco Vives */ diff --git a/smack-core/src/integration-test/java/org/jivesoftware/smack/test/SmackTestCase.java b/smack-core/src/integration-test/java/org/jivesoftware/smack/test/SmackTestCase.java index dd41af624..e44c6e15a 100644 --- a/smack-core/src/integration-test/java/org/jivesoftware/smack/test/SmackTestCase.java +++ b/smack-core/src/integration-test/java/org/jivesoftware/smack/test/SmackTestCase.java @@ -36,17 +36,17 @@ import org.xmlpull.v1.XmlPullParserFactory; import org.xmlpull.v1.XmlPullParser; /** - * Base class for all the test cases which provides a pre-configured execution context. This - * means that any test case that subclassifies this base class will have access to a pool of + * Base class for all the test cases which provides a pre-configured execution context. This + * means that any test case that subclassifies this base class will have access to a pool of * connections and to the user of each connection. The maximum number of connections in the pool - * can be controlled by the message {@link #getMaxConnections()} which every subclass must - * implement.

- * - * This base class defines a default execution context (i.e. host, port, chat domain and muc + * can be controlled by the message {@link #getMaxConnections()} which every subclass must + * implement.

+ * + * This base class defines a default execution context (i.e. host, port, chat domain and muc * domain) which can be found in the file "config/test-case.xml". However, each subclass could * redefine the default configuration by providing its own configuration file (if desired). The * name of the configuration file must be of the form .xml (e.g. RosterTest.xml). - * The file must be placed in the folder "config". This folder is where the default configuration + * The file must be placed in the folder "config". This folder is where the default configuration * file is being held. * * @author Gaston Dombiak @@ -81,21 +81,21 @@ public abstract class SmackTestCase extends TestCase { } /** - * Returns the maximum number of connections to initialize for this test case. All the - * initialized connections will be connected to the server using a new test account for - * each conection. - * + * Returns the maximum number of connections to initialize for this test case. All the + * initialized connections will be connected to the server using a new test account for + * each conection. + * * @return the maximum number of connections to initialize for this test case. */ protected abstract int getMaxConnections(); /** - * Returns a SocketFactory that will be used to create the socket to the XMPP server. By + * Returns a SocketFactory that will be used to create the socket to the XMPP server. By * default no SocketFactory is used but subclasses my want to redefine this method.

- * - * A custom SocketFactory allows fine-grained control of the actual connection to the XMPP + * + * A custom SocketFactory allows fine-grained control of the actual connection to the XMPP * server. A typical use for a custom SocketFactory is when connecting through a SOCKS proxy. - * + * * @return a SocketFactory that will be used to create the socket to the XMPP server. */ protected SocketFactory getSocketFactory() { @@ -111,7 +111,7 @@ public abstract class SmackTestCase extends TestCase { *

* Connections are connected by default. * Overwrite this method if the test case needs unconnected connections. - * + * * @return true if connections should NOT be connected automatically, * false if connections should be connected automatically. */ @@ -123,11 +123,11 @@ public abstract class SmackTestCase extends TestCase { * Returns the XMPPTCPConnection located at the requested position. Each test case holds a * pool of connections which is initialized while setting up the test case. The maximum * number of connections is controlled by the message {@link #getMaxConnections()} which - * every subclass must implement.

- * - * If the requested position is greater than the connections size then an - * IllegalArgumentException will be thrown. - * + * every subclass must implement.

+ * + * If the requested position is greater than the connections size then an + * IllegalArgumentException will be thrown. + * * @param index the position in the pool of the connection to look for. * @return the XMPPTCPConnection located at the requested position. */ @@ -156,9 +156,9 @@ public abstract class SmackTestCase extends TestCase { } /** - * Returns the name of the user (e.g. johndoe) that is using the connection + * Returns the name of the user (e.g. johndoe) that is using the connection * located at the requested position. - * + * * @param index the position in the pool of the connection to look for. * @return the user of the user (e.g. johndoe). */ @@ -167,9 +167,9 @@ public abstract class SmackTestCase extends TestCase { } /** - * Returns the password of the user (e.g. johndoe) that is using the connection + * Returns the password of the user (e.g. johndoe) that is using the connection * located at the requested position. - * + * * @param index the position in the pool of the connection to look for. * @return the password of the user (e.g. johndoe). */ @@ -180,7 +180,7 @@ public abstract class SmackTestCase extends TestCase { /** * Returns the bare XMPP address of the user (e.g. johndoe@jabber.org) that is * using the connection located at the requested position. - * + * * @param index the position in the pool of the connection to look for. * @return the bare XMPP address of the user (e.g. johndoe@jabber.org). */ @@ -191,7 +191,7 @@ public abstract class SmackTestCase extends TestCase { /** * Returns the full XMPP address of the user (e.g. johndoe@jabber.org/Smack) that is * using the connection located at the requested position. - * + * * @param index the position in the pool of the connection to look for. * @return the full XMPP address of the user (e.g. johndoe@jabber.org/Smack). */ @@ -213,7 +213,7 @@ public abstract class SmackTestCase extends TestCase { /** * Returns the default groupchat service domain. - * + * * @return the default groupchat service domain. */ protected String getChatDomain() { @@ -222,7 +222,7 @@ public abstract class SmackTestCase extends TestCase { /** * Returns the default MUC service domain. - * + * * @return the default MUC service domain. */ protected String getMUCDomain() { @@ -273,7 +273,7 @@ public abstract class SmackTestCase extends TestCase { if (!getConnection(0).getAccountManager().supportsAccountCreation()) fail("Server does not support account creation"); - // Create the account and try logging in again as the + // Create the account and try logging in again as the // same user. try { createAccount(i, currentUser, currentPassword); @@ -345,7 +345,7 @@ public abstract class SmackTestCase extends TestCase { con.login(getUsername(i), getUsername(i)); } else if (!getConnection(i).isAuthenticated()) { - getConnection(i).login(getUsername(i), getUsername(i)); + getConnection(i).login(getUsername(i), getUsername(i)); } // Delete the created account for the test getConnection(i).getAccountManager().deleteAccount(); @@ -366,22 +366,22 @@ public abstract class SmackTestCase extends TestCase { } /** - * Initializes the context of the test case. We will first try to load the configuration from - * a file whose name is conformed by the test case class name plus an .xml extension - * (e.g RosterTest.xml). If no file was found under that name then we will try to load the + * Initializes the context of the test case. We will first try to load the configuration from + * a file whose name is conformed by the test case class name plus an .xml extension + * (e.g RosterTest.xml). If no file was found under that name then we will try to load the * default configuration for all the test cases from the file "config/test-case.xml". * */ private void init() { try { boolean found = false; - // Try to load the configutation from an XML file specific for this test case + // Try to load the configutation from an XML file specific for this test case Enumeration resources = ClassLoader.getSystemClassLoader().getResources(getConfigurationFilename()); while (resources.hasMoreElements()) { found = parseURL(resources.nextElement()); } - // If none was found then try to load the configuration from the default configuration + // If none was found then try to load the configuration from the default configuration // file (i.e. "config/test-case.xml") if (!found) { resources = ClassLoader.getSystemClassLoader().getResources("config/test-case.xml"); @@ -401,8 +401,8 @@ public abstract class SmackTestCase extends TestCase { /** * Returns true if the given URL was found and parsed without problems. The file provided * by the URL must contain information useful for the test case configuration, such us, - * host and port of the server. - * + * host and port of the server. + * * @param url the url of the file to parse. * @return true if the given URL was found and parsed without problems. */ @@ -487,11 +487,11 @@ public abstract class SmackTestCase extends TestCase { } /** - * Returns the name of the configuration file related to this test case. By default all + * Returns the name of the configuration file related to this test case. By default all * the test cases will use the same configuration file. However, it's possible to override the * default configuration by providing a file of the form .xml * (e.g. RosterTest.xml). - * + * * @return the name of the configuration file related to this test case. */ private String getConfigurationFilename() { @@ -502,7 +502,7 @@ public abstract class SmackTestCase extends TestCase { /** * Subscribes all connections with each other: They all become friends - * + * * @throws XMPPException */ protected void letsAllBeFriends() throws XMPPException { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionListener.java b/smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionListener.java index f593a4ce3..19847598c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionListener.java @@ -21,7 +21,7 @@ package org.jivesoftware.smack; * methods defined by the {@link ConnectionListener} interface. This is a * convenience class which should be used in case you do not need to implement * all methods. - * + * * @author Henning Staib */ public class AbstractConnectionListener implements ConnectionListener { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java index 9e8ba53ff..ad576d00b 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java @@ -100,7 +100,7 @@ import org.xmlpull.v1.XmlPullParser; public abstract class AbstractXMPPConnection implements XMPPConnection { private static final Logger LOGGER = Logger.getLogger(AbstractXMPPConnection.class.getName()); - /** + /** * Counter to uniquely identify connections that are created. */ private static final AtomicInteger connectionCounter = new AtomicInteger(0); @@ -293,7 +293,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Create a new XMPPConnection to an XMPP server. - * + * * @param configuration The configuration which is used to establish the connection. */ protected AbstractXMPPConnection(ConnectionConfiguration configuration) { @@ -355,12 +355,12 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { *

* Listeners will be preserved from a previous connection. *

- * + * * @throws XMPPException if an error occurs on the XMPP protocol level. * @throws SmackException if an error occurs somewhere else besides XMPP protocol level. - * @throws IOException + * @throws IOException * @return a reference to this object, to chain connect() with login(). - * @throws InterruptedException + * @throws InterruptedException */ public synchronized AbstractXMPPConnection connect() throws SmackException, IOException, XMPPException, InterruptedException { // Check if not already connected @@ -395,11 +395,11 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * Abstract method that concrete subclasses of XMPPConnection need to implement to perform their * way of XMPP connection establishment. Implementations are required to perform an automatic * login if the previous connection state was logged (authenticated). - * + * * @throws SmackException * @throws IOException * @throws XMPPException - * @throws InterruptedException + * @throws InterruptedException */ protected abstract void connectInternal() throws SmackException, IOException, XMPPException, InterruptedException; @@ -412,7 +412,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Logs in to the server using the strongest SASL mechanism supported by - * the server. If more than the connection's default stanza timeout elapses in each step of the + * the server. If more than the connection's default stanza timeout elapses in each step of the * authentication process without a response from the server, a * {@link SmackException.NoResponseException} will be thrown. *

@@ -427,11 +427,11 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * {@link ConnectionConfiguration.Builder#setCallbackHandler(javax.security.auth.callback.CallbackHandler)}. * For more advanced login settings see {@link ConnectionConfiguration}. *

- * + * * @throws XMPPException if an error occurs on the XMPP protocol level. * @throws SmackException if an error occurs somewhere else besides XMPP protocol level. * @throws IOException if an I/O error occurs during login. - * @throws InterruptedException + * @throws InterruptedException */ public synchronized void login() throws XMPPException, SmackException, IOException, InterruptedException { // The previously used username, password and resource take over precedence over the @@ -445,13 +445,13 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Same as {@link #login(CharSequence, String, Resourcepart)}, but takes the resource from the connection * configuration. - * + * * @param username * @param password * @throws XMPPException * @throws SmackException * @throws IOException - * @throws InterruptedException + * @throws InterruptedException * @see #login */ public synchronized void login(CharSequence username, String password) throws XMPPException, SmackException, @@ -462,14 +462,14 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Login with the given username (authorization identity). You may omit the password if a callback handler is used. * If resource is null, then the server will generate one. - * + * * @param username * @param password * @param resource * @throws XMPPException * @throws SmackException * @throws IOException - * @throws InterruptedException + * @throws InterruptedException * @see #login */ public synchronized void login(CharSequence username, String password, Resourcepart resource) throws XMPPException, @@ -580,7 +580,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * Get the name of the SASL mechanism that was used to authenticate this connection. This returns the name of * mechanism which was used the last time this connection was authenticated, and will return null if * this connection was not authenticated before. - * + * * @return the name of the used SASL mechanism. * @since 4.2 */ @@ -674,7 +674,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Returns the SASLAuthentication manager that is responsible for authenticating with * the server. - * + * * @return the SASLAuthentication manager that is responsible for authenticating with * the server. */ @@ -708,9 +708,9 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * information such as "On vacation". Typically, just the status text of the presence * stanza is set with online information, but most XMPP servers will deliver the full * presence stanza with whatever data is set. - * + * * @param unavailablePresence the optional presence stanza to send during shutdown. - * @throws NotConnectedException + * @throws NotConnectedException */ public synchronized void disconnect(Presence unavailablePresence) throws NotConnectedException { if (unavailablePresence != null) { @@ -871,7 +871,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { *

* Compared to {@link #firePacketInterceptors(Stanza)}, the listeners will be invoked in a new thread. *

- * + * * @param packet the stanza to process. */ @SuppressWarnings("javadoc") @@ -946,7 +946,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { * Since the thread that requested to send the stanza will invoke all interceptors, it * is important that interceptors perform their work as soon as possible so that the * thread does not remain blocked for a long period. - * + * * @param packet the stanza that is going to be sent to the server */ private void firePacketInterceptors(Stanza packet) { @@ -970,7 +970,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Initialize the {@link #debugger}. You can specify a customized {@link SmackDebugger} * by setup the system property smack.debuggerClass to the implementation. - * + * * @throws IllegalStateException if the reader or writer isn't yet initialized. * @throws IllegalArgumentException if the SmackDebugger can't be loaded. */ @@ -1208,7 +1208,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Sets whether the connection has already logged in the server. This method assures that the * {@link #wasAuthenticated} flag is never reset once it has ever been set. - * + * */ protected void setWasAuthenticated() { // Never reset the flag if the connection has ever been authenticated @@ -1284,7 +1284,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Create a class which associates a stanza filter with a listener. - * + * * @param packetListener the stanza listener. * @param packetFilter the associated filter or null if it listen for all packets. */ @@ -1312,7 +1312,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Create a class which associates a stanza filter with an interceptor. - * + * * @param packetInterceptor the interceptor. * @param packetFilter the associated filter or null if it intercepts all packets. */ @@ -1681,7 +1681,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a * stanza. - * + * * @param callback the callback to install */ public void setParsingExceptionCallback(ParsingExceptionCallback callback) { @@ -1690,7 +1690,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection { /** * Get the current active parsing exception callback. - * + * * @return the active exception callback or null if there is none */ public ParsingExceptionCallback getParsingExceptionCallback() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java index 916804f02..c16e5624c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java @@ -107,12 +107,12 @@ public abstract class ConnectionConfiguration { private final X509TrustManager customX509TrustManager; /** - * + * */ private final String[] enabledSSLProtocols; /** - * + * */ private final String[] enabledSSLCiphers; @@ -210,7 +210,7 @@ public abstract class ConnectionConfiguration { } /** - * Retuns the path to the keystore file. The key store file contains the + * Retuns the path to the keystore file. The key store file contains the * certificates that may be used to authenticate the client to the server, * in the event the server requests or requires it. * @@ -271,7 +271,7 @@ public abstract class ConnectionConfiguration { * Returns the configured HostnameVerifier of this ConnectionConfiguration or the Smack default * HostnameVerifier configured with * {@link SmackConfiguration#setDefaultHostnameVerifier(HostnameVerifier)}. - * + * * @return a configured HostnameVerifier or null */ public HostnameVerifier getHostnameVerifier() { @@ -305,7 +305,7 @@ public abstract class ConnectionConfiguration { /** * Returns the socket factory used to create new xmppConnection sockets. * This is useful when connecting through SOCKS5 proxies. - * + * * @return socketFactory used to create new sockets. */ public SocketFactory getSocketFactory() { @@ -413,7 +413,7 @@ public abstract class ConnectionConfiguration { /** * Returns the optional XMPP address to be requested as the SASL authorization identity. - * + * * @return the authorization identifier. * @see RFC 6120 § 6.3.8. Authorization Identity * @since 4.2 @@ -689,7 +689,7 @@ public abstract class ConnectionConfiguration { } /** - * Sets the path to the keystore file. The key store file contains the + * Sets the path to the keystore file. The key store file contains the * certificates that may be used to authenticate the client to the server, * in the event the server requests or requires it. * @@ -752,8 +752,8 @@ public abstract class ConnectionConfiguration { /** * Set the enabled SSL/TLS ciphers. - * - * @param enabledSSLCiphers the enabled SSL/TLS ciphers + * + * @param enabledSSLCiphers the enabled SSL/TLS ciphers * @return a reference to this builder. */ public B setEnabledSSLCiphers(String[] enabledSSLCiphers) { @@ -764,7 +764,7 @@ public abstract class ConnectionConfiguration { /** * Set the HostnameVerifier used to verify the hostname of SSLSockets used by XMPP connections * created with this ConnectionConfiguration. - * + * * @param verifier * @return a reference to this builder. */ @@ -795,7 +795,7 @@ public abstract class ConnectionConfiguration { /** * Set the Smack debugger factory used to construct Smack debuggers. - * + * * @param debuggerFactory the Smack debugger factory. * @return a reference to this builder. */ @@ -832,7 +832,7 @@ public abstract class ConnectionConfiguration { * * Some SASL mechanisms (e.g. SASL External) may also signal the username (as "authorization identity"), in * which case Smack should not throw an IllegalArgumentException when the username is not set. - * + * * @return a reference to this builder. */ public B allowEmptyOrNullUsernames() { @@ -843,7 +843,7 @@ public abstract class ConnectionConfiguration { /** * Perform anonymous authentication using SASL ANONYMOUS. Your XMPP service must support this authentication * mechanism. This method also calls {@link #addEnabledSaslMechanism(String)} with "ANONYMOUS" as argument. - * + * * @return a reference to this builder. */ public B performSaslAnonymousAuthentication() { @@ -902,7 +902,7 @@ public abstract class ConnectionConfiguration { * Enable the given SASL mechanisms. If you never add a mechanism to the set of enabled ones, all mechanisms * known to Smack will be enabled. Only explicitly enable particular SASL mechanisms if you want to limit * the used mechanisms to the enabled ones. - * + * * @param saslMechanisms a collection of names of mechanisms to enable. * @return a reference to this builder. */ @@ -935,7 +935,7 @@ public abstract class ConnectionConfiguration { * service domain, which should typically match. * Calling this will also SASL CRAM, since this mechanism does not support authzid. *

- * + * * @param authzid The BareJid to be requested as the authorization identifier. * @return a reference to this builder. * @see RFC 6120 § 6.3.8. Authorization Identity diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionCreationListener.java b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionCreationListener.java index f798b803a..30bbb0c9b 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionCreationListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionCreationListener.java @@ -30,7 +30,7 @@ public interface ConnectionCreationListener { /** * Notification that a new connection has been created. The new connection * will not yet be connected to the server. - * + * * @param connection the newly created connection. */ void connectionCreated(XMPPConnection connection); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionListener.java b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionListener.java index cecabcf71..716b4c1d2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionListener.java @@ -23,7 +23,7 @@ package org.jivesoftware.smack; * * @see XMPPConnection#addConnectionListener * @see XMPPConnection#removeConnectionListener - * + * * @author Matt Tucker */ public interface ConnectionListener { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java b/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java index d3cc212f2..d0ea8e5f0 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java @@ -44,7 +44,7 @@ import org.jivesoftware.smack.util.Async; *
  • If that fails it will indefinitely try to connect once every five minutes. * * - * {@link ReconnectionPolicy#FIXED_DELAY} - The reconnection mechanism will try to reconnect after a fixed delay + * {@link ReconnectionPolicy#FIXED_DELAY} - The reconnection mechanism will try to reconnect after a fixed delay * independently from the number of reconnection attempts already performed. *

    * Interrupting the reconnection thread will abort the reconnection mechanism. @@ -60,7 +60,7 @@ public final class ReconnectionManager { /** * Get a instance of ReconnectionManager for the given connection. - * + * * @param connection * @return a ReconnectionManager for the connection. */ @@ -89,7 +89,7 @@ public final class ReconnectionManager { /** * Set if the automatic reconnection mechanism will be enabled per default for new XMPP connections. The default is * 'false'. - * + * * @param enabled */ public static void setEnabledPerDefault(boolean enabled) { @@ -121,7 +121,7 @@ public final class ReconnectionManager { /** * Set the default fixed delay in seconds between the reconnection attempts. Also set the * default connection policy to {@link ReconnectionPolicy#FIXED_DELAY} - * + * * @param fixedDelay Delay expressed in seconds */ public static void setDefaultFixedDelay(int fixedDelay) { @@ -131,7 +131,7 @@ public final class ReconnectionManager { /** * Set the default Reconnection Policy to use. - * + * * @param reconnectionPolicy */ public static void setDefaultReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) { @@ -162,7 +162,7 @@ public final class ReconnectionManager { /** * Set the fixed delay in seconds between the reconnection attempts Also set the connection * policy to {@link ReconnectionPolicy#FIXED_DELAY}. - * + * * @param fixedDelay Delay expressed in seconds */ public void setFixedDelay(int fixedDelay) { @@ -172,7 +172,7 @@ public final class ReconnectionManager { /** * Set the Reconnection Policy to use. - * + * * @param reconnectionPolicy */ public void setReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java index 5c8a648fc..00314a3ca 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java @@ -114,7 +114,7 @@ public final class SASLAuthentication { /** * Unregister a SASLMechanism by it's full class name. For example * "org.jivesoftware.smack.sasl.javax.SASLCramMD5Mechanism". - * + * * @param clazz the SASLMechanism class's name * @return true if the given SASLMechanism was removed, false otherwise */ @@ -228,10 +228,10 @@ public final class SASLAuthentication { /** * Wrapper for {@link #challengeReceived(String, boolean)}, with finalChallenge set * to false. - * + * * @param challenge a base64 encoded string representing the challenge. * @throws SmackException - * @throws InterruptedException + * @throws InterruptedException */ public void challengeReceived(String challenge) throws SmackException, InterruptedException { challengeReceived(challenge, false); @@ -261,8 +261,8 @@ public final class SASLAuthentication { * Notification message saying that SASL authentication was successful. The next step * would be to bind the resource. * @param success result of the authentication. - * @throws SmackException - * @throws InterruptedException + * @throws SmackException + * @throws InterruptedException */ public void authenticated(Success success) throws SmackException, InterruptedException { // RFC6120 6.3.10 "At the end of the authentication exchange, the SASL server (the XMPP @@ -284,7 +284,7 @@ public final class SASLAuthentication { /** * Notification message saying that SASL authentication has failed. The server may have * closed the connection depending on the number of possible retries. - * + * * @param saslFailure the SASL failure as reported by the server * @see RFC6120 6.5 */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java index 5cef0f1c9..4b99bc20f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java @@ -44,7 +44,7 @@ import org.jivesoftware.smack.util.Objects; * * * Configuration settings are stored in org.jivesoftware.smack/smack-config.xml. - * + * * @author Gaston Dombiak */ public final class SmackConfiguration { @@ -86,7 +86,7 @@ public final class SmackConfiguration { /** * Returns the Smack version information, eg "1.3.0". - * + * * @return the Smack version information. */ public static String getVersion() { @@ -96,7 +96,7 @@ public final class SmackConfiguration { /** * Returns the number of milliseconds to wait for a response from * the server. The default value is 5000 ms. - * + * * @return the milliseconds to wait for a response from the server * @deprecated use {@link #getDefaultReplyTimeout()} instead. */ @@ -108,7 +108,7 @@ public final class SmackConfiguration { /** * Sets the number of milliseconds to wait for a response from * the server. - * + * * @param timeout the milliseconds to wait for a response from the server * @deprecated use {@link #setDefaultReplyTimeout(int)} instead. */ @@ -120,7 +120,7 @@ public final class SmackConfiguration { /** * Returns the number of milliseconds to wait for a response from * the server. The default value is 5000 ms. - * + * * @return the milliseconds to wait for a response from the server */ public static int getDefaultReplyTimeout() { @@ -134,7 +134,7 @@ public final class SmackConfiguration { /** * Sets the number of milliseconds to wait for a response from * the server. - * + * * @param timeout the milliseconds to wait for a response from the server */ public static void setDefaultReplyTimeout(int timeout) { @@ -153,9 +153,9 @@ public final class SmackConfiguration { } /** - * Gets the default max size of a stanza collector before it will delete + * Gets the default max size of a stanza collector before it will delete * the older packets. - * + * * @return The number of packets to queue before deleting older packets. */ public static int getStanzaCollectorSize() { @@ -163,9 +163,9 @@ public final class SmackConfiguration { } /** - * Sets the default max size of a stanza collector before it will delete + * Sets the default max size of a stanza collector before it will delete * the older packets. - * + * * @param collectorSize the number of packets to queue before deleting older packets. */ public static void setStanzaCollectorSize(int collectorSize) { @@ -235,7 +235,7 @@ public final class SmackConfiguration { /** * Returns the default parsing exception callback. - * + * * @return the default parsing exception callback * @see ParsingExceptionCallback */ @@ -334,7 +334,7 @@ public final class SmackConfiguration { /** * Check if Smack was successfully initialized. - * + * * @return true if smack was initialized, false otherwise */ public static boolean isSmackInitialized() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java index f52ce63a5..74d391539 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackException.java @@ -26,19 +26,19 @@ import org.jxmpp.jid.Jid; /** * Smack uses SmackExceptions for errors that are not defined by any XMPP specification. - * + * * @author Florian Schmaus */ public class SmackException extends Exception { /** - * + * */ private static final long serialVersionUID = 1844674365368214457L; /** * Creates a new SmackException with the Throwable that was the root cause of the exception. - * + * * @param wrappedThrowable the root cause of the exception. */ public SmackException(Throwable wrappedThrowable) { @@ -63,7 +63,7 @@ public class SmackException extends Exception { */ public static final class NoResponseException extends SmackException { /** - * + * */ private static final long serialVersionUID = -6523363748984543636L; @@ -124,7 +124,7 @@ public class SmackException extends Exception { public static class NotLoggedInException extends SmackException { /** - * + * */ private static final long serialVersionUID = 3216216839100019278L; @@ -136,7 +136,7 @@ public class SmackException extends Exception { public static class AlreadyLoggedInException extends SmackException { /** - * + * */ private static final long serialVersionUID = 5011416918049935231L; @@ -148,7 +148,7 @@ public class SmackException extends Exception { public static class AlreadyConnectedException extends SmackException { /** - * + * */ private static final long serialVersionUID = 5011416918049135231L; @@ -160,7 +160,7 @@ public class SmackException extends Exception { public static class NotConnectedException extends SmackException { /** - * + * */ private static final long serialVersionUID = 9197980400776001173L; @@ -187,7 +187,7 @@ public class SmackException extends Exception { public static class IllegalStateChangeException extends SmackException { /** - * + * */ private static final long serialVersionUID = -1766023961577168927L; @@ -198,7 +198,7 @@ public class SmackException extends Exception { public abstract static class SecurityRequiredException extends SmackException { /** - * + * */ private static final long serialVersionUID = 384291845029773545L; @@ -209,7 +209,7 @@ public class SmackException extends Exception { public static class SecurityRequiredByClientException extends SecurityRequiredException { /** - * + * */ private static final long serialVersionUID = 2395325821201543159L; @@ -220,7 +220,7 @@ public class SmackException extends Exception { public static class SecurityRequiredByServerException extends SecurityRequiredException { /** - * + * */ private static final long serialVersionUID = 8268148813117631819L; @@ -232,7 +232,7 @@ public class SmackException extends Exception { public static class SecurityNotPossibleException extends SmackException { /** - * + * */ private static final long serialVersionUID = -6836090872690331336L; @@ -250,7 +250,7 @@ public class SmackException extends Exception { public static class ConnectionException extends SmackException { /** - * + * */ private static final long serialVersionUID = 1686944201672697996L; @@ -286,7 +286,7 @@ public class SmackException extends Exception { public static class FeatureNotSupportedException extends SmackException { /** - * + * */ private static final long serialVersionUID = 4713404802621452016L; @@ -326,7 +326,7 @@ public class SmackException extends Exception { public static class ResourceBindingNotOfferedException extends SmackException { /** - * + * */ private static final long serialVersionUID = 2346934138253437571L; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java b/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java index 4a7c284eb..5c6ed9784 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java @@ -34,7 +34,7 @@ import org.jivesoftware.smack.packet.Stanza; * result.

    * * Each stanza collector will queue up a configured number of packets for processing before - * older packets are automatically dropped. The default number is retrieved by + * older packets are automatically dropped. The default number is retrieved by * {@link SmackConfiguration#getStanzaCollectorSize()}. * * @see XMPPConnection#createStanzaCollector(StanzaFilter) @@ -147,7 +147,7 @@ public class StanzaCollector { * * @param

    type of the result stanza. * @return the next available packet. - * @throws InterruptedException + * @throws InterruptedException */ @SuppressWarnings("unchecked") public

    P nextResultBlockForever() throws InterruptedException { @@ -165,7 +165,7 @@ public class StanzaCollector { * * @param

    type of the result stanza. * @return the next available packet. - * @throws InterruptedException + * @throws InterruptedException */ public

    P nextResult() throws InterruptedException { return nextResult(connection.getReplyTimeout()); @@ -181,7 +181,7 @@ public class StanzaCollector { * @param

    type of the result stanza. * @param timeout the timeout in milliseconds. * @return the next available packet. - * @throws InterruptedException + * @throws InterruptedException */ @SuppressWarnings("unchecked") public

    P nextResult(long timeout) throws InterruptedException { @@ -270,7 +270,7 @@ public class StanzaCollector { /** * Get the number of collected stanzas this stanza collector has collected so far. - * + * * @return the count of collected stanzas. * @since 4.1 */ @@ -306,7 +306,7 @@ public class StanzaCollector { /** * Get a new stanza collector configuration instance. - * + * * @return a new stanza collector configuration. */ public static Configuration newConfiguration() { @@ -325,7 +325,7 @@ public class StanzaCollector { /** * Set the stanza filter used by this collector. If null, then all packets will * get collected by this collector. - * + * * @param packetFilter * @return a reference to this configuration. * @deprecated use {@link #setStanzaFilter(StanzaFilter)} instead. @@ -338,7 +338,7 @@ public class StanzaCollector { /** * Set the stanza filter used by this collector. If null, then all stanzas will * get collected by this collector. - * + * * @param stanzaFilter * @return a reference to this configuration. */ @@ -350,7 +350,7 @@ public class StanzaCollector { /** * Set the maximum size of this collector, i.e. how many stanzas this collector will collect * before dropping old ones. - * + * * @param size * @return a reference to this configuration. */ @@ -362,7 +362,7 @@ public class StanzaCollector { /** * Set the collector which timeout for the next result is reset once this collector collects * a packet. - * + * * @param collector * @return a reference to this configuration. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java b/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java index 91b4a12f6..a5fbaee8b 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/StanzaListener.java @@ -49,8 +49,8 @@ public interface StanzaListener { * * @param packet the stanza to process. * @throws NotConnectedException - * @throws InterruptedException - * @throws NotLoggedInException + * @throws InterruptedException + * @throws NotLoggedInException */ void processStanza(Stanza packet) throws NotConnectedException, InterruptedException, NotLoggedInException; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java b/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java index ac0c79a54..54be30a36 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java @@ -243,7 +243,7 @@ public class SynchronizationPoint { * {@link #reportSuccess()}, {@link #reportFailure()} and {@link #reportFailure(Exception)} will either set this * synchronization point to {@link State#Success} or {@link State#Failure}. If none of them is set after the * connections reply timeout, this method will set the state of {@link State#NoResponse}. - * @throws InterruptedException + * @throws InterruptedException */ private void waitForConditionOrTimeout() throws InterruptedException { long remainingWait = TimeUnit.MILLISECONDS.toNanos(connection.getReplyTimeout()); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/UnparseableStanza.java b/smack-core/src/main/java/org/jivesoftware/smack/UnparseableStanza.java index ab1e15a6f..7e55abf6c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/UnparseableStanza.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/UnparseableStanza.java @@ -19,7 +19,7 @@ package org.jivesoftware.smack; /** * Representation of an unparsable stanza. - * + * * @author Florian Schmaus * */ @@ -42,7 +42,7 @@ public class UnparseableStanza { /** * Retrieve the raw stanza data. - * + * * @return the raw stanza data */ public CharSequence getContent() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java index cb1939ec3..09767042e 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java @@ -35,7 +35,7 @@ import org.jxmpp.jid.EntityFullJid; * implements shared methods which are used by the different types of connections (e.g. * XMPPTCPConnection or XMPPBOSHConnection). To create a connection to an XMPP server * a simple usage of this API might look like the following: - * + * * 

      * // Create a connection to the igniterealtime.org XMPP server.
  * XMPPTCPConnection con = new XMPPTCPConnection("igniterealtime.org");
@@ -76,7 +76,7 @@ public interface XMPPConnection {
     /**
      * Returns the XMPP Domain of the service provided by the XMPP server and used for this connection. After
      * authenticating with the server the returned value may be different.
-     * 
+     *
      * @return the XMPP domain of this XMPP session.
      */
     DomainBareJid getXMPPServiceDomain();
@@ -84,7 +84,7 @@ public interface XMPPConnection {
     /**
      * Returns the host name of the server where the XMPP server is running. This would be the
      * IP address of the server or a name that may be resolved by a DNS server.
-     * 
+     *
      * @return the host name of the server where the XMPP server is running or null if not yet connected.
      */
     String getHost();
@@ -92,7 +92,7 @@ public interface XMPPConnection {
     /**
      * Returns the port number of the XMPP server for this connection. The default port
      * for normal connections is 5222.
-     * 
+     *
      * @return the port number of the XMPP server or 0 if not yet connected.
      */
     int getPort();
@@ -101,7 +101,7 @@ public interface XMPPConnection {
      * Returns the full XMPP address of the user that is logged in to the connection or
      * null if not logged in yet. An XMPP address is in the form
      * username@server/resource.
-     * 
+     *
      * @return the full XMPP address of the user logged in.
      */
     EntityFullJid getUser();
@@ -109,7 +109,7 @@ public interface XMPPConnection {
     /**
      * Returns the stream ID for this connection, which is the value set by the server
      * when opening an XMPP stream. This value will be null if not connected to the server.
-     * 
+     *
      * @return the ID of this connection returned from the XMPP server or null if
      *      not connected to the server.
      * @see RFC 6120 § 4.7.3. id
@@ -118,28 +118,28 @@ public interface XMPPConnection {
 
     /**
      * Returns true if currently connected to the XMPP server.
-     * 
+     *
      * @return true if connected.
      */
     boolean isConnected();
 
     /**
      * Returns true if currently authenticated by successfully calling the login method.
-     * 
+     *
      * @return true if authenticated.
      */
     boolean isAuthenticated();
 
     /**
      * Returns true if currently authenticated anonymously.
-     * 
+     *
      * @return true if authenticated anonymously.
      */
     boolean isAnonymous();
 
     /**
-     * Returns true if the connection to the server has successfully negotiated encryption. 
-     * 
+     * Returns true if the connection to the server has successfully negotiated encryption.
+     *
      * @return true if a secure connection to the server.
      */
     boolean isSecureConnection();
@@ -149,7 +149,7 @@ public interface XMPPConnection {
      * traffic can be reduced up to 90%. Therefore, stream compression is ideal when using a slow
      * speed network connection. However, the server will need to use more CPU time in order to
      * un/compress network data so under high load the server performance might be affected.
-     * 
+     *
      * @return true if network traffic is being compressed.
      */
     boolean isUsingCompression();
@@ -173,21 +173,21 @@ public interface XMPPConnection {
      *
      * @param nonza the Nonza to send.
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      */
     void sendNonza(Nonza nonza) throws NotConnectedException, InterruptedException;
 
     /**
      * Adds a connection listener to this connection that will be notified when
      * the connection closes or fails.
-     * 
+     *
      * @param connectionListener a connection listener.
      */
     void addConnectionListener(ConnectionListener connectionListener);
 
     /**
      * Removes a connection listener from this connection.
-     * 
+     *
      * @param connectionListener a connection listener.
      */
     void removeConnectionListener(ConnectionListener connectionListener);
@@ -214,8 +214,8 @@ public interface XMPPConnection {
      *
      * @param request the IQ request to filter responses from
      * @return a new stanza collector.
-     * @throws NotConnectedException 
-     * @throws InterruptedException 
+     * @throws NotConnectedException
+     * @throws InterruptedException
      */
     StanzaCollector createStanzaCollectorAndSend(IQ request) throws NotConnectedException, InterruptedException;
 
@@ -224,12 +224,12 @@ public interface XMPPConnection {
      * which stanzas will be accumulated by the collector. A StanzaCollector is
      * more suitable to use than a {@link StanzaListener} when you need to wait for
      * a specific result.
-     * 
+     *
      * @param stanzaFilter the stanza filter to use.
      * @param stanza the stanza to send right after the collector got created
      * @return a new stanza collector.
-     * @throws InterruptedException 
-     * @throws NotConnectedException 
+     * @throws InterruptedException
+     * @throws NotConnectedException
      */
     StanzaCollector createStanzaCollectorAndSend(StanzaFilter stanzaFilter, Stanza stanza)
                     throws NotConnectedException, InterruptedException;
@@ -246,7 +246,7 @@ public interface XMPPConnection {
      * Otherwise make sure cancel the StanzaCollector in every case, e.g. even
      * if an exception is thrown, or otherwise you may leak the StanzaCollector.
      * 
    
-     * 
+     *
      * @param stanzaFilter the stanza filter to use.
      * @return a new stanza collector.
      */
@@ -258,7 +258,7 @@ public interface XMPPConnection {
      * Please make sure to cancel the collector when it is no longer required. See also
      * {@link #createStanzaCollector(StanzaFilter)}.
      * 
    
-     * 
+     *
      * @param configuration the stanza collector configuration.
      * @return a new stanza collector.
      * @since 4.1
@@ -267,7 +267,7 @@ public interface XMPPConnection {
 
     /**
      * Remove a stanza collector of this connection.
-     * 
+     *
      * @param collector a stanza collectors which was created for this connection.
      */
     void removeStanzaCollector(StanzaCollector collector);
@@ -309,7 +309,7 @@ public interface XMPPConnection {
      * invoked asynchronously in their own thread. Use this method if the order of the stanza listeners must not depend
      * on the order how the stanzas where received.
      * 
    
-     * 
+     *
      * @param stanzaListener the stanza listener to notify of new received stanzas.
      * @param stanzaFilter the stanza filter to use.
      * @see #addStanzaInterceptor(StanzaListener, StanzaFilter)
@@ -319,7 +319,7 @@ public interface XMPPConnection {
 
     /**
      * Removes an asynchronous stanza listener for received stanzas from this connection.
-     * 
+     *
      * @param stanzaListener the stanza listener to remove.
      * @return true if the stanza listener was removed
      * @since 4.1
@@ -333,7 +333,7 @@ public interface XMPPConnection {
      * that writes stanzas will be used to invoke the listeners. Therefore, each
      * stanza listener should complete all operations quickly or use a different
      * thread for processing.
-     * 
+     *
      * @param stanzaListener the stanza listener to notify of sent stanzas.
      * @param stanzaFilter   the stanza filter to use.
      * @deprecated use {@link #addStanzaSendingListener} instead
@@ -357,7 +357,7 @@ public interface XMPPConnection {
 
     /**
      * Removes a stanza listener for sending stanzas from this connection.
-     * 
+     *
      * @param stanzaListener the stanza listener to remove.
      * @deprecated use {@link #removeStanzaSendingListener} instead
      */
@@ -377,7 +377,7 @@ public interface XMPPConnection {
      * invoked every time a stanza is about to be sent by this connection. Interceptors
      * may modify the stanza to be sent. A stanza filter determines which stanzas
      * will be delivered to the interceptor.
-     * 
+     *
      * 
    
      * NOTE: For a similar functionality on incoming stanzas, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}.
      * 
    
@@ -467,7 +467,7 @@ public interface XMPPConnection {
     /**
      * Set the FromMode for this connection instance. Defines how the 'from' attribute of outgoing
      * stanzas should be populated by Smack.
-     * 
+     *
      * @param fromMode
      */
     void setFromMode(FromMode fromMode);
@@ -492,7 +492,7 @@ public interface XMPPConnection {
 
     /**
      * Return true if the server supports the given stream feature.
-     * 
+     *
      * @param element
      * @param namespace
      * @return true if the server supports the stream feature.
@@ -543,7 +543,7 @@ public interface XMPPConnection {
      * invoked at most once and it will be not invoked after the connections default reply timeout
      * has been elapsed.
      * 
    
-     * 
+     *
      * @param stanza the stanza to send (required)
      * @param replyFilter the filter used to determine response stanza (required)
      * @param callback the callback invoked if there is a response (required)
@@ -563,13 +563,13 @@ public interface XMPPConnection {
      * after the connections default reply timeout, then exceptionCallback will be invoked
      * with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
      * 
    
-     * 
+     *
      * @param stanza the stanza to send (required)
      * @param replyFilter the filter used to determine response stanza (required)
      * @param callback the callback invoked if there is a response (required)
      * @param exceptionCallback the callback invoked if there is an exception (optional)
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      * @deprecated use {@link #sendAsync(Stanza, StanzaFilter)} instead.
      */
     @Deprecated
@@ -584,14 +584,14 @@ public interface XMPPConnection {
      * after timeout milliseconds, then exceptionCallback will be invoked
      * with a {@link SmackException.NoResponseException}. The callback will be invoked at most once.
      * 
    
-     * 
+     *
      * @param stanza the stanza to send (required)
      * @param replyFilter the filter used to determine response stanza (required)
      * @param callback the callback invoked if there is a response (required)
      * @param exceptionCallback the callback invoked if there is an exception (optional)
      * @param timeout the timeout in milliseconds to wait for a response
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      * @deprecated use {@link #sendAsync(Stanza, StanzaFilter, long)} instead.
      */
     @Deprecated
@@ -604,11 +604,11 @@ public interface XMPPConnection {
      * Send a IQ stanza and invoke callback if there is a result of
      * {@link org.jivesoftware.smack.packet.IQ.Type#result} with that result IQ. The callback will
      * not be invoked after the connections default reply timeout has been elapsed.
-     * 
+     *
      * @param iqRequest the IQ stanza to send (required)
      * @param callback the callback invoked if there is result response (required)
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      * @deprecated use {@link #sendIqRequestAsync(IQ)} instead.
      */
     @Deprecated
@@ -622,12 +622,12 @@ public interface XMPPConnection {
      * error as {@link XMPPException.XMPPErrorException}. If there is no response after the
      * connections default reply timeout, then exceptionCallback will be invoked with a
      * {@link SmackException.NoResponseException}.
-     * 
+     *
      * @param iqRequest the IQ stanza to send (required)
      * @param callback the callback invoked if there is result response (required)
      * @param exceptionCallback the callback invoked if there is an Exception optional
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      * @deprecated use {@link #sendIqRequestAsync(IQ)} instead.
      */
     @Deprecated
@@ -642,13 +642,13 @@ public interface XMPPConnection {
      * error as {@link XMPPException.XMPPErrorException}. If there is no response after
      * timeout, then exceptionCallback will be invoked with a
      * {@link SmackException.NoResponseException}.
-     * 
+     *
      * @param iqRequest the IQ stanza to send (required)
      * @param callback the callback invoked if there is result response (required)
      * @param exceptionCallback the callback invoked if there is an Exception optional
      * @param timeout the timeout in milliseconds to wait for a response
      * @throws NotConnectedException
-     * @throws InterruptedException 
+     * @throws InterruptedException
      * @deprecated use {@link #sendIqRequestAsync(IQ, long)} instead.
      */
     @Deprecated
@@ -660,7 +660,7 @@ public interface XMPPConnection {
     /**
      * Add a callback that is called exactly once and synchronously with the incoming stanza that matches the given
      * stanza filter.
-     * 
+     *
      * @param callback the callback invoked once the stanza filter matches a stanza.
      * @param stanzaFilter the filter to match stanzas or null to match all.
      */
@@ -686,7 +686,7 @@ public interface XMPPConnection {
 
     /**
      * Unregister an IQ request handler with this connection.
-     * 
+     *
      * @param element the IQ element the IQ request handler is responsible for.
      * @param namespace the IQ namespace the IQ request handler is responsible for.
      * @param type the IQ type the IQ request handler is responsible for.
@@ -696,7 +696,7 @@ public interface XMPPConnection {
 
     /**
      * Returns the timestamp in milliseconds when the last stanza was received.
-     * 
+     *
      * @return the timestamp in milliseconds
      */
     long getLastStanzaReceived();
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnectionRegistry.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnectionRegistry.java
index a9a14c38e..6e02d1f79 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnectionRegistry.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnectionRegistry.java
@@ -32,7 +32,7 @@ public class XMPPConnectionRegistry {
     /**
      * Adds a new listener that will be notified when new Connections are created. Note
      * that newly created connections will not be actually connected to the server.
-     * 
+     *
      * @param connectionCreationListener a listener interested on new connections.
      */
     public static void addConnectionCreationListener(
@@ -42,7 +42,7 @@ public class XMPPConnectionRegistry {
 
     /**
      * Removes a listener that was interested in connection creation events.
-     * 
+     *
      * @param connectionCreationListener a listener interested on new connections.
      */
     public static void removeConnectionCreationListener(
@@ -54,7 +54,7 @@ public class XMPPConnectionRegistry {
 
     /**
      * Get the collection of listeners that are interested in connection creation events.
-     * 
+     *
      * @return a collection of listeners interested on new connections.
      */
     protected static Collection getConnectionCreationListeners() {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
index e9eb4d05b..2ea90aaca 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
@@ -71,7 +71,7 @@ public abstract class XMPPException extends Exception {
 
     public static class XMPPErrorException extends XMPPException {
         /**
-         * 
+         *
          */
         private static final long serialVersionUID = 212790389529249604L;
         private final StanzaError error;
@@ -121,7 +121,7 @@ public abstract class XMPPException extends Exception {
         /**
          * Returns the XMPPError associated with this exception, or null if there isn't
          * one.
-         * 
+         *
          * @return the XMPPError associated with this exception.
          */
         public StanzaError getXMPPError() {
@@ -174,7 +174,7 @@ public abstract class XMPPException extends Exception {
     public static class FailedNonzaException extends XMPPException {
 
         /**
-         * 
+         *
          */
         private static final long serialVersionUID = 1L;
 
@@ -198,7 +198,7 @@ public abstract class XMPPException extends Exception {
 
     public static class StreamErrorException extends XMPPException {
         /**
-         * 
+         *
          */
         private static final long serialVersionUID = 3400556867134848886L;
         private final StreamError streamError;
@@ -207,7 +207,7 @@ public abstract class XMPPException extends Exception {
          * Creates a new XMPPException with the stream error that was the root case of the
          * exception. When a stream error is received from the server then the underlying connection
          * will be closed by the server.
-         * 
+         *
          * @param streamError the root cause of the exception.
          */
         public StreamErrorException(StreamError streamError) {
@@ -220,7 +220,7 @@ public abstract class XMPPException extends Exception {
         /**
          * Returns the StreamError associated with this exception. The underlying TCP connection is
          * closed by the server after sending the stream error to the client.
-         * 
+         *
          * @return the StreamError associated with this exception.
          */
         public StreamError getStreamError() {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/compression/Java7ZlibInputOutputStream.java b/smack-core/src/main/java/org/jivesoftware/smack/compression/Java7ZlibInputOutputStream.java
index ccb3bbb7a..9f09e1c82 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/compression/Java7ZlibInputOutputStream.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/compression/Java7ZlibInputOutputStream.java
@@ -37,7 +37,7 @@ import java.util.zip.InflaterInputStream;
   * 
  • The required deflate() method (Java7)
  * 
  • The required deflate() method (Android)
  * 
- * 
+ *
  * @author Florian Schmaus
  */
 public class Java7ZlibInputOutputStream extends XMPPInputOutputStream {
@@ -74,7 +74,7 @@ public class Java7ZlibInputOutputStream extends XMPPInputOutputStream {
             /**
              * Provide a more InputStream compatible version. A return value of 1 means that it is likely to read one
              * byte without blocking, 0 means that the system is known to block for more input.
-             * 
+             *
              * @return 0 if no data is available, 1 otherwise
              * @throws IOException
              */
@@ -84,10 +84,10 @@ public class Java7ZlibInputOutputStream extends XMPPInputOutputStream {
                  * aSmack related remark (where KXmlParser is used):
                  * This is one of the funny code blocks. InflaterInputStream.available violates the contract of
                  * InputStream.available, which breaks kXML2.
-                 * 
+                 *
                  * I'm not sure who's to blame, oracle/sun for a broken api or the google guys for mixing a sun bug with
                  * a xml reader that can't handle it....
-                 * 
+                 *
                  * Anyway, this simple if breaks suns distorted reality, but helps to use the api as intended.
                  */
                 if (inf.needsInput()) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/compression/XMPPInputOutputStream.java b/smack-core/src/main/java/org/jivesoftware/smack/compression/XMPPInputOutputStream.java
index be2528015..c4f38816e 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/compression/XMPPInputOutputStream.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/compression/XMPPInputOutputStream.java
@@ -28,7 +28,7 @@ public abstract class XMPPInputOutputStream {
      * Set the used flushed method when compressing data. The default is full flush which may not
      * achieve the best compression ratio, but provides better security against certain attacks.
      * Only use sync flush if you fully understand the implications.
-     * 
+     *
      * @see Attacks against XMPP when using compression
      * @param flushMethod
      */
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
index 606bc7789..23b07785d 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
@@ -26,12 +26,12 @@ import org.jivesoftware.smack.packet.TopLevelStreamElement;
 import org.jxmpp.jid.EntityFullJid;
 
 /**
- * Interface that allows for implementing classes to debug XML traffic. That is a GUI window that 
+ * Interface that allows for implementing classes to debug XML traffic. That is a GUI window that
  * displays XML traffic.
    
- * 
- * Every implementation of this interface must have a public constructor with the following 
+ *
+ * Every implementation of this interface must have a public constructor with the following
  * arguments: XMPPConnection, Writer, Reader.
- * 
+ *
  * @author Gaston Dombiak
  */
 public abstract class SmackDebugger {
@@ -43,10 +43,10 @@ public abstract class SmackDebugger {
     }
 
     /**
-     * Called when a user has logged in to the server. The user could be an anonymous user, this 
-     * means that the user would be of the form host/resource instead of the form 
+     * Called when a user has logged in to the server. The user could be an anonymous user, this
+     * means that the user would be of the form host/resource instead of the form
      * user@host/resource.
-     * 
+     *
      * @param user the user@host/resource that has just logged in
      */
     // TODO: Should be replaced with a connection listener authenticed().
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java
index 1e39336bb..76eb9d534 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQTypeFilter.java
@@ -23,9 +23,9 @@ import org.jivesoftware.smack.util.Objects;
 /**
  * A filter for IQ stanza types. Returns true only if the stanza is an IQ packet
  * and it matches the type provided in the constructor.
- * 
+ *
  * @author Alexander Wenckus
- * 
+ *
  */
 public final class IQTypeFilter extends FlexibleStanzaTypeFilter {
 
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageTypeFilter.java
index 836151d45..61d6ed276 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageTypeFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageTypeFilter.java
@@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.Message.Type;
 
 /**
  * Filters for packets of a specific type of Message (e.g. CHAT).
- * 
+ *
  * @see org.jivesoftware.smack.packet.Message.Type
  * @author Ward Harold
  */
@@ -42,7 +42,7 @@ public final class MessageTypeFilter extends FlexibleStanzaTypeFilter {
 
     /**
      * Creates a new message type filter using the specified message type.
-     * 
+     *
      * @param type the message type.
      */
     private MessageTypeFilter(Message.Type type) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/initializer/SmackInitializer.java b/smack-core/src/main/java/org/jivesoftware/smack/initializer/SmackInitializer.java
index f219563ee..e34a5d30a 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/initializer/SmackInitializer.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/initializer/SmackInitializer.java
@@ -22,10 +22,10 @@ import org.jivesoftware.smack.SmackConfiguration;
 
 /**
  * Defines an initialization class that will be instantiated and invoked by the {@link SmackConfiguration} class during initialization.
- * 
+ *
  * 
    
  * Any implementation of this class MUST have a default constructor.
- * 
+ *
  * @author Robin Collier
  *
  */
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/initializer/UrlInitializer.java b/smack-core/src/main/java/org/jivesoftware/smack/initializer/UrlInitializer.java
index d58e7ee38..ffe7b9d90 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/initializer/UrlInitializer.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/initializer/UrlInitializer.java
@@ -31,7 +31,7 @@ import org.jivesoftware.smack.util.FileUtils;
 /**
  * Loads the provider file defined by the URL returned by {@link #getProvidersUri()} and the generic
  * smack configuration file returned {@link #getConfigUri()}.
- * 
+ *
  * @author Florian Schmaus
  */
 public abstract class UrlInitializer implements SmackInitializer {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/initializer/VmArgInitializer.java b/smack-core/src/main/java/org/jivesoftware/smack/initializer/VmArgInitializer.java
index 3d0aaa762..89487c2e6 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/initializer/VmArgInitializer.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/initializer/VmArgInitializer.java
@@ -23,9 +23,9 @@ import org.jivesoftware.smack.provider.ProviderManager;
 
 
 /**
- * Looks for a provider file location based on the VM argument smack.provider.file.  If it is supplied, its value will 
+ * Looks for a provider file location based on the VM argument smack.provider.file.  If it is supplied, its value will
  * be used as a file location for a providers file and loaded into the {@link ProviderManager} on Smack initialization.
- *  
+ *
  * @author Robin Collier
  *
  */
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java
index 4be69478c..513c4ca83 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java
@@ -61,7 +61,7 @@ public class AbstractError {
      * 
    
      * Returns the descriptive text of this SASLFailure in the system default language if possible. May return null.
      * 
    
-     * 
+     *
      * @return the descriptive text or null.
      */
     public String getDescriptiveText() {
@@ -81,7 +81,7 @@ public class AbstractError {
      * 
    
      * Returns the descriptive text of this SASLFailure in the given language. May return null if not available.
      * 
    
-     * 
+     *
      * @param xmllang the language.
      * @return the descriptive text or null.
      */
@@ -92,7 +92,7 @@ public class AbstractError {
 
     /**
      * Returns the first stanza extension that matches the specified element name and
-     * namespace, or null if it doesn't exist. 
+     * namespace, or null if it doesn't exist.
      *
      * @param elementName the XML element name of the stanza extension.
      * @param namespace the XML element namespace of the stanza extension.
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java
index bffae930f..a8095a877 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java
@@ -27,7 +27,7 @@ import org.jxmpp.jid.parts.Resourcepart;
  * resource but the server may return a modified version of the sent resource.
    
  *
  * For more information refer to the following
- * link. 
+ * link.
  *
  * @author Gaston Dombiak
  */
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java
index c963247d0..92ef0a964 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java
@@ -211,7 +211,7 @@ public abstract class IQ extends Stanza {
      *
    • * If your IQ does not contain any attributes or child elements (besides {@link ExtensionElement}s), consider sub-classing * {@link SimpleIQ} instead. - * + * * @param xml a pre-created builder which already has the child element and the 'xmlns' attribute set. * @return the build to create the IQ child content. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java index 4c3a87ab4..cb87251c7 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java @@ -220,7 +220,7 @@ public final class Message extends Stanza implements TypedCloneable { */ public void setSubject(String subject) { if (subject == null) { - removeSubject(""); // use empty string because #removeSubject(null) is ambiguous + removeSubject(""); // use empty string because #removeSubject(null) is ambiguous return; } addSubject(null, subject); @@ -751,7 +751,7 @@ public final class Message extends Stanza implements TypedCloneable { /** * Converts a String into the corresponding types. Valid String values that can be converted * to types are: "normal", "chat", "groupchat", "headline" and "error". - * + * * @param string the String value to covert. * @return the corresponding Type. * @throws IllegalArgumentException when not able to parse the string parameter diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java index 032814d52..f8ff0a8f9 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java @@ -162,9 +162,9 @@ public interface Packet extends TopLevelStreamElement { * Returns the first stanza extension that matches the specified element name and * namespace, or null if it doesn't exist. If the provided elementName is null, * only the namespace is matched. Stanza extensions are - * are arbitrary XML sub-documents in standard XMPP packets. By default, a - * DefaultPacketExtension instance will be returned for each extension. However, - * PacketExtensionProvider instances can be registered with the + * are arbitrary XML sub-documents in standard XMPP packets. By default, a + * DefaultPacketExtension instance will be returned for each extension. However, + * PacketExtensionProvider instances can be registered with the * {@link org.jivesoftware.smack.provider.ProviderManager ProviderManager} * class to handle custom parsing. In that case, the type of the Object * will be determined by the provider. @@ -184,7 +184,7 @@ public interface Packet extends TopLevelStreamElement { /** * Adds a collection of stanza extensions to the packet. Does nothing if extensions is null. - * + * * @param extensions a collection of stanza extensions */ void addExtensions(Collection extensions); @@ -203,7 +203,7 @@ public interface Packet extends TopLevelStreamElement { /** * Check if a stanza extension with the given namespace exists. - * + * * @param namespace * @return true if a stanza extension exists, false otherwise. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java index 1231bc620..abf4e39c5 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java @@ -146,7 +146,7 @@ public final class Presence extends Stanza implements TypedCloneable { * @return true if the presence type is available. */ public boolean isAvailable() { - return type == Type.available; + return type == Type.available; } /** @@ -160,7 +160,7 @@ public final class Presence extends Stanza implements TypedCloneable { * @return true if the presence type is available and the presence mode is away, xa, or dnd. */ public boolean isAway() { - return type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd); + return type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd); } /** @@ -378,7 +378,7 @@ public final class Presence extends Stanza implements TypedCloneable { * Converts a String into the corresponding types. Valid String values that can be converted * to types are: "available", "unavailable", "subscribe", "subscribed", "unsubscribe", * "unsubscribed" and "error". - * + * * @param string the String value to covert. * @return the corresponding Type. * @throws IllegalArgumentException when not able to parse the string parameter @@ -422,7 +422,7 @@ public final class Presence extends Stanza implements TypedCloneable { /** * Converts a String into the corresponding types. Valid String values that can be converted * to types are: "chat", "available", "away", "xa", and "dnd". - * + * * @param string the String value to covert. * @return the corresponding Type. * @throws IllegalArgumentException when not able to parse the string parameter diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java index a795ac09b..58672bfe4 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java @@ -151,7 +151,7 @@ public abstract class Stanza implements TopLevelStreamElement { /** * Set the stanza id if none is set. - * + * * @return the stanza id. * @since 4.2 */ @@ -402,7 +402,7 @@ public abstract class Stanza implements TopLevelStreamElement { /** * Adds a collection of stanza extensions to the packet. Does nothing if extensions is null. - * + * * @param extensions a collection of stanza extensions */ public void addExtensions(Collection extensions) { @@ -434,7 +434,7 @@ public abstract class Stanza implements TopLevelStreamElement { /** * Check if a stanza extension with the given namespace exists. - * + * * @param namespace * @return true if a stanza extension exists, false otherwise. */ @@ -489,7 +489,7 @@ public abstract class Stanza implements TopLevelStreamElement { /** * Returns the default language used for all messages containing localized content. - * + * * @return the default language */ public static String getDefaultLanguage() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaError.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaError.java index a1db639eb..de8d7a446 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaError.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaError.java @@ -104,14 +104,14 @@ public class StanzaError extends AbstractError { /** * Creates a new error with the specified type, condition and message. * This constructor is used when the condition is not recognized automatically by XMPPError - * i.e. there is not a defined instance of ErrorCondition or it does not apply the default + * i.e. there is not a defined instance of ErrorCondition or it does not apply the default * specification. - * + * * @param type the error type. * @param condition the error condition. * @param conditionText * @param errorGenerator - * @param descriptiveTexts + * @param descriptiveTexts * @param extensions list of stanza extensions * @param stanza the stanza carrying this XMPP error. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionLoggingCallback.java b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionLoggingCallback.java index fe104c721..f42254f36 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionLoggingCallback.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionLoggingCallback.java @@ -24,9 +24,9 @@ import org.jivesoftware.smack.UnparseableStanza; /** * Simple parsing exception callback that only logs the encountered parsing exception to java util logging. - * + * * @author Florian Schmaus - * + * */ public class ExceptionLoggingCallback implements ParsingExceptionCallback { private static final Logger LOGGER = Logger.getLogger(ExceptionLoggingCallback.class.getName()); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionThrowingCallback.java b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionThrowingCallback.java index 50d38939d..df11552c9 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionThrowingCallback.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ExceptionThrowingCallback.java @@ -23,9 +23,9 @@ import org.jivesoftware.smack.UnparseableStanza; /** * Parsing exception callback class that simply throws the encountered parsing exception. This usually leads to an * {@link ConnectionListener#connectionClosedOnError(Exception)} and disconnect of the connection. - * + * * @author Florian Schmaus - * + * */ public class ExceptionThrowingCallback implements ParsingExceptionCallback { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java index 87721a571..0e8339ca1 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java @@ -27,15 +27,15 @@ import org.jivesoftware.smack.UnparseableStanza; *

    * Smack provides 2 predefined ParsingExceptionCallback's: {@link ExceptionLoggingCallback} and {@link ExceptionThrowingCallback}. *

    - * + * * @author Florian Schmaus - * + * */ public interface ParsingExceptionCallback { /** * Called when parsing a stanza caused an exception. - * + * * @param stanzaData the raw stanza data that caused the exception * @throws Exception */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java index b07c603e7..a216c0f93 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java @@ -27,20 +27,20 @@ import org.jivesoftware.smack.util.PacketParserUtils; import org.xmlpull.v1.XmlPullParser; /** - * - * This class simplifies parsing of embedded elements by using the - * Template Method Pattern. - * After extracting the current element attributes and content of any child elements, the template method + * + * This class simplifies parsing of embedded elements by using the + * Template Method Pattern. + * After extracting the current element attributes and content of any child elements, the template method * ({@link #createReturnExtension(String, String, Map, List)} is called. Subclasses * then override this method to create the specific return type. - * - *

    To use this class, you simply register your subclasses as extension providers in the + * + *

    To use this class, you simply register your subclasses as extension providers in the * smack.properties file. Then they will be automatically picked up and used to parse - * any child elements. - * + * any child elements. + * * 

      * For example, given the following message
- * 
+ *
  * <message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo>
  *    <event xmlns='http://jabber.org/protocol/pubsub#event>
  *       <items node='princely_musings'>
@@ -54,16 +54,16 @@ import org.xmlpull.v1.XmlPullParser;
  *       </items>
  *    </event>
  * </message>
- * 
+ *
  * I would have a classes
  * ItemsProvider extends {@link EmbeddedExtensionProvider}
  * ItemProvider extends {@link EmbeddedExtensionProvider}
  * and
  * AtomProvider extends {@link ExtensionElementProvider}
- * 
+ *
  * These classes are then registered in the meta-inf/smack.providers file
  * as follows.
- * 
+ *
  *   <extensionProvider>
  *      <elementName>items</elementName>
  *      <namespace>http://jabber.org/protocol/pubsub#event</namespace>
@@ -74,9 +74,9 @@ import org.xmlpull.v1.XmlPullParser;
  *       <namespace>http://jabber.org/protocol/pubsub#event</namespace>
  *       <className>org.jivesoftware.smackx.provider.ItemProvider</className>
  *   </extensionProvider>
- * 
+ *
  *
    - * + * * @author Robin Collier */ public abstract class EmbeddedExtensionProvider extends ExtensionElementProvider { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java index cb3aab1de..08285c498 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/ExtensionProviderInfo.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.ExtensionElement; /** * Defines the information required to register a stanza extension Provider with the {@link ProviderManager} when using the * {@link ProviderLoader}. - * + * * @author Robin Collier * */ @@ -29,7 +29,7 @@ public final class ExtensionProviderInfo extends AbstractProviderInfo { /** * Defines an extension provider which implements the ExtensionElementProvider interface. - * + * * @param elementName Element that provider parses. * @param namespace Namespace that provider parses. * @param extProvider The provider implementation. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProviderInfo.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProviderInfo.java index a08f31eb7..abb14a62f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProviderInfo.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProviderInfo.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.IQ; /** * Defines the information required to register an IQ Provider with the {@link ProviderManager} when using the * {@link ProviderLoader}. - * + * * @author Robin Collier * */ @@ -29,7 +29,7 @@ public final class IQProviderInfo extends AbstractProviderInfo { /** * Defines an IQ provider which implements the IQProvider interface. - * + * * @param elementName Element that provider parses. * @param namespace Namespace that provider parses. * @param iqProvider The provider implementation. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java index 87250c50f..082855463 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; * element does not follow the specification, for example by putting a string where only integers are allowed, then a * {@link org.jivesoftware.smack.SmackException} should be thrown. *

    - * + * * @author Florian Schmaus * @param the type of the resulting element. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderFileLoader.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderFileLoader.java index 0858809c3..07b34651b 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderFileLoader.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderFileLoader.java @@ -31,9 +31,9 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserFactory; /** - * Loads the {@link IQProvider} and {@link ExtensionElementProvider} information from a standard provider file in preparation + * Loads the {@link IQProvider} and {@link ExtensionElementProvider} information from a standard provider file in preparation * for loading into the {@link ProviderManager}. - * + * * @author Robin Collier * */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderLoader.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderLoader.java index de4315ee9..12de164ac 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderLoader.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/ProviderLoader.java @@ -20,7 +20,7 @@ import java.util.Collection; /** * Used to load providers into the {@link ProviderManager}. - * + * * @author Robin Collier */ public interface ProviderLoader { @@ -40,7 +40,7 @@ public interface ProviderLoader { /** * Provides the stream feature providers information for the creation of stream feature * providers to be added to the ProviderManager. - * + * * @return The extension provider info to load. */ Collection getStreamFeatureProviderInfo(); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java index 96f117253..213b1d7c4 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java @@ -22,7 +22,7 @@ public final class StreamFeatureProviderInfo extends AbstractProviderInfo { /** * Defines an extension provider which implements the StreamFeatureProvider interface. - * + * * @param elementName Element that provider parses. * @param namespace Namespace that provider parses. * @param extProvider The provider implementation. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/proxy/HTTPProxySocketConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/proxy/HTTPProxySocketConnection.java index 39288f7db..cd1000c15 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/proxy/HTTPProxySocketConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/proxy/HTTPProxySocketConnection.java @@ -30,7 +30,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64; /** * HTTP Proxy Socket Connection which connects the socket using a HTTP Proxy. - * + * * @author Atul Aggarwal */ class HTTPProxySocketConnection implements ProxySocketConnection { @@ -92,7 +92,7 @@ class HTTPProxySocketConnection implements ProxySocketConnection { if (nlchars != 4) { throw new ProxyException(ProxyInfo.ProxyType.HTTP, "Never " + - "received blank line from " + "received blank line from " + proxyhost + ", cancelling connection"); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyException.java b/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyException.java index 2efa4aa26..76741c31b 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyException.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyException.java @@ -20,12 +20,12 @@ import java.io.IOException; /** * An exception class to handle exceptions caused by proxy. - * + * * @author Atul Aggarwal */ public class ProxyException extends IOException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyInfo.java b/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyInfo.java index af5855271..005101190 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyInfo.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/proxy/ProxyInfo.java @@ -17,9 +17,9 @@ package org.jivesoftware.smack.proxy; /** - * Class which stores proxy information such as proxy type, host, port, + * Class which stores proxy information such as proxy type, host, port, * authentication etc. - * + * * @author Atul Aggarwal */ @@ -37,7 +37,7 @@ public class ProxyInfo { private ProxyType proxyType; private final ProxySocketConnection proxySocketConnection; - public ProxyInfo(ProxyType pType, String pHost, int pPort, String pUser, + public ProxyInfo(ProxyType pType, String pHost, int pPort, String pUser, String pPass) { this.proxyType = pType; this.proxyAddress = pHost; @@ -59,17 +59,17 @@ public class ProxyInfo { } } - public static ProxyInfo forHttpProxy(String pHost, int pPort, String pUser, + public static ProxyInfo forHttpProxy(String pHost, int pPort, String pUser, String pPass) { return new ProxyInfo(ProxyType.HTTP, pHost, pPort, pUser, pPass); } - public static ProxyInfo forSocks4Proxy(String pHost, int pPort, String pUser, + public static ProxyInfo forSocks4Proxy(String pHost, int pPort, String pUser, String pPass) { return new ProxyInfo(ProxyType.SOCKS4, pHost, pPort, pUser, pPass); } - public static ProxyInfo forSocks5Proxy(String pHost, int pPort, String pUser, + public static ProxyInfo forSocks5Proxy(String pHost, int pPort, String pUser, String pPass) { return new ProxyInfo(ProxyType.SOCKS5, pHost, pPort, pUser, pPass); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketConnection.java index 34c58376b..cf35fb788 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketConnection.java @@ -27,7 +27,7 @@ import org.jivesoftware.smack.util.StringUtils; /** * Socket factory for socks4 proxy. - * + * * @author Atul Aggarwal */ public class Socks4ProxySocketConnection implements ProxySocketConnection { @@ -101,7 +101,7 @@ public class Socks4ProxySocketConnection implements ProxySocketConnection { consulting IDENT, cf. RFC 1413. If the request is granted, the SOCKS server makes a connection to the specified port of the destination host. A reply packet is sent to the client when this connection is established, - or when the request is rejected or the operation fails. + or when the request is rejected or the operation fails. +----+----+----+----+----+----+----+----+ | VN | CD | DSTPORT | DSTIP | @@ -126,13 +126,13 @@ public class Socks4ProxySocketConnection implements ProxySocketConnection { while (s < len) { int i = in.read(buf, s, len - s); if (i <= 0) { - throw new ProxyException(ProxyInfo.ProxyType.SOCKS4, + throw new ProxyException(ProxyInfo.ProxyType.SOCKS4, "stream is closed"); } s += i; } if (buf[0] != 0) { - throw new ProxyException(ProxyInfo.ProxyType.SOCKS4, + throw new ProxyException(ProxyInfo.ProxyType.SOCKS4, "server returns VN " + buf[0]); } if (buf[1] != 90) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketConnection.java index 9951c13b2..b3f62f19f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketConnection.java @@ -26,7 +26,7 @@ import org.jivesoftware.smack.util.StringUtils; /** * Socket factory for Socks5 proxy. - * + * * @author Atul Aggarwal */ public class Socks5ProxySocketConnection implements ProxySocketConnection { @@ -130,12 +130,12 @@ public class Socks5ProxySocketConnection implements ProxySocketConnection { buf[index++] = 1; buf[index++] = (byte) (user.length()); byte[] userBytes = user.getBytes(StringUtils.UTF8); - System.arraycopy(userBytes, 0, buf, index, + System.arraycopy(userBytes, 0, buf, index, user.length()); index += user.length(); byte[] passwordBytes = passwd.getBytes(StringUtils.UTF8); buf[index++] = (byte) (passwordBytes.length); - System.arraycopy(passwordBytes, 0, buf, index, + System.arraycopy(passwordBytes, 0, buf, index, passwd.length()); index += passwd.length(); @@ -258,7 +258,7 @@ public class Socks5ProxySocketConnection implements ProxySocketConnection { } catch (Exception eee) { } - throw new ProxyException(ProxyInfo.ProxyType.SOCKS5, + throw new ProxyException(ProxyInfo.ProxyType.SOCKS5, "server returns " + buf[1]); } @@ -290,7 +290,7 @@ public class Socks5ProxySocketConnection implements ProxySocketConnection { } } - private static void fill(InputStream in, byte[] buf, int len) + private static void fill(InputStream in, byte[] buf, int len) throws IOException { int s = 0; while (s < len) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLErrorException.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLErrorException.java index 528086f95..be0dfc503 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLErrorException.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLErrorException.java @@ -25,7 +25,7 @@ import org.jivesoftware.smack.sasl.packet.SaslStreamElements.SASLFailure; public class SASLErrorException extends XMPPException { /** - * + * */ private static final long serialVersionUID = 6247573875760717257L; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java index 914b177cb..d3aede72c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java @@ -62,7 +62,7 @@ public abstract class SASLMechanism implements Comparable { *

    * A simple SASLPrep StringTransformer would be for example: java.text.Normalizer.normalize(string, Form.NFKC); *

    - * + * * @param stringTransformer set StringTransformer to use for SASLPrep. * @see RFC 4013 - SASLprep: Stringprep Profile for User Names and Passwords */ @@ -111,28 +111,28 @@ public abstract class SASLMechanism implements Comparable { * Builds and sends the auth stanza to the server. Note that this method of * authentication is not recommended, since it is very inflexible. Use * {@link #authenticate(String, DomainBareJid, CallbackHandler, EntityBareJid, SSLSession)} whenever possible. - * + * * Explanation of auth stanza: - * - * The client authentication stanza needs to include the digest-uri of the form: xmpp/serviceName - * From RFC-2831: + * + * The client authentication stanza needs to include the digest-uri of the form: xmpp/serviceName + * From RFC-2831: * digest-uri = "digest-uri" "=" digest-uri-value * digest-uri-value = serv-type "/" host [ "/" serv-name ] - * - * digest-uri: - * Indicates the principal name of the service with which the client - * wishes to connect, formed from the serv-type, host, and serv-name. + * + * digest-uri: + * Indicates the principal name of the service with which the client + * wishes to connect, formed from the serv-type, host, and serv-name. * For example, the FTP service * on "ftp.example.com" would have a "digest-uri" value of "ftp/ftp.example.com"; the SMTP * server from the example above would have a "digest-uri" value of * "smtp/mail3.example.com/example.com". - * + * * host: * The DNS host name or IP address for the service requested. The DNS host name * must be the fully-qualified canonical name of the host. The DNS host name is the * preferred form; see notes on server processing of the digest-uri. - * - * serv-name: + * + * serv-name: * Indicates the name of the service if it is replicated. The service is * considered to be replicated if the client's service-location process involves resolution * using standard DNS lookup operations, and if these operations involve DNS records (such @@ -154,8 +154,8 @@ public abstract class SASLMechanism implements Comparable { * @param authzid the optional authorization identity. * @param sslSession the optional SSL/TLS session (if one was established) * @throws SmackException If a network error occurs while authenticating. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public final void authenticate(String username, String host, DomainBareJid serviceName, String password, EntityBareJid authzid, SSLSession sslSession) @@ -187,8 +187,8 @@ public abstract class SASLMechanism implements Comparable { * @param authzid the optional authorization identity. * @param sslSession the optional SSL/TLS session (if one was established) * @throws SmackException - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void authenticate(String host, DomainBareJid serviceName, CallbackHandler cbh, EntityBareJid authzid, SSLSession sslSession) throws SmackException, NotConnectedException, InterruptedException { @@ -225,7 +225,7 @@ public abstract class SASLMechanism implements Comparable { * Should return the initial response of the SASL mechanism. The returned byte array will be * send base64 encoded to the server. SASL mechanism are free to return null or an * empty array here. - * + * * @return the initial response or null * @throws SmackException */ @@ -313,7 +313,7 @@ public abstract class SASLMechanism implements Comparable { /** * SASLprep the given String. The resulting String is in UTF-8. - * + * * @param string the String to sasl prep. * @return the given String SASL preped * @see RFC 4013 - SASLprep: Stringprep Profile for User Names and Passwords diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/SASLXOauth2Mechanism.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/SASLXOauth2Mechanism.java index e066fb87d..4b2577068 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/SASLXOauth2Mechanism.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/SASLXOauth2Mechanism.java @@ -32,7 +32,7 @@ import org.jivesoftware.smack.sasl.SASLMechanism; * Note that X-OAUTH2 is experimental in Smack. This is because Google defined, besides being a bad practice (XEP-134), * custom attributes to the 'auth' stanza, as can be seen here *

    - * + * * 
      * {@code
  * 
  * }
  *
    - * + * * from https://developers.google.com/cloud-print/docs/rawxmpp and here - * + * * 
      * {@code
  * 
  * }
  *
    - * + * * from https://developers.google.com/talk/jep_extensions/oauth *

    * Those attribute extensions are currently not supported by Smack, and it's unclear how it affects authorization and diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramHmac.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramHmac.java index d893bdcdb..dbc48c6b4 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramHmac.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramHmac.java @@ -24,7 +24,7 @@ public interface ScramHmac { /** * RFC 5802 § 2.2 HMAC(key, str). - * + * * @param key * @param str * @return the HMAC-SHA1 value of the input. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramMechanism.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramMechanism.java index e7a96bdf5..c45065f40 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramMechanism.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramMechanism.java @@ -262,7 +262,7 @@ public abstract class ScramMechanism extends SASLMechanism { } /** - * + * * @return the Channel Binding data. * @throws SmackException */ @@ -356,11 +356,11 @@ public abstract class ScramMechanism extends SASLMechanism { /** * RFC 5802 § 2.2 HMAC(key, str) - * + * * @param key * @param str * @return the HMAC-SHA1 value of the input. - * @throws SmackException + * @throws SmackException */ private byte[] hmac(byte[] key, byte[] str) throws SmackException { try { @@ -377,12 +377,12 @@ public abstract class ScramMechanism extends SASLMechanism { * Hi() is, essentially, PBKDF2 [RFC2898] with HMAC() as the pseudorandom function * (PRF) and with dkLen == output length of HMAC() == output length of H(). *

    - * + * * @param normalizedPassword the normalized password. * @param salt * @param iterations * @return the result of the Hi function. - * @throws SmackException + * @throws SmackException */ private byte[] hi(String normalizedPassword, byte[] salt, int iterations) throws SmackException { byte[] key; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramPlusMechanism.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramPlusMechanism.java index be5d5a862..bbd4d8217 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramPlusMechanism.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/core/ScramPlusMechanism.java @@ -28,7 +28,7 @@ import org.jivesoftware.smack.util.TLSUtils; * SCRAM-X-PLUS implementation. Due limitations of the Java API, this mechanism only supports the 'tls-server-end-point' * channel binding type. But on the other hand, the other relevant channel binding type 'tls-unique' has some flaws (see * 3SHAKE, RFC 7627). - * + * * @author Florian Schmaus */ public abstract class ScramPlusMechanism extends ScramMechanism { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java index a0bca0c4a..2b203f10d 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java @@ -154,7 +154,7 @@ public class SaslStreamElements { /** * Construct a new SASL success stream element with optional additional data for the SASL layer. * (RFC6120 6.3.10) - * + * * @param data additional data for the SASL layer or null */ public Success(String data) { @@ -163,7 +163,7 @@ public class SaslStreamElements { /** * Returns additional data for the SASL layer or null. - * + * * @return additional data or null */ public String getData() { @@ -220,7 +220,7 @@ public class SaslStreamElements { /** * Get the SASL related error condition. - * + * * @return the SASL related error condition. */ public SASLError getSASLError() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/ArrayBlockingQueueWithShutdown.java b/smack-core/src/main/java/org/jivesoftware/smack/util/ArrayBlockingQueueWithShutdown.java index a38063c4d..d0b9ff343 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/ArrayBlockingQueueWithShutdown.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/ArrayBlockingQueueWithShutdown.java @@ -32,7 +32,7 @@ import java.util.concurrent.locks.ReentrantLock; *

    * Based on ArrayBlockingQueue of OpenJDK by Doug Lea (who released ArrayBlockingQueue as public * domain). - * + * * @param the type of elements held in this collection */ public class ArrayBlockingQueueWithShutdown extends AbstractQueue implements BlockingQueue { @@ -170,7 +170,7 @@ public class ArrayBlockingQueueWithShutdown extends AbstractQueue implemen /** * Returns true if the queue is currently shut down. - * + * * @return true if the queue is shut down. */ public boolean isShutdown() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/DNSUtil.java b/smack-core/src/main/java/org/jivesoftware/smack/util/DNSUtil.java index 6557187e1..fb4c55eb6 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/DNSUtil.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/DNSUtil.java @@ -135,7 +135,7 @@ public class DNSUtil { } /** - * + * * @param domain the domain. * @param domainType the XMPP domain type, server or client. * @param failedAddresses a list that will be populated with host addresses that failed to resolve. @@ -188,7 +188,7 @@ public class DNSUtil { * Sort a given list of SRVRecords as described in RFC 2782 * Note that we follow the RFC with one exception. In a group of the same priority, only the first entry * is calculated by random. The others are ore simply ordered by their priority. - * + * * @param records * @return the list of resolved HostAddresses */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java index e86473ab0..32d6cd46f 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java @@ -102,7 +102,7 @@ public final class FileUtils { * * @param file * @return the content of file or null in case of an error - * @throws IOException + * @throws IOException */ @SuppressWarnings("DefaultCharset") public static String readFileOrThrow(File file) throws IOException { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableReader.java b/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableReader.java index 43713261a..eba4fcab2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableReader.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableReader.java @@ -25,7 +25,7 @@ import java.util.List; /** * An ObservableReader is a wrapper on a Reader that notifies to its listeners when * reading character streams. - * + * * @author Gaston Dombiak */ public class ObservableReader extends Reader { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableWriter.java b/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableWriter.java index b53c0f429..82d356545 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableWriter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/ObservableWriter.java @@ -24,7 +24,7 @@ import java.util.List; /** * An ObservableWriter is a wrapper on a Writer that notifies to its listeners when * writing to character streams. - * + * * @author Gaston Dombiak */ public class ObservableWriter extends Writer { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java index 3f47cef12..b5f0a2548 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java @@ -140,12 +140,12 @@ public class PacketParserUtils { /** * Tries to parse and return either a Message, IQ or Presence stanza. - * + * * connection is optional and is used to return feature-not-implemented errors for unknown IQ stanzas. * * @param parser * @return a stanza which is either a Message, IQ or Presence. - * @throws Exception + * @throws Exception */ public static Stanza parseStanza(XmlPullParser parser) throws Exception { ParserUtils.assertAtStartTag(parser); @@ -170,7 +170,7 @@ public class PacketParserUtils { * getText() if the parser is on START_TAG or END_TAG. So you must not rely on this * behavior when using the parser. *

    - * + * * @return A suitable XmlPullParser for XMPP parsing * @throws XmlPullParserException */ @@ -198,7 +198,7 @@ public class PacketParserUtils { * getText() if the parser is on START_TAG or END_TAG. So you must not rely on this * behavior when using the parser. *

    - * + * * @param reader * @return A suitable XmlPullParser for XMPP parsing * @throws XmlPullParserException @@ -214,7 +214,7 @@ public class PacketParserUtils { * * @param parser the XML parser, positioned at the start of a message packet. * @return a Message packet. - * @throws Exception + * @throws Exception */ public static Message parseMessage(XmlPullParser parser) throws Exception { @@ -291,7 +291,7 @@ public class PacketParserUtils { *

    * This method is used for the parts where the XMPP specification requires elements that contain * only text or are the empty element. - * + * * @param parser * @return the textual content of the element as String * @throws XmlPullParserException @@ -362,7 +362,7 @@ public class PacketParserUtils { * closing tag of the same depth is returned as String. *

    * Note that only the outermost namespace attributes ("xmlns") will be returned, not nested ones. - * + * * @param parser the XML pull parser * @return the content of a tag * @throws XmlPullParserException if parser encounters invalid XML @@ -399,7 +399,7 @@ public class PacketParserUtils { *

    * In particular Android's XmlPullParser does not support XML_ROUNDTRIP. *

    - * + * * @param parser * @param depth * @param fullNamespaces @@ -499,7 +499,7 @@ public class PacketParserUtils { * * @param parser the XML parser, positioned at the start of a presence packet. * @return a Presence packet. - * @throws Exception + * @throws Exception */ public static Presence parsePresence(XmlPullParser parser) throws Exception { @@ -662,8 +662,8 @@ public class PacketParserUtils { * * @param parser the XML parser, positioned at the start of the mechanisms stanza. * @return a collection of Stings with the mechanisms included in the mechanisms stanza. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ public static Collection parseMechanisms(XmlPullParser parser) throws XmlPullParserException, IOException { @@ -747,11 +747,11 @@ public class PacketParserUtils { /** * Parses SASL authentication error packets. - * + * * @param parser the XML parser. * @return a SASL Failure packet. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ public static SASLFailure parseSASLFailure(XmlPullParser parser) throws XmlPullParserException, IOException { final int initialDepth = parser.getDepth(); @@ -835,7 +835,7 @@ public class PacketParserUtils { * * @param parser the XML parser. * @return an error sub-packet. - * @throws Exception + * @throws Exception */ public static StanzaError.Builder parseError(XmlPullParser parser) throws Exception { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/ParserUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/ParserUtils.java index e48ea0059..28440bdbd 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/ParserUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/ParserUtils.java @@ -131,7 +131,7 @@ public class ParserUtils { /** * Get the boolean value of an argument. - * + * * @param parser * @param name * @return the boolean value or null of no argument of the given name exists diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/ReaderListener.java b/smack-core/src/main/java/org/jivesoftware/smack/util/ReaderListener.java index b6c1ee802..587dc5245 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/ReaderListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/ReaderListener.java @@ -23,14 +23,14 @@ package org.jivesoftware.smack.util; * * @see ObservableReader#addReaderListener * @see ObservableReader#removeReaderListener - * + * * @author Gaston Dombiak */ public interface ReaderListener { /** * Notification that the Reader has read a new string. - * + * * @param str the read String */ void read(String str); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java index 40300997d..4b9bfe94c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java @@ -382,7 +382,7 @@ public class StringUtils { /** * Returns true if the given CharSequence is empty. - * + * * @param cs * @return true if the given CharSequence is empty */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/TLSUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/TLSUtils.java index ac302e1c9..3fb5057ef 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/TLSUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/TLSUtils.java @@ -58,7 +58,7 @@ public class TLSUtils { * TLSv1.1. This method goes one step beyond and upgrades the handshake to use TLSv1 or better. * This method requires the underlying OS to support all of TLSv1.2 , 1.1 and 1.0. *

    - * + * * @param builder the configuration builder to apply this setting to * @param Type of the ConnectionConfiguration builder. * @@ -78,7 +78,7 @@ public class TLSUtils { * XMPP Manifesto, TLSv1.2 shall be deployed, providing fallback support for SSLv3 and * TLSv1.1. *

    - * + * * @param builder the configuration builder to apply this setting to * @param Type of the ConnectionConfiguration builder. * @@ -96,7 +96,7 @@ public class TLSUtils { * invalidates all security guarantees provided by TLS. Only use this method if you understand the * implications. *

    - * + * * @param builder a connection configuration builder. * @param Type of the ConnectionConfiguration builder. * @throws NoSuchAlgorithmException @@ -125,7 +125,7 @@ public class TLSUtils { * invalidates all security guarantees provided by TLS. Only use this method if you understand the * implications. *

    - * + * * @param builder a connection configuration builder. * @param Type of the ConnectionConfiguration builder. * @return the given builder. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/WriterListener.java b/smack-core/src/main/java/org/jivesoftware/smack/util/WriterListener.java index 1ef53d3bf..702c8e3cb 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/WriterListener.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/WriterListener.java @@ -23,14 +23,14 @@ package org.jivesoftware.smack.util; * * @see ObservableWriter#addWriterListener * @see ObservableWriter#removeWriterListener - * + * * @author Gaston Dombiak */ public interface WriterListener { /** * Notification that the Writer has written a new string. - * + * * @param str the written string */ void write(String str); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java b/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java index 946a291c9..0fdaceeb8 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java @@ -208,7 +208,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element { /** * Add a right angle bracket '>'. - * + * * @return a reference to this object. */ public XmlStringBuilder rightAngleBracket() { @@ -557,7 +557,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element { if (csq instanceof XmlStringBuilder) { ((XmlStringBuilder) csq).write(writer, enclosingNamespace); } - else if (csq instanceof XmlNsAttribute) { + else if (csq instanceof XmlNsAttribute) { XmlNsAttribute xmlNsAttribute = (XmlNsAttribute) csq; if (!xmlNsAttribute.value.equals(enclosingNamespace)) { writer.write(xmlNsAttribute.toString()); @@ -582,7 +582,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element { if (csq instanceof XmlStringBuilder) { ((XmlStringBuilder) csq).appendXmlTo(res, enclosingNamespace); } - else if (csq instanceof XmlNsAttribute) { + else if (csq instanceof XmlNsAttribute) { XmlNsAttribute xmlNsAttribute = (XmlNsAttribute) csq; if (!xmlNsAttribute.value.equals(enclosingNamespace)) { sb.append(xmlNsAttribute); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/HostAddress.java b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/HostAddress.java index f0bc854f5..9c988defd 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/HostAddress.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/HostAddress.java @@ -36,7 +36,7 @@ public class HostAddress { /** * Creates a new HostAddress with the given FQDN. - * + * * @param fqdn the optional fully qualified domain name (FQDN). * @param port The port to connect on. * @param inetAddresses list of addresses. @@ -109,7 +109,7 @@ public class HostAddress { * Retrieve the Exception that caused a connection failure to this HostAddress. Every * HostAddress found in {@link ConnectionException} will have an Exception set, * which can be retrieved with this method. - * + * * @return the Exception causing this HostAddress to fail */ public Map getExceptions() { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java index d049ce03d..7b8ea5750 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java @@ -29,7 +29,7 @@ import org.minidns.dnsname.DnsName; * @see RFC 2782: A DNS RR for specifying the location of services (DNS * SRV) * @author Florian Schmaus - * + * */ public class SRVRecord extends HostAddress implements Comparable { @@ -38,7 +38,7 @@ public class SRVRecord extends HostAddress implements Comparable { /** * SRV Record constructor. - * + * * @param fqdn Fully qualified domain name * @param port The connection port * @param priority Priority of the target host diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/Base32.java b/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/Base32.java index e52b17858..c8239f5d2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/Base32.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/Base32.java @@ -26,7 +26,7 @@ import org.jivesoftware.smack.util.StringUtils; /** * Base32 string encoding is useful for when filenames case-insensitive filesystems are encoded. * Base32 representation takes roughly 20% more space then Base64. - * + * * @author Florian Schmaus * Based on code by Brian Wellington (bwelling@xbill.org) * @see Base32 Wikipedia entry diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java b/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java index c2785d314..d181eafa9 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java @@ -24,7 +24,7 @@ package org.jivesoftware.smack.util.stringencoder; public interface StringEncoder { /** * Encodes an string to another representation. - * + * * @param string * @return the encoded String */ @@ -32,7 +32,7 @@ public interface StringEncoder { /** * Decodes an string back to it's initial representation. - * + * * @param string * @return the decoded String */ diff --git a/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java b/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java index c8c425251..a3ff3246f 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/DummyConnection.java @@ -38,16 +38,16 @@ import org.jxmpp.stringprep.XmppStringprepException; /** * A dummy implementation of {@link XMPPConnection}, intended to be used during * unit tests. - * + * * Instances store any packets that are delivered to be send using the * {@link #sendStanza(Stanza)} method in a blocking queue. The content of this queue * can be inspected using {@link #getSentPacket()}. Typically these queues are * used to retrieve a message that was generated by the client. - * + * * Packets that should be processed by the client to simulate a received stanza * can be delivered using the {@linkplain #processStanza(Stanza)} method. * It invokes the registered stanza interceptors and listeners. - * + * * @see XMPPConnection * @author Guenther Niess */ @@ -130,7 +130,7 @@ public class DummyConnection extends AbstractXMPPConnection { /** * Returns the number of packets that's sent through {@link #sendStanza(Stanza)} and * that has not been returned by {@link #getSentPacket()}. - * + * * @return the number of packets which are in the queue. */ public int getNumberOfSentPackets() { @@ -140,7 +140,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. - * + * * @return a sent packet. */ public

    P getSentPacket() { @@ -152,7 +152,7 @@ public class DummyConnection extends AbstractXMPPConnection { * and that has not been returned by earlier calls to this method. This * method will block for up to the specified number of seconds if no packets * have been sent yet. - * + * * @return a sent packet. */ @SuppressWarnings("unchecked") diff --git a/smack-core/src/test/java/org/jivesoftware/smack/StanzaCollectorTest.java b/smack-core/src/test/java/org/jivesoftware/smack/StanzaCollectorTest.java index 2b6884042..27821a6bf 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/StanzaCollectorTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/StanzaCollectorTest.java @@ -142,7 +142,7 @@ public class StanzaCollectorTest { consumer1.interrupt(); } catch (InterruptedException e) { } - // We cannot guarantee that this is going to pass due to the possible issue of timing between consumer 1 + // We cannot guarantee that this is going to pass due to the possible issue of timing between consumer 1 // and main, but the probability is extremely remote. assertNull(collector.pollResult()); } diff --git a/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java b/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java index 75c7c6553..02fbd9739 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java @@ -68,7 +68,7 @@ public class ThreadedDummyConnection extends DummyConnection { /** * Calling this method will cause the next sendStanza call with an IQ stanza to timeout. - * This is accomplished by simply stopping the auto creating of the reply stanza + * This is accomplished by simply stopping the auto creating of the reply stanza * or processing one that was entered via {@link #processStanza(Stanza)}. */ public void setTimeout() { diff --git a/smack-core/src/test/java/org/jivesoftware/smack/packet/IQResponseTest.java b/smack-core/src/test/java/org/jivesoftware/smack/packet/IQResponseTest.java index edc500db3..c0a982188 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/packet/IQResponseTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/packet/IQResponseTest.java @@ -27,7 +27,7 @@ import org.jxmpp.stringprep.XmppStringprepException; /** * Tests that verifies the correct behavior of creating result and error IQ packets. - * + * * @see IQ Semantics * @author Guenther Niess */ @@ -38,7 +38,7 @@ public class IQResponseTest { /** * Test creating a simple and empty IQ response. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void testGeneratingSimpleResponse() throws XmppStringprepException { @@ -58,7 +58,7 @@ public class IQResponseTest { /** * Test creating a error response based on an IQ request. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void testGeneratingValidErrorResponse() throws XmppStringprepException { @@ -83,7 +83,7 @@ public class IQResponseTest { /** * According to RFC3920: IQ Semantics we shouldn't respond to an IQ of type result. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void testGeneratingResponseBasedOnResult() throws XmppStringprepException { @@ -106,7 +106,7 @@ public class IQResponseTest { /** * According to RFC3920: IQ Semantics we shouldn't respond to an IQ of type error. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void testGeneratingErrorBasedOnError() throws XmppStringprepException { diff --git a/smack-core/src/test/java/org/jivesoftware/smack/packet/XMPPErrorTest.java b/smack-core/src/test/java/org/jivesoftware/smack/packet/XMPPErrorTest.java index b7ec7479b..c2807ad77 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/packet/XMPPErrorTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/packet/XMPPErrorTest.java @@ -1,35 +1,35 @@ -/** - * - * Copyright © 2017 Ingo Bauersachs - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.jivesoftware.smack.packet; - -import static org.jivesoftware.smack.packet.StanzaError.Condition; -import static org.jivesoftware.smack.packet.StanzaError.Type; -import static org.junit.Assert.assertEquals; - -import java.util.Map; - -import org.junit.Test; - -public class XMPPErrorTest { - @Test - public void testConditionHasDefaultTypeMapping() throws NoSuchFieldException, IllegalAccessException { - Map conditionToTypeMap = StanzaError.CONDITION_TO_TYPE; - assertEquals("CONDITION_TO_TYPE map is likely out of sync with Condition enum", - Condition.values().length, - conditionToTypeMap.size()); - } -} +/** + * + * Copyright © 2017 Ingo Bauersachs + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.jivesoftware.smack.packet; + +import static org.jivesoftware.smack.packet.StanzaError.Condition; +import static org.jivesoftware.smack.packet.StanzaError.Type; +import static org.junit.Assert.assertEquals; + +import java.util.Map; + +import org.junit.Test; + +public class XMPPErrorTest { + @Test + public void testConditionHasDefaultTypeMapping() throws NoSuchFieldException, IllegalAccessException { + Map conditionToTypeMap = StanzaError.CONDITION_TO_TYPE; + assertEquals("CONDITION_TO_TYPE map is likely out of sync with Condition enum", + Condition.values().length, + conditionToTypeMap.size()); + } +} diff --git a/smack-core/src/test/java/org/jivesoftware/smack/parsing/ParsingExceptionTest.java b/smack-core/src/test/java/org/jivesoftware/smack/parsing/ParsingExceptionTest.java index 3b0fcce9f..e3bd1e973 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/parsing/ParsingExceptionTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/parsing/ParsingExceptionTest.java @@ -53,7 +53,7 @@ public class ParsingExceptionTest { @Test public void consumeUnparsedInput() throws Exception { - final String MESSAGE_EXCEPTION_ELEMENT = + final String MESSAGE_EXCEPTION_ELEMENT = "<" + ThrowException.ELEMENT + " xmlns='" + ThrowException.NAMESPACE + "'>" + "" + "" + diff --git a/smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java b/smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java index f449a9665..e8d525751 100644 --- a/smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java +++ b/smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java @@ -671,7 +671,7 @@ public class PacketParserUtilsTest { /** * RFC6121 5.2.3 explicitly disallows mixed content in elements. Make sure that we throw * an exception if we encounter such an element. - * + * * @throws Exception */ @Test(expected = XmlPullParserException.class) diff --git a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java index 0b544a909..b01b0d634 100644 --- a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java +++ b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebugger.java @@ -109,7 +109,7 @@ public class EnhancedDebugger extends SmackDebugger { { URL url; - // Load the image icons + // Load the image icons url = Thread.currentThread().getContextClassLoader().getResource("images/nav_left_blue.png"); if (url != null) { @@ -205,7 +205,7 @@ public class EnhancedDebugger extends SmackDebugger { } // We'll arrange the UI into six tabs. The first tab contains all data, the second - // client generated XML, the third server generated XML, the fourth allows to send + // client generated XML, the third server generated XML, the fourth allows to send // ad-hoc messages and the fifth contains connection information. tabbedPane = new JTabbedPane(); diff --git a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java index b4f3ca33f..8d72eb96f 100644 --- a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java +++ b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java @@ -219,10 +219,10 @@ public final class EnhancedDebuggerWindow { } // We'll arrange the UI into tabs. The last tab contains Smack's information. - // All the connection debugger tabs will be shown before the Smack info tab. + // All the connection debugger tabs will be shown before the Smack info tab. tabbedPane = new JTabbedPane(); - // Create the Smack info panel + // Create the Smack info panel JPanel informationPanel = new JPanel(); informationPanel.setLayout(new BoxLayout(informationPanel, BoxLayout.Y_AXIS)); diff --git a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/LiteDebugger.java b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/LiteDebugger.java index da0bd163e..1ca75279d 100644 --- a/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/LiteDebugger.java +++ b/smack-debug/src/main/java/org/jivesoftware/smackx/debugger/LiteDebugger.java @@ -51,9 +51,9 @@ import org.jivesoftware.smack.util.WriterListener; import org.jxmpp.jid.EntityFullJid; /** - * The LiteDebugger is a very simple debugger that allows to debug sent, received and + * The LiteDebugger is a very simple debugger that allows to debug sent, received and * interpreted messages. - * + * * @author Gaston Dombiak */ public class LiteDebugger extends SmackDebugger { @@ -82,7 +82,7 @@ public class LiteDebugger extends SmackDebugger { frame = new JFrame("Smack Debug Window -- " + connection.getXMPPServiceDomain() + ":" + connection.getPort()); - // Add listener for window closing event + // Add listener for window closing event frame.addWindowListener(new WindowAdapter() { @Override public void windowClosing(WindowEvent evt) { @@ -265,10 +265,10 @@ public class LiteDebugger extends SmackDebugger { } /** - * Notification that the root window is closing. Stop listening for received and + * Notification that the root window is closing. Stop listening for received and * transmitted packets. - * - * @param evt the event that indicates that the root window is closing + * + * @param evt the event that indicates that the root window is closing */ public void rootWindowClosing(WindowEvent evt) { // TODO: Remove debugger from connection. diff --git a/smack-experimental/src/main/java/org/jivesoftware/smack/experimental/ExperimentalInitializer.java b/smack-experimental/src/main/java/org/jivesoftware/smack/experimental/ExperimentalInitializer.java index 81161a429..efabc6442 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smack/experimental/ExperimentalInitializer.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smack/experimental/ExperimentalInitializer.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.initializer.UrlInitializer; /** * Initializes the providers in the experimental code stream. - * + * * @author Florian Schmaus */ public class ExperimentalInitializer extends UrlInitializer { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java index ddbb72ef5..e184ff663 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/CarbonManager.java @@ -85,7 +85,7 @@ public final class CarbonManager extends Manager { }); } - private static final StanzaFilter CARBON_EXTENSION_FILTER = + private static final StanzaFilter CARBON_EXTENSION_FILTER = // @formatter:off new AndFilter( new OrFilter( @@ -221,12 +221,12 @@ public final class CarbonManager extends Manager { /** * Returns true if XMPP Carbons are supported by the server. - * + * * @return true if supported - * @throws NotConnectedException - * @throws XMPPErrorException - * @throws NoResponseException - * @throws InterruptedException + * @throws NotConnectedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws InterruptedException */ public boolean isSupportedByServer() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(CarbonExtension.NAMESPACE); @@ -239,7 +239,7 @@ public final class CarbonManager extends Manager { * You should first check for support using isSupportedByServer(). * * @param new_state whether carbons should be enabled or disabled - * @throws NotConnectedException + * @throws NotConnectedException * @throws InterruptedException * @deprecated use {@link #enableCarbonsAsync(ExceptionCallback)} or {@link #disableCarbonsAsync(ExceptionCallback)} instead. */ @@ -256,7 +256,7 @@ public final class CarbonManager extends Manager { * because of a slow network connection). Thus, if the thread performing this operation is interrupted while the * queue is full, an {@link InterruptedException} is thrown. *

    - * + * * @param exceptionCallback the optional exception callback. * @since 4.2 */ @@ -272,7 +272,7 @@ public final class CarbonManager extends Manager { * because of a slow network connection). Thus, if the thread performing this operation is interrupted while the * queue is full, an {@link InterruptedException} is thrown. *

    - * + * * @param exceptionCallback the optional exception callback. * @since 4.2 */ @@ -302,10 +302,10 @@ public final class CarbonManager extends Manager { * You should first check for support using isSupportedByServer(). * * @param new_state whether carbons should be enabled or disabled - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * */ public synchronized void setCarbonsEnabled(final boolean new_state) throws NoResponseException, @@ -322,9 +322,9 @@ public final class CarbonManager extends Manager { /** * Helper method to enable carbons. * - * @throws XMPPException + * @throws XMPPException * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ public void enableCarbons() throws XMPPException, SmackException, InterruptedException { setCarbonsEnabled(true); @@ -333,9 +333,9 @@ public final class CarbonManager extends Manager { /** * Helper method to disable carbons. * - * @throws XMPPException + * @throws XMPPException * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ public void disableCarbons() throws XMPPException, SmackException, InterruptedException { setCarbonsEnabled(false); diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java index 0f9192cfd..26075613b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/CarbonExtension.java @@ -26,7 +26,7 @@ import org.jivesoftware.smackx.forward.packet.Forwarded; * Stanza extension for XEP-0280: Message Carbons. The extension * XEP-0280 is * meant to synchronize a message flow to multiple presences of a user. - * + * *

    * It accomplishes this by wrapping a {@link Forwarded} stanza in a sent * or received element @@ -41,7 +41,7 @@ public class CarbonExtension implements ExtensionElement { /** * Construct a Carbon message extension. - * + * * @param dir Determines if the carbon is being sent/received * @param fwd The forwarded message. */ @@ -130,7 +130,7 @@ public class CarbonExtension implements ExtensionElement { /** * Stanza extension indicating that a message may not be carbon-copied. Adding this - * extension to any message will disallow that message from being copied. + * extension to any message will disallow that message from being copied. */ public static final class Private implements ExtensionElement { public static final Private INSTANCE = new Private(); @@ -157,7 +157,7 @@ public class CarbonExtension implements ExtensionElement { /** * Marks a message "private", so that it will not be carbon-copied, by adding private packet * extension to the message. - * + * * @param message the message to add the private extension to */ public static void addTo(Message message) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java index d99948f0e..60e5e1e0e 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/provider/CarbonManagerProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * This class implements the {@link ExtensionElementProvider} to parse * carbon copied messages from a packet. It will return a {@link CarbonExtension} stanza extension. - * + * * @author Georg Lukas * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersManager.java index 2749b5a75..a7c03798f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersManager.java @@ -32,11 +32,11 @@ import org.jivesoftware.smackx.disco.ServiceDiscoveryManager; /** * Chat Markers Manager class (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public final class ChatMarkersManager extends Manager { @@ -53,7 +53,7 @@ public final class ChatMarkersManager extends Manager { /** * Get the singleton instance of ChatMarkersManager. - * + * * @param connection * @return the instance of ChatMarkersManager */ @@ -74,7 +74,7 @@ public final class ChatMarkersManager extends Manager { /** * Returns true if Chat Markers is supported by the server. - * + * * @return true if Chat Markers is supported by the server. * @throws NotConnectedException * @throws XMPPErrorException diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/ChatMarkersElements.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/ChatMarkersElements.java index 342839d85..d058e55d1 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/ChatMarkersElements.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/ChatMarkersElements.java @@ -22,11 +22,11 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Chat Markers elements (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public class ChatMarkersElements { @@ -34,7 +34,7 @@ public class ChatMarkersElements { /** * Markable extension class. - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez @@ -74,7 +74,7 @@ public class ChatMarkersElements { /** * Received extension class. - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez @@ -95,7 +95,7 @@ public class ChatMarkersElements { /** * Get the id. - * + * * @return the id */ public String getId() { @@ -127,7 +127,7 @@ public class ChatMarkersElements { /** * Displayed extension class. - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez @@ -148,7 +148,7 @@ public class ChatMarkersElements { /** * Get the id. - * + * * @return the id */ public String getId() { @@ -180,7 +180,7 @@ public class ChatMarkersElements { /** * Acknowledged extension class. - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez @@ -201,7 +201,7 @@ public class ChatMarkersElements { /** * Get the id. - * + * * @return the id */ public String getId() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/package-info.java index 6a919f016..9ac78d113 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/element/package-info.java @@ -16,9 +16,9 @@ */ /** * Chat Markers elements (XEP-0333). - * + * * @see XEP-0333: Chat * Markers - * + * */ package org.jivesoftware.smackx.chat_markers.element; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/package-info.java index 72fb0c8e5..21bd5cefb 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/package-info.java @@ -16,9 +16,9 @@ */ /** * XEP-0333: Chat Markers. - * + * * @see XEP-0333: Chat * Markers - * + * */ package org.jivesoftware.smackx.chat_markers; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/AcknowledgedProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/AcknowledgedProvider.java index aaee88c72..db5e6505f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/AcknowledgedProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/AcknowledgedProvider.java @@ -24,11 +24,11 @@ import org.xmlpull.v1.XmlPullParser; /** * Acknowledged extension provider class (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public class AcknowledgedProvider extends ExtensionElementProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/DisplayedProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/DisplayedProvider.java index 734688628..804b77124 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/DisplayedProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/DisplayedProvider.java @@ -24,11 +24,11 @@ import org.xmlpull.v1.XmlPullParser; /** * Displayed extension provider class (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public class DisplayedProvider extends ExtensionElementProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/MarkableProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/MarkableProvider.java index 0975ee85b..f4c4384bb 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/MarkableProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/MarkableProvider.java @@ -24,11 +24,11 @@ import org.xmlpull.v1.XmlPullParser; /** * Markable extension provider class (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public class MarkableProvider extends ExtensionElementProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/ReceivedProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/ReceivedProvider.java index 1d462958e..b0d527093 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/ReceivedProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/ReceivedProvider.java @@ -24,11 +24,11 @@ import org.xmlpull.v1.XmlPullParser; /** * Received extension provider class (XEP-0333). - * + * * @see XEP-0333: Chat * Markers * @author Fernando Ramirez - * + * */ public class ReceivedProvider extends ExtensionElementProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/package-info.java index 10ecdf320..7d96d25fa 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/provider/package-info.java @@ -16,9 +16,9 @@ */ /** * Chat Markers providers (XEP-0333). - * + * * @see XEP-0333: Chat * Markers - * + * */ package org.jivesoftware.smackx.chat_markers.provider; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hints/element/NoCopyHint.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hints/element/NoCopyHint.java index 2bd80cf7b..b07249ddd 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hints/element/NoCopyHint.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hints/element/NoCopyHint.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.hints.element; import org.jivesoftware.smack.packet.Message; /** - * A "no copy" hint. Messages with this hint should not be copied to addresses other than the one to which it is addressed. + * A "no copy" hint. Messages with this hint should not be copied to addresses other than the one to which it is addressed. * * @see XEP-0344 § 4.3 No copies */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/HOXTManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/HOXTManager.java index 9c0866c28..8774e1317 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/HOXTManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/HOXTManager.java @@ -59,7 +59,7 @@ public class HOXTManager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public static boolean isSupported(Jid jid, XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection).supportsFeature(jid, NAMESPACE); diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java index ac708128c..ce3e64298 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java @@ -120,7 +120,7 @@ public abstract class AbstractHttpOverXmpp extends IQ { * Sets Headers element. * * @param headers Headers element - * + * * @return the builder */ public B setHeaders(HeadersExtension headers) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppReq.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppReq.java index a01127939..c28e87ceb 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppReq.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppReq.java @@ -153,7 +153,7 @@ public final class HttpOverXmppReq extends AbstractHttpOverXmpp { * Sets resource attribute. * * @param resource attribute - * + * * @return the builder */ public Builder setResource(String resource) { @@ -165,7 +165,7 @@ public final class HttpOverXmppReq extends AbstractHttpOverXmpp { * Sets jingle attribute. * * @param jingle jingle attribute - * + * * @return the builder */ public Builder setJingle(boolean jingle) { @@ -177,7 +177,7 @@ public final class HttpOverXmppReq extends AbstractHttpOverXmpp { * Sets ibb attribute. * * @param ibb ibb attribute - * + * * @return the builder */ public Builder setIbb(boolean ibb) { @@ -189,7 +189,7 @@ public final class HttpOverXmppReq extends AbstractHttpOverXmpp { * Sets sipub attribute. * * @param sipub sipub attribute - * + * * @return the builder */ public Builder setSipub(boolean sipub) { @@ -201,7 +201,7 @@ public final class HttpOverXmppReq extends AbstractHttpOverXmpp { * Sets maxChunkSize attribute. * * @param maxChunkSize maxChunkSize attribute - * + * * @return the builder */ public Builder setMaxChunkSize(int maxChunkSize) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppResp.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppResp.java index 97e74b390..f4d3971f1 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppResp.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/HttpOverXmppResp.java @@ -84,7 +84,7 @@ public final class HttpOverXmppResp extends AbstractHttpOverXmpp { * Sets statusCode attribute. * * @param statusCode statusCode attribute - * + * * @return the builder */ public Builder setStatusCode(int statusCode) { @@ -96,7 +96,7 @@ public final class HttpOverXmppResp extends AbstractHttpOverXmpp { * Sets statusMessage attribute. * * @param statusMessage statusMessage attribute - * + * * @return the builder */ public Builder setStatusMessage(String statusMessage) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java index c3f597d09..496330250 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/provider/AbstractHttpOverXmppProvider.java @@ -73,7 +73,7 @@ public abstract class AbstractHttpOverXmppProvider} * @see XEP-0323: Internet of Things - Control */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetRequest.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetRequest.java index 052cb07c1..cd6d0b553 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetRequest.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetRequest.java @@ -35,7 +35,7 @@ public class IoTSetRequest extends IQ { /* * Ugly workaround for the following error prone false positive: - * + * * IoTSetRequest.java:34: error: incompatible types: Collection cannot be converted to Collection * this.setData = Collections.unmodifiableCollection(setDataA); * ^ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/data/IoTDataManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/data/IoTDataManager.java index 27077bdaa..abcb1a649 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/data/IoTDataManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/data/IoTDataManager.java @@ -50,7 +50,7 @@ import org.jxmpp.jid.EntityFullJid; /** * A manager for XEP-0323: Internet of Things - Sensor Data. - * + * * @author Florian Schmaus {@literal } * @see XEP-0323: Internet of Things - Sensor Data */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/discovery/IoTClaimedException.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/discovery/IoTClaimedException.java index c8b8ff76f..aac149669 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/discovery/IoTClaimedException.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/discovery/IoTClaimedException.java @@ -22,7 +22,7 @@ import org.jivesoftware.smackx.iot.discovery.element.IoTClaimed; public class IoTClaimedException extends IoTException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/provisioning/IoTProvisioningManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/provisioning/IoTProvisioningManager.java index 6e6177cba..fbdef4c16 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/provisioning/IoTProvisioningManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/provisioning/IoTProvisioningManager.java @@ -283,7 +283,7 @@ public final class IoTProvisioningManager extends Manager { /** * Set the configured provisioning server. Use null as provisioningServer to use * automatic discovery of the provisioning server (the default behavior). - * + * * @param provisioningServer */ public void setConfiguredProvisioningServer(Jid provisioningServer) { @@ -300,7 +300,7 @@ public final class IoTProvisioningManager extends Manager { /** * Try to find a provisioning server component. - * + * * @return the XMPP address of the provisioning server component if one was found. * @throws NoResponseException * @throws XMPPErrorException diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java index 47b1dfd1d..04c3d3f32 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java @@ -58,12 +58,12 @@ import org.jxmpp.util.XmppDateTime; /** * A Manager for Message Archive Management (XEP-0313). - * + * * @see XEP-0313: Message * Archive Management * @author Florian Schmaus * @author Fernando Ramirez - * + * */ public final class MamManager extends Manager { @@ -80,7 +80,7 @@ public final class MamManager extends Manager { /** * Get the singleton instance of MamManager. - * + * * @param connection * @return the instance of MamManager */ @@ -114,7 +114,7 @@ public final class MamManager extends Manager { /** * Query archive with a maximum amount of results. - * + * * @param max * @return the MAM query result * @throws NoResponseException @@ -130,7 +130,7 @@ public final class MamManager extends Manager { /** * Query archive with a JID (only messages from/to the JID). - * + * * @param withJid * @return the MAM query result * @throws NoResponseException @@ -149,7 +149,7 @@ public final class MamManager extends Manager { * value of 'start' will be equal to the date/time of the earliest message * stored in the archive. If end == null, the value of 'end' will be equal * to the date/time of the most recent message stored in the archive. - * + * * @param start * @param end * @return the MAM query result @@ -166,7 +166,7 @@ public final class MamManager extends Manager { /** * Query Archive adding filters with additional fields. - * + * * @param additionalFields * @return the MAM query result * @throws NoResponseException @@ -183,7 +183,7 @@ public final class MamManager extends Manager { /** * Query archive filtering by start date. The value of 'end' will be equal * to the date/time of the most recent message stored in the archive. - * + * * @param start * @return the MAM query result * @throws NoResponseException @@ -200,7 +200,7 @@ public final class MamManager extends Manager { /** * Query archive filtering by end date. The value of 'start' will be equal * to the date/time of the earliest message stored in the archive. - * + * * @param end * @return the MAM query result * @throws NoResponseException @@ -218,7 +218,7 @@ public final class MamManager extends Manager { /** * Query archive applying filters: max count, start date, end date, from/to * JID and with additional fields. - * + * * @param max * @param start * @param end @@ -242,7 +242,7 @@ public final class MamManager extends Manager { * Query an message archive like a MUC archive or a PubSub node archive, addressed by an archiveAddress, applying * filters: max count, start date, end date, from/to JID and with additional fields. When archiveAddress is null the * default, the server will be requested. - * + * * @param node The PubSub node name, can be null * @param max * @param start @@ -326,7 +326,7 @@ public final class MamManager extends Manager { /** * Returns a page of the archive. - * + * * @param dataForm * @param rsmSet * @return the MAM query result @@ -345,7 +345,7 @@ public final class MamManager extends Manager { /** * Returns a page of the archive. - * + * * @param node The PubSub node name, can be null * @param dataForm * @param rsmSet @@ -368,7 +368,7 @@ public final class MamManager extends Manager { /** * Returns the next page of the archive. - * + * * @param mamQueryResult * is the previous query result * @param count @@ -389,7 +389,7 @@ public final class MamManager extends Manager { /** * Returns the previous page of the archive. - * + * * @param mamQueryResult * is the previous query result * @param count @@ -482,7 +482,7 @@ public final class MamManager extends Manager { /** * Get the form fields supported by the server. - * + * * @return the list of form fields. * @throws NoResponseException * @throws XMPPErrorException @@ -497,7 +497,7 @@ public final class MamManager extends Manager { /** * Get the form fields supported by the server. - * + * * @param node The PubSub node name, can be null * @return the list of form fields. * @throws NoResponseException @@ -618,7 +618,7 @@ public final class MamManager extends Manager { /** * Get the preferences stored in the server. - * + * * @return the MAM preferences result * @throws NoResponseException * @throws XMPPErrorException @@ -634,7 +634,7 @@ public final class MamManager extends Manager { /** * Update the preferences in the server. - * + * * @param alwaysJids * is the list of JIDs that should always have messages to/from * archived in the user's store diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamElements.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamElements.java index 3f48604d2..8c7732e25 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamElements.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamElements.java @@ -30,11 +30,11 @@ import org.jxmpp.jid.Jid; /** * MAM elements. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez and Florian Schmaus - * + * */ public class MamElements { @@ -42,7 +42,7 @@ public class MamElements { /** * MAM result extension class. - * + * * @see XEP-0313: Message * Archive Management * @@ -71,7 +71,7 @@ public class MamElements { /** * MAM result extension constructor. - * + * * @param queryId * @param id * @param forwarded @@ -90,7 +90,7 @@ public class MamElements { /** * Get the id. - * + * * @return the id */ public String getId() { @@ -99,7 +99,7 @@ public class MamElements { /** * Get the forwarded element. - * + * * @return the forwarded element */ public Forwarded getForwarded() { @@ -108,7 +108,7 @@ public class MamElements { /** * Get query id. - * + * * @return the query id */ public final String getQueryId() { @@ -159,7 +159,7 @@ public class MamElements { /** * Always JID list element constructor. - * + * * @param alwaysJids */ AlwaysJidListElement(List alwaysJids) { @@ -193,7 +193,7 @@ public class MamElements { /** * Never JID list element constructor. - * + * * @param neverJids */ public NeverJidListElement(List neverJids) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamFinIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamFinIQ.java index 43796fff9..ca1259f0c 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamFinIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamFinIQ.java @@ -22,7 +22,7 @@ import org.jivesoftware.smackx.rsm.packet.RSMSet; /** * MAM fin IQ class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez @@ -62,7 +62,7 @@ public class MamFinIQ extends IQ { /** * MamFinIQ constructor. - * + * * @param queryId * @param rsmSet * @param complete @@ -81,7 +81,7 @@ public class MamFinIQ extends IQ { /** * Get RSM set. - * + * * @return the RSM set */ public RSMSet getRSMSet() { @@ -90,7 +90,7 @@ public class MamFinIQ extends IQ { /** * Return if it is complete. - * + * * @return true if it is complete */ public boolean isComplete() { @@ -99,7 +99,7 @@ public class MamFinIQ extends IQ { /** * Return if it is stable. - * + * * @return true if it is stable */ public boolean isStable() { @@ -108,7 +108,7 @@ public class MamFinIQ extends IQ { /** * Get query id. - * + * * @return the query id */ public final String getQueryId() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamPrefsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamPrefsIQ.java index 8f312c038..3361e03ec 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamPrefsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamPrefsIQ.java @@ -27,11 +27,11 @@ import org.jxmpp.jid.Jid; /** * MAM Preferences IQ class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez and Florian Schmaus - * + * */ public class MamPrefsIQ extends IQ { @@ -79,7 +79,7 @@ public class MamPrefsIQ extends IQ { /** * MAM preferences IQ constructor. - * + * * @param alwaysJids * @param neverJids * @param defaultBehavior @@ -94,7 +94,7 @@ public class MamPrefsIQ extends IQ { /** * Get the list of always store info JIDs. - * + * * @return the always list */ public List getAlwaysJids() { @@ -103,7 +103,7 @@ public class MamPrefsIQ extends IQ { /** * Get the list of never store info JIDs. - * + * * @return the never list */ public List getNeverJids() { @@ -112,7 +112,7 @@ public class MamPrefsIQ extends IQ { /** * Get the default behavior. - * + * * @return the default behavior. */ public DefaultBehavior getDefault() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamQueryIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamQueryIQ.java index bd9a65d4e..04db9a4f3 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamQueryIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamQueryIQ.java @@ -23,11 +23,11 @@ import org.jivesoftware.smackx.xdata.packet.DataForm; /** * MAM Query IQ class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez and Florian Schmaus - * + * */ public class MamQueryIQ extends IQ { @@ -47,7 +47,7 @@ public class MamQueryIQ extends IQ { /** * MAM query IQ constructor. - * + * * @param queryId */ public MamQueryIQ(String queryId) { @@ -57,7 +57,7 @@ public class MamQueryIQ extends IQ { /** * MAM query IQ constructor. - * + * * @param form */ public MamQueryIQ(DataForm form) { @@ -66,7 +66,7 @@ public class MamQueryIQ extends IQ { /** * MAM query IQ constructor. - * + * * @param queryId * @param form */ @@ -76,7 +76,7 @@ public class MamQueryIQ extends IQ { /** * MAM query IQ constructor. - * + * * @param queryId * @param node * @param dataForm @@ -102,7 +102,7 @@ public class MamQueryIQ extends IQ { /** * Get query id. - * + * * @return the query id */ public String getQueryId() { @@ -111,7 +111,7 @@ public class MamQueryIQ extends IQ { /** * Get the Node name. - * + * * @return the node */ public String getNode() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/package-info.java index 5c63d8c7c..ad599b4e9 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/package-info.java @@ -17,9 +17,9 @@ /** * Packet classes and interfaces for Message Archive Management (MAM) XEP-0313. - * + * * @see XEP-0313: Message * Archive Management - * + * */ package org.jivesoftware.smackx.mam.element; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/MamResultFilter.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/MamResultFilter.java index 965e1dd04..7eb3ee286 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/MamResultFilter.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/MamResultFilter.java @@ -24,11 +24,11 @@ import org.jivesoftware.smackx.mam.element.MamQueryIQ; /** * MAM result filter class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez and Florian Schmaus - * + * */ public class MamResultFilter extends FlexibleStanzaTypeFilter { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/package-info.java index d568f7d04..9d74f5e13 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/package-info.java @@ -17,9 +17,9 @@ /** * Filters of Message Archive Management (MAM) XEP-0313. - * + * * @see XEP-0313: Message * Archive Management - * + * */ package org.jivesoftware.smackx.mam.filter; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/package-info.java index 16b8b2b7b..c195b658a 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/package-info.java @@ -17,9 +17,9 @@ /** * XEP-0313: Message Archive Management. - * + * * @see XEP-0313: Message * Archive Management - * + * */ package org.jivesoftware.smackx.mam; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamFinIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamFinIQProvider.java index 155b9b94f..24239d01f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamFinIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamFinIQProvider.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MAM Fin IQ Provider class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamPrefsIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamPrefsIQProvider.java index 07d5ec1e5..4ba92404f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamPrefsIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamPrefsIQProvider.java @@ -32,11 +32,11 @@ import org.xmlpull.v1.XmlPullParserException; /** * MAM Preferences IQ Provider class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez - * + * */ public class MamPrefsIQProvider extends IQProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamQueryIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamQueryIQProvider.java index 663481890..c8de4c0fe 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamQueryIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamQueryIQProvider.java @@ -26,11 +26,11 @@ import org.xmlpull.v1.XmlPullParser; /** * MAM Query IQ Provider class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez - * + * */ public class MamQueryIQProvider extends IQProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamResultProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamResultProvider.java index f8c5d1282..f2ebdf87b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamResultProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamResultProvider.java @@ -26,11 +26,11 @@ import org.xmlpull.v1.XmlPullParser; /** * MAM Result Provider class. - * + * * @see XEP-0313: Message * Archive Management * @author Fernando Ramirez - * + * */ public class MamResultProvider extends ExtensionElementProvider { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/package-info.java index a6c1a20b4..96d477ba1 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/package-info.java @@ -17,9 +17,9 @@ /** * Provider classes of Message Archive Management (MAM) XEP-0313. - * + * * @see XEP-0313: Message * Archive Management - * + * */ package org.jivesoftware.smackx.mam.provider; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/element/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/element/package-info.java index 00c2ceabd..96a6583ed 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/element/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/element/package-info.java @@ -17,9 +17,9 @@ /** * XEP-0394: Message Markup. - * + * * @see XEP-0394: Message * Markup - * + * */ package org.jivesoftware.smackx.message_markup.element; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/package-info.java index 8aa10ce24..595d8e01e 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/package-info.java @@ -17,9 +17,9 @@ /** * XEP-0394: Message Markup. - * + * * @see XEP-0394: Message * Markup - * + * */ package org.jivesoftware.smackx.message_markup; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/provider/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/provider/package-info.java index f860b5b18..65d6e7316 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/provider/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/message_markup/provider/package-info.java @@ -17,9 +17,9 @@ /** * XEP-0394: Message Markup. - * + * * @see XEP-0394: Message * Markup - * + * */ package org.jivesoftware.smackx.message_markup.provider; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightAffiliation.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightAffiliation.java index 4a5e04384..dddb138fb 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightAffiliation.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightAffiliation.java @@ -20,7 +20,7 @@ import java.util.Locale; /** * MUCLight affiliations enum. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomConfiguration.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomConfiguration.java index 4bb32e81b..02c1791c9 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomConfiguration.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomConfiguration.java @@ -20,7 +20,7 @@ import java.util.HashMap; /** * MUC Light room configuration class. - * + * * @author Fernando Ramirez * */ @@ -32,7 +32,7 @@ public class MUCLightRoomConfiguration { /** * MUC Light room configuration model constructor. - * + * * @param roomName * @param subject * @param customConfigs @@ -45,7 +45,7 @@ public class MUCLightRoomConfiguration { /** * Returns the room name. - * + * * @return the name of the room. */ public String getRoomName() { @@ -54,7 +54,7 @@ public class MUCLightRoomConfiguration { /** * Returns the room subject. - * + * * @return the subject of the room. */ public String getSubject() { @@ -63,7 +63,7 @@ public class MUCLightRoomConfiguration { /** * Returns the room custom configurations. - * + * * @return the custom configurations of the room. */ public HashMap getCustomConfigs() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomInfo.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomInfo.java index 1de640ee0..f0b9deb07 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomInfo.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MUCLightRoomInfo.java @@ -34,7 +34,7 @@ public class MUCLightRoomInfo { /** * MUC Light room info model constructor. - * + * * @param version * @param roomJid * @param configuration @@ -50,7 +50,7 @@ public class MUCLightRoomInfo { /** * Returns the version. - * + * * @return the version */ public String getVersion() { @@ -68,7 +68,7 @@ public class MUCLightRoomInfo { /** * Returns the configuration. - * + * * @return the room configuration */ public MUCLightRoomConfiguration getConfiguration() { @@ -77,7 +77,7 @@ public class MUCLightRoomInfo { /** * Returns the room occupants. - * + * * @return the occupants of the room. */ public HashMap getOccupants() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLight.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLight.java index d292e302a..9588c8fa3 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLight.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLight.java @@ -53,7 +53,7 @@ import org.jxmpp.jid.Jid; /** * MUCLight class. - * + * * @author Fernando Ramirez */ public class MultiUserChatLight { @@ -255,7 +255,7 @@ public class MultiUserChatLight { /** * Create new MUCLight. - * + * * @param roomName * @param subject * @param customConfigs @@ -278,7 +278,7 @@ public class MultiUserChatLight { /** * Create new MUCLight. - * + * * @param roomName * @param occupants * @throws Exception @@ -289,7 +289,7 @@ public class MultiUserChatLight { /** * Leave the MUCLight. - * + * * @throws NotConnectedException * @throws InterruptedException * @throws NoResponseException @@ -310,7 +310,7 @@ public class MultiUserChatLight { /** * Get the MUC Light info. - * + * * @param version * @return the room info * @throws NoResponseException @@ -331,7 +331,7 @@ public class MultiUserChatLight { /** * Get the MUC Light info. - * + * * @return the room info * @throws NoResponseException * @throws XMPPErrorException @@ -345,7 +345,7 @@ public class MultiUserChatLight { /** * Get the MUC Light configuration. - * + * * @param version * @return the room configuration * @throws NoResponseException @@ -363,7 +363,7 @@ public class MultiUserChatLight { /** * Get the MUC Light configuration. - * + * * @return the room configuration * @throws NoResponseException * @throws XMPPErrorException @@ -377,7 +377,7 @@ public class MultiUserChatLight { /** * Get the MUC Light affiliations. - * + * * @param version * @return the room affiliations * @throws NoResponseException @@ -397,7 +397,7 @@ public class MultiUserChatLight { /** * Get the MUC Light affiliations. - * + * * @return the room affiliations * @throws NoResponseException * @throws XMPPErrorException @@ -411,7 +411,7 @@ public class MultiUserChatLight { /** * Change the MUC Light affiliations. - * + * * @param affiliations * @throws NoResponseException * @throws XMPPErrorException @@ -426,7 +426,7 @@ public class MultiUserChatLight { /** * Destroy the MUC Light. Only will work if it is requested by the owner. - * + * * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException @@ -444,7 +444,7 @@ public class MultiUserChatLight { /** * Change the subject of the MUC Light. - * + * * @param subject * @throws NoResponseException * @throws XMPPErrorException @@ -459,7 +459,7 @@ public class MultiUserChatLight { /** * Change the name of the room. - * + * * @param roomName * @throws NoResponseException * @throws XMPPErrorException @@ -474,7 +474,7 @@ public class MultiUserChatLight { /** * Set the room configurations. - * + * * @param customConfigs * @throws NoResponseException * @throws XMPPErrorException @@ -488,7 +488,7 @@ public class MultiUserChatLight { /** * Set the room configurations. - * + * * @param roomName * @param customConfigs * @throws NoResponseException diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLightManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLightManager.java index 67e8fdd77..e1c7d104b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLightManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/MultiUserChatLightManager.java @@ -43,7 +43,7 @@ import org.jxmpp.jid.Jid; /** * Multi-User Chat Light manager class. - * + * * @author Fernando Ramirez * */ @@ -157,7 +157,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Get users and rooms blocked. - * + * * @param mucLightService * @return the list of users and rooms blocked * @throws NoResponseException @@ -183,7 +183,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Get rooms blocked. - * + * * @param mucLightService * @return the list of rooms blocked * @throws NoResponseException @@ -205,7 +205,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Get users blocked. - * + * * @param mucLightService * @return the list of users blocked * @throws NoResponseException @@ -241,7 +241,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Block a room. - * + * * @param mucLightService * @param roomJid * @throws NoResponseException @@ -258,7 +258,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Block rooms. - * + * * @param mucLightService * @param roomsJids * @throws NoResponseException @@ -285,7 +285,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Block a user. - * + * * @param mucLightService * @param userJid * @throws NoResponseException @@ -302,7 +302,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Block users. - * + * * @param mucLightService * @param usersJids * @throws NoResponseException @@ -329,7 +329,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Unblock a room. - * + * * @param mucLightService * @param roomJid * @throws NoResponseException @@ -346,7 +346,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Unblock rooms. - * + * * @param mucLightService * @param roomsJids * @throws NoResponseException @@ -373,7 +373,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Unblock a user. - * + * * @param mucLightService * @param userJid * @throws NoResponseException @@ -390,7 +390,7 @@ public final class MultiUserChatLightManager extends Manager { /** * Unblock users. - * + * * @param mucLightService * @param usersJids * @throws NoResponseException diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightAffiliationsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightAffiliationsIQ.java index e82b8f600..1a817635f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightAffiliationsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightAffiliationsIQ.java @@ -30,7 +30,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light affiliations response IQ class. - * + * * @author Fernando Ramirez * */ @@ -44,7 +44,7 @@ public class MUCLightAffiliationsIQ extends IQ { /** * MUC Light affiliations response IQ constructor. - * + * * @param version * @param affiliations */ @@ -70,7 +70,7 @@ public class MUCLightAffiliationsIQ extends IQ { /** * Returns the version. - * + * * @return the version */ public String getVersion() { @@ -79,7 +79,7 @@ public class MUCLightAffiliationsIQ extends IQ { /** * Returns the room affiliations. - * + * * @return the affiliations of the room */ public HashMap getAffiliations() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightBlockingIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightBlockingIQ.java index e89a41516..18dd7019d 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightBlockingIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightBlockingIQ.java @@ -29,7 +29,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light blocking IQ class. - * + * * @author Fernando Ramirez * */ @@ -43,7 +43,7 @@ public class MUCLightBlockingIQ extends IQ { /** * MUC Light blocking IQ constructor. - * + * * @param rooms * @param users */ @@ -55,7 +55,7 @@ public class MUCLightBlockingIQ extends IQ { /** * Get rooms JIDs with booleans (true if allow, false if deny). - * + * * @return the rooms JIDs with booleans (true if allow, false if deny) */ public HashMap getRooms() { @@ -64,7 +64,7 @@ public class MUCLightBlockingIQ extends IQ { /** * Get users JIDs with booleans (true if allow, false if deny). - * + * * @return the users JIDs with booleans (true if allow, false if deny) */ public HashMap getUsers() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightChangeAffiliationsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightChangeAffiliationsIQ.java index 89bd8daf2..a4cc9e059 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightChangeAffiliationsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightChangeAffiliationsIQ.java @@ -30,7 +30,7 @@ import org.jxmpp.jid.Jid; /** * MUCLight change affiliations IQ class. - * + * * @author Fernando Ramirez * */ @@ -43,7 +43,7 @@ public class MUCLightChangeAffiliationsIQ extends IQ { /** * MUCLight change affiliations IQ constructor. - * + * * @param room * @param affiliations */ @@ -56,7 +56,7 @@ public class MUCLightChangeAffiliationsIQ extends IQ { /** * Get the affiliations. - * + * * @return the affiliations */ public HashMap getAffiliations() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightConfigurationIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightConfigurationIQ.java index e673fa865..d85f94601 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightConfigurationIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightConfigurationIQ.java @@ -24,7 +24,7 @@ import org.jivesoftware.smackx.muclight.element.MUCLightElements.ConfigurationEl /** * MUC Light configuration response IQ class. - * + * * @author Fernando Ramirez * */ @@ -38,7 +38,7 @@ public class MUCLightConfigurationIQ extends IQ { /** * MUC Light configuration response IQ constructor. - * + * * @param version * @param configuration */ @@ -58,7 +58,7 @@ public class MUCLightConfigurationIQ extends IQ { /** * Returns the version. - * + * * @return the version */ public String getVersion() { @@ -67,7 +67,7 @@ public class MUCLightConfigurationIQ extends IQ { /** * Returns the room configuration. - * + * * @return the configuration of the room */ public MUCLightRoomConfiguration getConfiguration() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightCreateIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightCreateIQ.java index ecdcaa057..29d19fedf 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightCreateIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightCreateIQ.java @@ -32,7 +32,7 @@ import org.jxmpp.jid.Jid; /** * MUCLight create IQ class. - * + * * @author Fernando Ramirez * */ @@ -46,7 +46,7 @@ public class MUCLightCreateIQ extends IQ { /** * MUCLight create IQ constructor. - * + * * @param room * @param roomName * @param subject @@ -69,7 +69,7 @@ public class MUCLightCreateIQ extends IQ { /** * MUCLight create IQ constructor. - * + * * @param room * @param roomName * @param occupants @@ -80,7 +80,7 @@ public class MUCLightCreateIQ extends IQ { /** * Get the room configuration. - * + * * @return the room configuration */ public MUCLightRoomConfiguration getConfiguration() { @@ -89,7 +89,7 @@ public class MUCLightCreateIQ extends IQ { /** * Get the room occupants. - * + * * @return the room occupants */ public HashMap getOccupants() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightDestroyIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightDestroyIQ.java index 6dd4f24bb..2ce6c1e7b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightDestroyIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightDestroyIQ.java @@ -24,7 +24,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light destroy IQ class. - * + * * @author Fernando Ramirez * */ @@ -35,7 +35,7 @@ public class MUCLightDestroyIQ extends IQ { /** * MUC Light destroy IQ constructor. - * + * * @param roomJid */ public MUCLightDestroyIQ(Jid roomJid) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightElements.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightElements.java index 0124e09de..f7c2a94b6 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightElements.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightElements.java @@ -36,7 +36,7 @@ public abstract class MUCLightElements { /** * Affiliations change extension element class. - * + * * @author Fernando Ramirez * */ @@ -68,7 +68,7 @@ public abstract class MUCLightElements { /** * Get the affiliations. - * + * * @return the affiliations */ public HashMap getAffiliations() { @@ -77,7 +77,7 @@ public abstract class MUCLightElements { /** * Get the previous version. - * + * * @return the previous version */ public String getPrevVersion() { @@ -86,7 +86,7 @@ public abstract class MUCLightElements { /** * Get the version. - * + * * @return the version */ public String getVersion() { @@ -119,7 +119,7 @@ public abstract class MUCLightElements { /** * Configurations change extension element class. - * + * * @author Fernando Ramirez * */ @@ -136,7 +136,7 @@ public abstract class MUCLightElements { /** * Configurations change extension constructor. - * + * * @param prevVersion * @param version * @param roomName @@ -164,7 +164,7 @@ public abstract class MUCLightElements { /** * Get the previous version. - * + * * @return the previous version */ public String getPrevVersion() { @@ -173,7 +173,7 @@ public abstract class MUCLightElements { /** * Get the version. - * + * * @return the version */ public String getVersion() { @@ -182,7 +182,7 @@ public abstract class MUCLightElements { /** * Get the room name. - * + * * @return the room name */ public String getRoomName() { @@ -191,7 +191,7 @@ public abstract class MUCLightElements { /** * Get the room subject. - * + * * @return the room subject */ public String getSubject() { @@ -200,7 +200,7 @@ public abstract class MUCLightElements { /** * Get the room custom configurations. - * + * * @return the room custom configurations */ public HashMap getCustomConfigs() { @@ -237,7 +237,7 @@ public abstract class MUCLightElements { /** * Configuration element class. - * + * * @author Fernando Ramirez * */ @@ -247,7 +247,7 @@ public abstract class MUCLightElements { /** * Configuration element constructor. - * + * * @param configuration */ public ConfigurationElement(MUCLightRoomConfiguration configuration) { @@ -278,7 +278,7 @@ public abstract class MUCLightElements { /** * Occupants element class. - * + * * @author Fernando Ramirez * */ @@ -288,7 +288,7 @@ public abstract class MUCLightElements { /** * Occupants element constructor. - * + * * @param occupants */ public OccupantsElement(HashMap occupants) { @@ -314,7 +314,7 @@ public abstract class MUCLightElements { /** * User with affiliation element class. - * + * * @author Fernando Ramirez * */ @@ -325,7 +325,7 @@ public abstract class MUCLightElements { /** * User with affiliations element constructor. - * + * * @param user * @param affiliation */ @@ -349,7 +349,7 @@ public abstract class MUCLightElements { /** * Blocking element class. - * + * * @author Fernando Ramirez * */ @@ -361,7 +361,7 @@ public abstract class MUCLightElements { /** * Blocking element constructor. - * + * * @param jid * @param allow * @param isRoom diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetAffiliationsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetAffiliationsIQ.java index 1d198faea..c3c611a04 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetAffiliationsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetAffiliationsIQ.java @@ -24,7 +24,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light get affiliations IQ class. - * + * * @author Fernando Ramirez * */ @@ -37,7 +37,7 @@ public class MUCLightGetAffiliationsIQ extends IQ { /** * MUC Light get affiliations IQ constructor. - * + * * @param roomJid * @param version */ @@ -50,7 +50,7 @@ public class MUCLightGetAffiliationsIQ extends IQ { /** * MUC Light get affiliations IQ constructor. - * + * * @param roomJid */ public MUCLightGetAffiliationsIQ(Jid roomJid) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetConfigsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetConfigsIQ.java index 1e8dca964..fc26e1484 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetConfigsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetConfigsIQ.java @@ -24,7 +24,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light get configurations IQ class. - * + * * @author Fernando Ramirez * */ @@ -37,7 +37,7 @@ public class MUCLightGetConfigsIQ extends IQ { /** * MUC Light get configurations IQ constructor. - * + * * @param roomJid * @param version */ @@ -50,7 +50,7 @@ public class MUCLightGetConfigsIQ extends IQ { /** * MUC Light get configurations IQ constructor. - * + * * @param roomJid */ public MUCLightGetConfigsIQ(Jid roomJid) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetInfoIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetInfoIQ.java index 70b03db06..8874d7ba5 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetInfoIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightGetInfoIQ.java @@ -24,7 +24,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light get info IQ class. - * + * * @author Fernando Ramirez * */ @@ -37,7 +37,7 @@ public class MUCLightGetInfoIQ extends IQ { /** * MUC Light get info IQ constructor. - * + * * @param roomJid * @param version */ @@ -50,7 +50,7 @@ public class MUCLightGetInfoIQ extends IQ { /** * MUC Light get info IQ constructor. - * + * * @param roomJid */ public MUCLightGetInfoIQ(Jid roomJid) { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightInfoIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightInfoIQ.java index af01bd01f..2a9736422 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightInfoIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightInfoIQ.java @@ -30,7 +30,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light info response IQ class. - * + * * @author Fernando Ramirez * */ @@ -45,7 +45,7 @@ public class MUCLightInfoIQ extends IQ { /** * MUCLight info response IQ constructor. - * + * * @param version * @param configuration * @param occupants @@ -69,7 +69,7 @@ public class MUCLightInfoIQ extends IQ { /** * Returns the version. - * + * * @return the version */ public String getVersion() { @@ -78,7 +78,7 @@ public class MUCLightInfoIQ extends IQ { /** * Returns the room configuration. - * + * * @return the configuration of the room */ public MUCLightRoomConfiguration getConfiguration() { @@ -87,7 +87,7 @@ public class MUCLightInfoIQ extends IQ { /** * Returns the room occupants. - * + * * @return the occupants of the room */ public HashMap getOccupants() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightSetConfigsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightSetConfigsIQ.java index a63ecab10..b481b64b9 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightSetConfigsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/MUCLightSetConfigsIQ.java @@ -28,7 +28,7 @@ import org.jxmpp.jid.Jid; /** * MUC Light set configurations IQ class. - * + * * @author Fernando Ramirez * */ @@ -43,7 +43,7 @@ public class MUCLightSetConfigsIQ extends IQ { /** * MUC Light set configuration IQ constructor. - * + * * @param roomJid * @param roomName * @param subject @@ -60,7 +60,7 @@ public class MUCLightSetConfigsIQ extends IQ { /** * MUC Light set configuration IQ constructor. - * + * * @param roomJid * @param roomName * @param customConfigs diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/package-info.java index c51b2119d..a8efa5f7d 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/element/package-info.java @@ -16,10 +16,10 @@ */ /** * Multi-User Chat Light (MUC Light) elements. - * + * * @see * XEP-xxxx: Multi-User Chat Light - * + * */ package org.jivesoftware.smackx.muclight.element; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/package-info.java index 7fa6c4772..f2200747e 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/package-info.java @@ -16,10 +16,10 @@ */ /** * Classes and Interfaces that implement Multi-User Chat Light (MUC Light). - * + * * @see * XEP-xxxx: Multi-User Chat Light - * + * */ package org.jivesoftware.smackx.muclight; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsChangeProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsChangeProvider.java index 84b831be8..b2ef71fea 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsChangeProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsChangeProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MUC Light Affiliations Change Provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsIQProvider.java index 62c41b2ed..3f9d470a4 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightAffiliationsIQProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MUC Light affiliations IQ provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightBlockingIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightBlockingIQProvider.java index 89b058ae7..ed5cd132b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightBlockingIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightBlockingIQProvider.java @@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * MUC Light blocking IQ provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationIQProvider.java index 48af0d66e..ad6f569f7 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationIQProvider.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MUC Light configuration IQ provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationsChangeProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationsChangeProvider.java index 1785bfc7f..e62a7f566 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationsChangeProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightConfigurationsChangeProvider.java @@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MUC Light configurations change provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightInfoIQProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightInfoIQProvider.java index c58c73043..72b6fc2e2 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightInfoIQProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/MUCLightInfoIQProvider.java @@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParser; /** * MUC Light info IQ provider class. - * + * * @author Fernando Ramirez * */ diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/package-info.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/package-info.java index e879013df..dafd95d65 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/package-info.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/muclight/provider/package-info.java @@ -16,10 +16,10 @@ */ /** * Multi-User Chat Light (MUC Light) providers. - * + * * @see * XEP-xxxx: Multi-User Chat Light - * + * */ package org.jivesoftware.smackx.muclight.provider; diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/PushNotificationsManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/PushNotificationsManager.java index 44e080c96..a95a21c4b 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/PushNotificationsManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/PushNotificationsManager.java @@ -39,11 +39,11 @@ import org.jxmpp.jid.Jid; /** * Push Notifications manager class. - * + * * @see XEP-0357: Push * Notifications * @author Fernando Ramirez - * + * */ public final class PushNotificationsManager extends Manager { @@ -97,7 +97,7 @@ public final class PushNotificationsManager extends Manager { /** * Enable push notifications. - * + * * @param pushJid * @param node * @return true if it was successfully enabled, false if not @@ -113,7 +113,7 @@ public final class PushNotificationsManager extends Manager { /** * Enable push notifications. - * + * * @param pushJid * @param node * @param publishOptions @@ -132,7 +132,7 @@ public final class PushNotificationsManager extends Manager { /** * Disable all push notifications. - * + * * @param pushJid * @return true if it was successfully disabled, false if not * @throws NoResponseException @@ -147,7 +147,7 @@ public final class PushNotificationsManager extends Manager { /** * Disable push notifications of an specific node. - * + * * @param pushJid * @param node * @return true if it was successfully disabled, false if not diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/DisablePushNotificationsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/DisablePushNotificationsIQ.java index cb2630ad8..bedf8be02 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/DisablePushNotificationsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/DisablePushNotificationsIQ.java @@ -22,11 +22,11 @@ import org.jxmpp.jid.Jid; /** * Disable Push Notifications IQ. - * + * * @see XEP-0357: Push * Notifications * @author Fernando Ramirez - * + * */ public class DisablePushNotificationsIQ extends IQ { @@ -56,7 +56,7 @@ public class DisablePushNotificationsIQ extends IQ { /** * Get the JID. - * + * * @return the JID */ public Jid getJid() { @@ -65,7 +65,7 @@ public class DisablePushNotificationsIQ extends IQ { /** * Get the node. - * + * * @return the node */ public String getNode() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/EnablePushNotificationsIQ.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/EnablePushNotificationsIQ.java index a63b779a3..5dcf891e2 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/EnablePushNotificationsIQ.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/EnablePushNotificationsIQ.java @@ -30,11 +30,11 @@ import org.jxmpp.jid.Jid; /** * Enable Push Notifications IQ. - * + * * @see XEP-0357: Push * Notifications * @author Fernando Ramirez - * + * */ public class EnablePushNotificationsIQ extends IQ { @@ -66,7 +66,7 @@ public class EnablePushNotificationsIQ extends IQ { /** * Get the JID. - * + * * @return the JID */ public Jid getJid() { @@ -75,7 +75,7 @@ public class EnablePushNotificationsIQ extends IQ { /** * Get the node. - * + * * @return the node */ public String getNode() { @@ -84,7 +84,7 @@ public class EnablePushNotificationsIQ extends IQ { /** * Get the publish options. - * + * * @return the publish options */ public HashMap getPublishOptions() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/PushNotificationsElements.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/PushNotificationsElements.java index c90a8bd1e..e16831afd 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/PushNotificationsElements.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/PushNotificationsElements.java @@ -26,11 +26,11 @@ import org.jxmpp.jid.Jid; /** * Push Notifications elements. - * + * * @see XEP-0357: Push * Notifications * @author Fernando Ramirez - * + * */ public class PushNotificationsElements { @@ -61,7 +61,7 @@ public class PushNotificationsElements { /** * Get the node. - * + * * @return the node */ public String getNode() { @@ -70,7 +70,7 @@ public class PushNotificationsElements { /** * Get the user JID. - * + * * @return the user JID */ public Jid getUserJid() { diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/RemoteDisablingProvider.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/RemoteDisablingProvider.java index 946489440..501e2b15c 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/RemoteDisablingProvider.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/RemoteDisablingProvider.java @@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Push Notifications Remote Disabling Provider class. - * + * * @see XEP-0357: Push * Notifications * @author Fernando Ramirez diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/GroupChatInvitationTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/GroupChatInvitationTest.java index 0be7e0d83..cb6ad1716 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/GroupChatInvitationTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/GroupChatInvitationTest.java @@ -24,8 +24,8 @@ import org.jivesoftware.smack.filter.PacketFilter; import org.jivesoftware.smack.filter.StanzaExtensionFilter; /** - * - * + * + * * @author Matt Tucker */ public class GroupChatInvitationTest extends SmackTestCase { diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/MessageEventManagerTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/MessageEventManagerTest.java index 20567d787..8f117b04e 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/MessageEventManagerTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/MessageEventManagerTest.java @@ -37,10 +37,10 @@ public class MessageEventManagerTest extends SmackTestCase { /** * High level API test. - * This is a simple test to use with an XMPP client and check if the client receives the + * This is a simple test to use with an XMPP client and check if the client receives the * message * 1. User_1 will send a message to user_2 requesting to be notified when any of these events - * occurs: offline, composing, displayed or delivered + * occurs: offline, composing, displayed or delivered */ public void testSendMessageEventRequest() { // Create a chat for each connection @@ -64,10 +64,10 @@ public class MessageEventManagerTest extends SmackTestCase { /** * High level API test. - * This is a simple test to use with an XMPP client, check if the client receives the + * This is a simple test to use with an XMPP client, check if the client receives the * message and display in the console any notification * 1. User_1 will send a message to user_2 requesting to be notified when any of these events - * occurs: offline, composing, displayed or delivered + * occurs: offline, composing, displayed or delivered * 2. User_2 will use an XMPP client (like Exodus) to display the message and compose a reply * 3. User_1 will display any notification that receives */ @@ -120,9 +120,9 @@ public class MessageEventManagerTest extends SmackTestCase { /** * High level API test. * 1. User_1 will send a message to user_2 requesting to be notified when any of these events - * occurs: offline, composing, displayed or delivered + * occurs: offline, composing, displayed or delivered * 2. User_2 will receive the message - * 3. User_2 will simulate that the message was displayed + * 3. User_2 will simulate that the message was displayed * 4. User_2 will simulate that he/she is composing a reply * 5. User_2 will simulate that he/she has cancelled the reply */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/RosterExchangeManagerTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/RosterExchangeManagerTest.java index 9c26f40ec..a5589e43a 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/RosterExchangeManagerTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/RosterExchangeManagerTest.java @@ -43,7 +43,7 @@ public class RosterExchangeManagerTest extends SmackTestCase { /** * High level API test. - * This is a simple test to use with an XMPP client and check if the client receives user1's + * This is a simple test to use with an XMPP client and check if the client receives user1's * roster * 1. User_1 will send his/her roster to user_2 */ @@ -62,7 +62,7 @@ public class RosterExchangeManagerTest extends SmackTestCase { /** * High level API test. - * This is a simple test to use with an XMPP client and check if the client receives user1's + * This is a simple test to use with an XMPP client and check if the client receives user1's * roster groups * 1. User_1 will send his/her RosterGroups to user_2 */ @@ -84,7 +84,7 @@ public class RosterExchangeManagerTest extends SmackTestCase { * High level API test. * 1. User_1 will send his/her roster to user_2 * 2. User_2 will receive the entries and iterate over them to check if everything is fine - * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then + * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then * something is wrong */ public void testSendAndReceiveRoster() { @@ -132,9 +132,9 @@ public class RosterExchangeManagerTest extends SmackTestCase { /** * High level API test. * 1. User_1 will send his/her roster to user_2 - * 2. User_2 will automatically add the entries that receives to his/her roster in the + * 2. User_2 will automatically add the entries that receives to his/her roster in the * corresponding group - * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then + * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then * something is wrong */ public void testSendAndAcceptRoster() { diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/ServiceDiscoveryManagerTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/ServiceDiscoveryManagerTest.java index 1dc257ccb..1a0b76d87 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/ServiceDiscoveryManagerTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/ServiceDiscoveryManagerTest.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.packet.DiscoverInfo.Identity; /** * Tests the service discovery functionality. - * + * * @author Gaston Dombiak */ public class ServiceDiscoveryManagerTest extends SmackTestCase { @@ -37,7 +37,7 @@ public class ServiceDiscoveryManagerTest extends SmackTestCase { } /** - * Tests info discovery of a Smack client. + * Tests info discovery of a Smack client. */ public void testSmackInfo() { @@ -86,7 +86,7 @@ public class ServiceDiscoveryManagerTest extends SmackTestCase { } /** - * Tests service discovery of XHTML support. + * Tests service discovery of XHTML support. */ public void testXHTMLFeature() { // Check for local XHTML service support @@ -94,17 +94,17 @@ public class ServiceDiscoveryManagerTest extends SmackTestCase { assertTrue(XHTMLManager.isServiceEnabled(getConnection(0))); assertTrue(XHTMLManager.isServiceEnabled(getConnection(1))); // Check for XHTML support in connection1 from connection2 - // Must specify a full JID and not a bare JID. Ensure that the server is working ok. + // Must specify a full JID and not a bare JID. Ensure that the server is working ok. assertFalse(XHTMLManager.isServiceEnabled(getConnection(1), getBareJID(0))); - // Using a full JID check that the other client supports XHTML. + // Using a full JID check that the other client supports XHTML. assertTrue(XHTMLManager.isServiceEnabled(getConnection(1), getFullJID(0))); // Disable the XHTML Message support in connection1 XHTMLManager.setServiceEnabled(getConnection(0), false); - // Check for local XHTML service support + // Check for local XHTML service support assertFalse(XHTMLManager.isServiceEnabled(getConnection(0))); assertTrue(XHTMLManager.isServiceEnabled(getConnection(1))); - // Check for XHTML support in connection1 from connection2 + // Check for XHTML support in connection1 from connection2 assertFalse(XHTMLManager.isServiceEnabled(getConnection(1), getFullJID(0))); } diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/XHTMLManagerTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/XHTMLManagerTest.java index afea6f1d5..00e52c040 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/XHTMLManagerTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/XHTMLManagerTest.java @@ -82,9 +82,9 @@ public class XHTMLManagerTest extends SmackTestCase { /** * High level API test. * 1. User_1 will send a message with XHTML to user_2 - * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything + * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything * is fine - * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then + * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then * something is wrong */ public void testSendSimpleXHTMLMessageAndDisplayReceivedXHTMLMessage() { @@ -142,9 +142,9 @@ public class XHTMLManagerTest extends SmackTestCase { /** * Low level API test. Test a message with two XHTML bodies and several XHTML tags. * 1. User_1 will send a message with XHTML to user_2 - * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything + * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything * is fine - * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then + * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then * something is wrong */ public void testSendComplexXHTMLMessageAndDisplayReceivedXHTMLMessage() { diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamTest.java index fa21488db..81a8e80ac 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamTest.java @@ -34,7 +34,7 @@ import org.jivesoftware.smackx.bytestreams.ibb.packet.Open; /** * Test for In-Band Bytestreams with real XMPP servers. - * + * * @author Henning Staib */ public class InBandBytestreamTest extends SmackTestCase { @@ -49,7 +49,7 @@ public class InBandBytestreamTest extends SmackTestCase { /** * Target should respond with not-acceptable error if no listeners for incoming In-Band * Bytestream requests are registered. - * + * * @throws XMPPException should not happen */ public void testRespondWithErrorOnInBandBytestreamRequest() throws XMPPException { @@ -73,7 +73,7 @@ public class InBandBytestreamTest extends SmackTestCase { /** * An In-Band Bytestream should be successfully established using IQ stanzas. - * + * * @throws Exception should not happen */ public void testInBandBytestreamWithIQStanzas() throws Exception { @@ -127,7 +127,7 @@ public class InBandBytestreamTest extends SmackTestCase { /** * An In-Band Bytestream should be successfully established using message stanzas. - * + * * @throws Exception should not happen */ public void testInBandBytestreamWithMessageStanzas() throws Exception { @@ -183,7 +183,7 @@ public class InBandBytestreamTest extends SmackTestCase { /** * An In-Band Bytestream should be successfully established using IQ stanzas. The established * session should transfer data bidirectional. - * + * * @throws Exception should not happen */ public void testBiDirectionalInBandBytestream() throws Exception { diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamTest.java index 1486fdffc..7ea04dafb 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamTest.java @@ -40,14 +40,14 @@ import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream; /** * Test for Socks5 bytestreams with real XMPP servers. - * + * * @author Henning Staib */ public class Socks5ByteStreamTest extends SmackTestCase { /** * Constructor - * + * * @param arg0 */ public Socks5ByteStreamTest(String arg0) { @@ -56,7 +56,7 @@ public class Socks5ByteStreamTest extends SmackTestCase { /** * Socks5 feature should be added to the service discovery on Smack startup. - * + * * @throws XMPPException should not happen */ public void testInitializationSocks5FeaturesAndListenerOnStartup() throws XMPPException { @@ -70,7 +70,7 @@ public class Socks5ByteStreamTest extends SmackTestCase { /** * Target should respond with not-acceptable error if no listeners for incoming Socks5 * bytestream requests are registered. - * + * * @throws XMPPException should not happen */ public void testRespondWithErrorOnSocks5BytestreamRequest() throws XMPPException { @@ -94,7 +94,7 @@ public class Socks5ByteStreamTest extends SmackTestCase { /** * Socks5 bytestream should be successfully established using the local Socks5 proxy. - * + * * @throws Exception should not happen */ public void testSocks5BytestreamWithLocalSocks5Proxy() throws Exception { @@ -162,7 +162,7 @@ public class Socks5ByteStreamTest extends SmackTestCase { * This test will fail if the XMPP server doesn't provide any Socks5 proxies or the Socks5 proxy * only allows Socks5 bytestreams in the context of a file transfer (like Openfire in default * configuration, see xmpp.proxy.transfer.required flag). - * + * * @throws Exception if no Socks5 proxies found or proxy is unwilling to activate Socks5 * bytestream */ @@ -237,7 +237,7 @@ public class Socks5ByteStreamTest extends SmackTestCase { * This test will fail if the XMPP server doesn't provide any Socks5 proxies or the Socks5 proxy * only allows Socks5 bytestreams in the context of a file transfer (like Openfire in default * configuration, see xmpp.proxy.transfer.required flag). - * + * * @throws Exception if no Socks5 proxies found or proxy is unwilling to activate Socks5 * bytestream */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/muc/MultiUserChatTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/muc/MultiUserChatTest.java index 0f3e66942..de59db883 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/muc/MultiUserChatTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/muc/MultiUserChatTest.java @@ -48,7 +48,7 @@ import org.jivesoftware.smackx.packet.XHTMLExtension; /** * Tests the new MUC functionalities. - * + * * @author Gaston Dombiak */ public class MultiUserChatTest extends SmackTestCase { @@ -67,7 +67,7 @@ public class MultiUserChatTest extends SmackTestCase { */ public void testGroupchatCompatibility() { // TODO: this test needs to be re-written so that it manually emulates the old-style - // TODO: group chat protocol. Tne GroupChat class was deleted for Smack 3.0. + // TODO: group chat protocol. Tne GroupChat class was deleted for Smack 3.0. /*try { Message message; @@ -132,7 +132,7 @@ public class MultiUserChatTest extends SmackTestCase { System.out.println(UTC_FORMAT.format(delay.getStamp())); assertEquals("Body of first message is incorrect", "Message 3", msg.getBody()); - // Try to get second historic message + // Try to get second historic message msg = muc2.nextMessage(1000); assertNull("Second message is not null", msg); @@ -143,15 +143,15 @@ public class MultiUserChatTest extends SmackTestCase { history.setMaxStanzas(2); muc3.join("testbot3", null, history, SmackConfiguration.getPacketReplyTimeout()); - // Get first historic message + // Get first historic message msg = muc3.nextMessage(1000); assertNotNull("First message is null", msg); assertEquals("Body of first message is incorrect", "Message 2", msg.getBody()); - // Get second historic message + // Get second historic message msg = muc3.nextMessage(1000); assertNotNull("Second message is null", msg); assertEquals("Body of second message is incorrect", "Message 3", msg.getBody()); - // Try to get third historic message + // Try to get third historic message msg = muc3.nextMessage(1000); assertNull("Third message is not null", msg); @@ -451,7 +451,7 @@ public class MultiUserChatTest extends SmackTestCase { } }); - // Start a private chat with another participant + // Start a private chat with another participant Chat chat = muc2.createPrivateChat(room + "/testbot", null); StanzaCollector collector = chat.createCollector(); chat.sendMessage("Hello there"); @@ -598,7 +598,7 @@ public class MultiUserChatTest extends SmackTestCase { } }); - // Check that a 403 error is received when a not allowed user tries to change the + // Check that a 403 error is received when a not allowed user tries to change the // subject in a room try { muc2.changeSubject("New Subject2"); @@ -615,7 +615,7 @@ public class MultiUserChatTest extends SmackTestCase { xmppError.getCode()); } - // Check that every MUC updates its subject when an allowed user changes the subject + // Check that every MUC updates its subject when an allowed user changes the subject // in a room muc.changeSubject("New Subject1"); Thread.sleep(300); @@ -651,7 +651,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will lister for his own "kicking" + // User2 will lister for his own "kicking" muc2.addUserStatusListener(new DefaultUserStatusListener() { public void kicked(String actor, String reason) { super.kicked(actor, reason); @@ -663,7 +663,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's "kicking" + // User3 will lister for user2's "kicking" muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void kicked(String participant, String actor, String reason) { super.kicked(participant, actor, reason); @@ -728,7 +728,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will lister for his own "banning" + // User2 will lister for his own "banning" muc2.addUserStatusListener(new DefaultUserStatusListener() { public void banned(String actor, String reason) { super.banned(actor, reason); @@ -740,7 +740,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's "banning" + // User3 will lister for user2's "banning" muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void banned(String participant, String actor, String reason) { super.banned(participant, actor, reason); @@ -808,7 +808,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room (as a visitor) MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will listen for his own "voice" + // User2 will listen for his own "voice" muc2.addUserStatusListener(new DefaultUserStatusListener() { public void voiceGranted() { super.voiceGranted(); @@ -823,7 +823,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room (as a visitor) MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's "voice" + // User3 will lister for user2's "voice" muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void voiceGranted(String participant) { super.voiceGranted(participant); @@ -898,7 +898,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room (as a visitor) MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will listen for moderator privileges + // User2 will listen for moderator privileges muc2.addUserStatusListener(new DefaultUserStatusListener() { public void voiceGranted() { super.voiceGranted(); @@ -921,7 +921,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room (as a visitor) MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's moderator privileges + // User3 will lister for user2's moderator privileges muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void voiceGranted(String participant) { super.voiceGranted(participant); @@ -1045,7 +1045,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room (as a visitor) MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will listen for membership privileges + // User2 will listen for membership privileges muc2.addUserStatusListener(new DefaultUserStatusListener() { public void membershipGranted() { super.membershipGranted(); @@ -1060,7 +1060,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room (as a visitor) MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's membership privileges + // User3 will lister for user2's membership privileges muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void membershipGranted(String participant) { super.membershipGranted(participant); @@ -1139,7 +1139,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room (as a visitor) MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will listen for admin privileges + // User2 will listen for admin privileges muc2.addUserStatusListener(new DefaultUserStatusListener() { public void membershipGranted() { super.membershipGranted(); @@ -1162,7 +1162,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room (as a visitor) MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's admin privileges + // User3 will lister for user2's admin privileges muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void membershipGranted(String participant) { super.membershipGranted(participant); @@ -1298,7 +1298,7 @@ public class MultiUserChatTest extends SmackTestCase { // User2 joins the new room (as a visitor) MultiUserChat muc2 = new MultiUserChat(getConnection(1), room); muc2.join("testbot2"); - // User2 will listen for ownership privileges + // User2 will listen for ownership privileges muc2.addUserStatusListener(new DefaultUserStatusListener() { public void membershipGranted() { super.membershipGranted(); @@ -1329,7 +1329,7 @@ public class MultiUserChatTest extends SmackTestCase { // User3 joins the new room (as a visitor) MultiUserChat muc3 = new MultiUserChat(getConnection(2), room); muc3.join("testbot3"); - // User3 will lister for user2's ownership privileges + // User3 will lister for user2's ownership privileges muc3.addParticipantStatusListener(new DefaultParticipantStatusListener() { public void membershipGranted(String participant) { super.membershipGranted(participant); @@ -1624,7 +1624,7 @@ public class MultiUserChatTest extends SmackTestCase { } /** - * Check that ParticipantStatusListener is receiving joining and leaving events correctly. + * Check that ParticipantStatusListener is receiving joining and leaving events correctly. */ public void testJoinLeftEvents() { final String[] answer = new String[8]; diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/MessageEventTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/MessageEventTest.java index 83f3e0cd8..e34b04301 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/MessageEventTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/MessageEventTest.java @@ -36,10 +36,10 @@ public class MessageEventTest extends SmackTestCase { /** * Low level API test. - * This is a simple test to use with an XMPP client and check if the client receives the + * This is a simple test to use with an XMPP client and check if the client receives the * message * 1. User_1 will send a message to user_2 requesting to be notified when any of these events - * occurs: offline, composing, displayed or delivered + * occurs: offline, composing, displayed or delivered */ public void testSendMessageEventRequest() { // Create a chat for each connection @@ -70,10 +70,10 @@ public class MessageEventTest extends SmackTestCase { /** * Low level API test. - * This is a simple test to use with an XMPP client, check if the client receives the + * This is a simple test to use with an XMPP client, check if the client receives the * message and display in the console any notification * 1. User_1 will send a message to user_2 requesting to be notified when any of these events - * occurs: offline, composing, displayed or delivered + * occurs: offline, composing, displayed or delivered * 2. User_2 will use an XMPP client (like Exodus) to display the message and compose a reply * 3. User_1 will display any notification that receives */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/XHTMLExtensionTest.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/XHTMLExtensionTest.java index 8d5d01c40..fe447c9c0 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/XHTMLExtensionTest.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/packet/XHTMLExtensionTest.java @@ -139,7 +139,7 @@ public class XHTMLExtensionTest extends SmackTestCase { final StanzaCollector chat2 = getConnection(1).createStanzaCollector( new ThreadFilter(chat1.getThreadID())); - // Create a Listener that listens for Messages with the extension + // Create a Listener that listens for Messages with the extension //"http://jabber.org/protocol/xhtml-im" // This listener will listen on the conn2 and answer an ACK if everything is ok PacketFilter packetFilter = diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtension.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtension.java index db74663cc..63f66e646 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtension.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtension.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; import org.jivesoftware.smack.packet.PacketExtension; /** - * + * * @author Robin Collier * */ @@ -56,7 +56,7 @@ class CarExtension implements PacketExtension public String toXML() { - return "<" + getElementName() + " xmlns='" + getNamespace() + "'>"; } diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtensionProvider.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtensionProvider.java index f266a03e0..795dad80d 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtensionProvider.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/CarExtensionProvider.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.provider.PacketExtensionProvider; import org.xmlpull.v1.XmlPullParser; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/EntityUseCases.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/EntityUseCases.java index d70379e24..28fc3ad4c 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/EntityUseCases.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/EntityUseCases.java @@ -25,7 +25,7 @@ import org.jivesoftware.smackx.packet.DiscoverInfo.Identity; import org.jivesoftware.smackx.pubsub.test.SingleUserTestCase; /** - * + * * @author Robin Collier * */ @@ -76,7 +76,7 @@ public class EntityUseCases extends SingleUserTestCase assertTrue(subscriptions.size() < 3); - for (Subscription subscription : subscriptions) + for (Subscription subscription : subscriptions) { assertNull(subscription.getNode()); } diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/MultiUserSubscriptionUseCases.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/MultiUserSubscriptionUseCases.java index 32c025ede..69dd6a483 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/MultiUserSubscriptionUseCases.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/MultiUserSubscriptionUseCases.java @@ -24,7 +24,7 @@ import org.jivesoftware.smack.packet.XMPPError; import org.jivesoftware.smackx.pubsub.test.PubSubTestCase; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/OwnerUseCases.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/OwnerUseCases.java index 5eef138cb..9d7c1056a 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/OwnerUseCases.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/OwnerUseCases.java @@ -22,7 +22,7 @@ import org.jivesoftware.smack.XMPPException; import org.jivesoftware.smackx.pubsub.test.SingleUserTestCase; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/PublisherUseCases.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/PublisherUseCases.java index 744cbc7c1..45c521822 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/PublisherUseCases.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/PublisherUseCases.java @@ -26,7 +26,7 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; import org.jivesoftware.smackx.pubsub.test.SingleUserTestCase; /** - * + * * @author Robin Collier * */ @@ -69,9 +69,9 @@ public class PublisherUseCases extends SingleUserTestCase public void testSendNodeTrPay_WithPayload() throws XMPPException { LeafNode node = getPubnode(false, true); - node.send(new PayloadItem(null, + node.send(new PayloadItem(null, new SimplePayload("book", "pubsub:test:book", "Lord of the Rings"))); - node.send(new PayloadItem("test" + System.currentTimeMillis(), + node.send(new PayloadItem("test" + System.currentTimeMillis(), new SimplePayload("book", "pubsub:test:book", "Two Towers"))); } @@ -80,18 +80,18 @@ public class PublisherUseCases extends SingleUserTestCase LeafNode node = getPubnode(true, false); node.send(new Item()); node.send(new Item("test" + System.currentTimeMillis())); - node.send(new PayloadItem(null, + node.send(new PayloadItem(null, new SimplePayload("book", "pubsub:test:book", "Lord of the Rings"))); - node.send(new PayloadItem("test" + System.currentTimeMillis(), + node.send(new PayloadItem("test" + System.currentTimeMillis(), new SimplePayload("book", "pubsub:test:book", "Two Towers"))); } public void testSendPerPay_WithPayload() throws Exception { LeafNode node = getPubnode(true, true); - node.send(new PayloadItem(null, + node.send(new PayloadItem(null, new SimplePayload("book", "pubsub:test:book", "Lord of the Rings"))); - node.send(new PayloadItem("test" + System.currentTimeMillis(), + node.send(new PayloadItem("test" + System.currentTimeMillis(), new SimplePayload("book", "pubsub:test:book", "Two Towers"))); } diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/SubscriberUseCases.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/SubscriberUseCases.java index d909a4e90..c6580e30c 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/SubscriberUseCases.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/SubscriberUseCases.java @@ -30,7 +30,7 @@ import org.jivesoftware.smackx.FormField; import org.jivesoftware.smackx.pubsub.test.SingleUserTestCase; /** - * + * * @author Robin Collier * */ @@ -138,17 +138,17 @@ public class SubscriberUseCases extends SingleUserTestCase } // public void testSubscribeWithConfig() throws Exception -// { +// { // LeafNode node = getPubnode(false, false); // // Subscription sub = node.subscribe(getBareJID(0)); -// +// // assertEquals(getBareJID(0), sub.getJid()); // assertNotNull(sub.getId()); // assertEquals(node.getId(), sub.getNode()); // assertEquals(true, sub.isConfigRequired()); // } -// +// public void testGetItems() throws Exception { LeafNode node = getPubnode(true, false); @@ -197,7 +197,7 @@ public class SubscriberUseCases extends SingleUserTestCase List> payloadItems = payloadNode.getItems(); Map> idMap = new HashMap>(); - for (PayloadItem payloadItem : payloadItems) + for (PayloadItem payloadItem : payloadItems) { idMap.put(payloadItem.getId(), payloadItem); } @@ -262,9 +262,9 @@ public class SubscriberUseCases extends SingleUserTestCase assertTrue(listContainsId("5", items)); } - private static boolean listContainsId(String id, List items) + private static boolean listContainsId(String id, List items) { - for (Item item : items) + for (Item item : items) { if (item.getId().equals(id)) return true; diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestAPI.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestAPI.java index c12d8f0f6..1124d4018 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestAPI.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestAPI.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.XMPPException; import org.jivesoftware.smackx.pubsub.test.SingleUserTestCase; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestEvents.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestEvents.java index 259eb3f18..8b8fa6b10 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestEvents.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestEvents.java @@ -32,7 +32,7 @@ import org.jivesoftware.smackx.pubsub.listener.ItemEventListener; import org.jivesoftware.smackx.pubsub.listener.NodeConfigListener; /** - * + * * @author Robin Collier * */ @@ -97,7 +97,7 @@ public class TestEvents extends SmackTestCase subNode.subscribe(getConnection(1).getUser()); subNode.addConfigurationListener(sub1Handler); - ConfigureForm currentConfig = creatorNode.getNodeConfiguration(); + ConfigureForm currentConfig = creatorNode.getNodeConfiguration(); ConfigureForm form = new ConfigureForm(currentConfig.createAnswerForm()); form.setPersistentItems(true); form.setDeliverPayloads(false); @@ -108,7 +108,7 @@ public class TestEvents extends SmackTestCase assertEquals(nodeId, event.getNode()); assertNull(event.getConfiguration()); - currentConfig = creatorNode.getNodeConfiguration(); + currentConfig = creatorNode.getNodeConfiguration(); form = new ConfigureForm(currentConfig.createAnswerForm()); form.setDeliverPayloads(true); creatorNode.sendConfigurationForm(form); @@ -205,7 +205,7 @@ public class TestEvents extends SmackTestCase /* * For this test, the following extension needs to be added to the meta-inf/smack.providers file - * + * * * car * pubsub:test:vehicle @@ -585,7 +585,7 @@ public class TestEvents extends SmackTestCase } } - private static LeafNode getPubnode(PubSubManager manager, String id, boolean persistItems, boolean deliverPayload) + private static LeafNode getPubnode(PubSubManager manager, String id, boolean persistItems, boolean deliverPayload) throws XMPPException { ConfigureForm form = new ConfigureForm(FormType.submit); diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestMessageContent.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestMessageContent.java index 3a302c43c..68da09668 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestMessageContent.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/TestMessageContent.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; import junit.framework.TestCase; /** - * + * * @author Robin Collier * */ @@ -27,7 +27,7 @@ public class TestMessageContent extends TestCase { String payloadXmlWithNS = ""; - public void testItemWithId() + public void testItemWithId() { Item item = new Item("123"); assertEquals("", item.toXML()); @@ -35,7 +35,7 @@ public class TestMessageContent extends TestCase assertNull(item.getNamespace()); } - public void testItemWithNoId() + public void testItemWithNoId() { Item item = new Item(); assertEquals("", item.toXML()); @@ -44,7 +44,7 @@ public class TestMessageContent extends TestCase assertEquals("", itemNull.toXML()); } - public void testSimplePayload() + public void testSimplePayload() { SimplePayload payloadNS = new SimplePayload("book", "pubsub:test:book", payloadXmlWithNS); diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/PubSubTestCase.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/PubSubTestCase.java index d0f12fd18..4490576d2 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/PubSubTestCase.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/PubSubTestCase.java @@ -25,7 +25,7 @@ import org.jivesoftware.smackx.pubsub.LeafNode; import org.jivesoftware.smackx.pubsub.PubSubManager; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/SingleUserTestCase.java b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/SingleUserTestCase.java index 9f537a51a..0e1825b36 100644 --- a/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/SingleUserTestCase.java +++ b/smack-extensions/src/integration-test/java/org/jivesoftware/smackx/pubsub/test/SingleUserTestCase.java @@ -21,7 +21,7 @@ import org.jivesoftware.smackx.pubsub.LeafNode; import org.jivesoftware.smackx.pubsub.PubSubManager; /** - * + * * @author Robin Collier * */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smack/extensions/ExtensionsInitializer.java b/smack-extensions/src/main/java/org/jivesoftware/smack/extensions/ExtensionsInitializer.java index fe26056cf..dbdb7838e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smack/extensions/ExtensionsInitializer.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smack/extensions/ExtensionsInitializer.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.initializer.UrlInitializer; /** * Initializes the providers in the experimental code stream. - * + * * @author Florian Schmaus */ public class ExtensionsInitializer extends UrlInitializer { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java index 10410e320..ec8e8da1c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java @@ -75,7 +75,7 @@ public class MultipleRecipientInfo { /** * Returns true if the received stanza should not be replied. Use * {@link MultipleRecipientManager#reply(org.jivesoftware.smack.XMPPConnection, org.jivesoftware.smack.packet.Message, org.jivesoftware.smack.packet.Message)} - * to send replies. + * to send replies. * * @return true if the received stanza should not be replied. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java index 8ae972f66..e465a2deb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java @@ -68,8 +68,8 @@ public class MultipleRecipientManager { * @throws XMPPErrorException if server does not support XEP-33: Extended Stanza Addressing and * some XEP-33 specific features were requested. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public static void send(XMPPConnection connection, Stanza packet, Collection to, Collection cc, Collection bcc) throws NoResponseException, XMPPErrorException, @@ -82,7 +82,7 @@ public class MultipleRecipientManager { * connection. If the server has support for XEP-33 then only one stanza is going to be sent to * the server with the multiple recipient instructions. However, if XEP-33 is not supported by * the server then the client is going to send the stanza to each recipient. - * + * * @param connection the connection to use to send the packet. * @param packet the stanza to send to the list of recipients. * @param to the collection of JIDs to include in the TO list or null if no TO list exists. @@ -99,8 +99,8 @@ public class MultipleRecipientManager { * @throws NoResponseException if there was no response from the server. * @throws FeatureNotSupportedException if special XEP-33 features where requested, but the * server does not support them. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public static void send(XMPPConnection connection, Stanza packet, Collection to, Collection cc, Collection bcc, Jid replyTo, Jid replyRoom, boolean noReply) throws NoResponseException, XMPPErrorException, FeatureNotSupportedException, NotConnectedException, InterruptedException { @@ -140,9 +140,9 @@ public class MultipleRecipientManager { * @param connection the connection to use to send the reply. * @param original the previously received stanza that was sent to multiple recipients. * @param reply the new message to send as a reply. - * @throws SmackException - * @throws XMPPErrorException - * @throws InterruptedException + * @throws SmackException + * @throws XMPPErrorException + * @throws InterruptedException */ public static void reply(XMPPConnection connection, Message original, Message reply) throws SmackException, XMPPErrorException, InterruptedException { @@ -279,9 +279,9 @@ public class MultipleRecipientManager { * queried. * @return the address of the multiple recipients service or null if none was found. * @throws NoResponseException if there was no response from the server. - * @throws XMPPErrorException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NotConnectedException + * @throws InterruptedException */ private static DomainBareJid getMultipleRecipientServiceAddress(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java index 46acf6a1f..27b5e0689 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java @@ -31,10 +31,10 @@ public class AMPDeliverCondition implements AMPExtension.Condition { * Check if server supports deliver condition. * @param connection Smack connection instance * @return true if deliver condition is supported. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return AMPManager.isConditionSupported(connection, NAME); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java index 53fc409a3..7f9523329 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java @@ -36,10 +36,10 @@ public class AMPExpireAtCondition implements AMPExtension.Condition { * Check if server supports expire-at condition. * @param connection Smack connection instance * @return true if expire-at condition is supported. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return AMPManager.isConditionSupported(connection, NAME); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java index f7d29dfee..6da679901 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java @@ -85,10 +85,10 @@ public class AMPManager { * @param connection active xmpp connection * @param action action to check * @return true if this action is supported. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static boolean isActionSupported(XMPPConnection connection, AMPExtension.Action action) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { String featureName = AMPExtension.NAMESPACE + "?action=" + action.toString(); @@ -100,10 +100,10 @@ public class AMPManager { * @param connection active xmpp connection * @param conditionName name of condition to check * @return true if this condition is supported. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @see AMPDeliverCondition * @see AMPExpireAtCondition * @see AMPMatchResourceCondition diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java index 2bae2ad87..ef443b203 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java @@ -31,10 +31,10 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition { * Check if server supports match-resource condition. * @param connection Smack connection instance * @return true if match-resource condition is supported. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return AMPManager.isConditionSupported(connection, NAME); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java index 3d6ed8797..5a3565568 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java @@ -38,8 +38,8 @@ public class AMPExtensionProvider extends ExtensionElementProvider * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ @Override public AMPExtension parse(XmlPullParser parser, int initialDepth) diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/attention/packet/AttentionExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/attention/packet/AttentionExtension.java index 64ac4fdc5..103c5fb6d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/attention/packet/AttentionExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/attention/packet/AttentionExtension.java @@ -23,10 +23,10 @@ import org.xmlpull.v1.XmlPullParser; /** * A PacketExtension that implements XEP-0224: Attention - * + * * This extension is expected to be added to message stanzas of type 'headline.' * Please refer to the XEP for more implementation guidelines. - * + * * @author Guus der Kinderen, guus.der.kinderen@gmail.com * @see XEP-0224: Attention @@ -45,7 +45,7 @@ public class AttentionExtension implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#getElementName() */ @Override @@ -55,7 +55,7 @@ public class AttentionExtension implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#getNamespace() */ @Override @@ -65,7 +65,7 @@ public class AttentionExtension implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#toXML() */ @Override @@ -81,7 +81,7 @@ public class AttentionExtension implements ExtensionElement { * Attention elements have no state/information other than the element name * and namespace, this implementation simply returns new instances of * {@link AttentionExtension}. - * + * * @author Guus der Kinderen, guus.der.kinderen@gmail.com s */ public static class Provider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/BlockingCommandManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/BlockingCommandManager.java index a5347c311..b60d1ab3e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/BlockingCommandManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/BlockingCommandManager.java @@ -46,7 +46,7 @@ import org.jxmpp.jid.Jid; /** * Blocking command manager class. - * + * * @author Fernando Ramirez * @author Florian Schmaus * @see XEP-0191: Blocking @@ -159,7 +159,7 @@ public final class BlockingCommandManager extends Manager { /** * Returns true if Blocking Command is supported by the server. - * + * * @return true if Blocking Command is supported by the server. * @throws NoResponseException * @throws XMPPErrorException @@ -173,7 +173,7 @@ public final class BlockingCommandManager extends Manager { /** * Returns the block list. - * + * * @return the blocking list * @throws NoResponseException * @throws XMPPErrorException @@ -194,7 +194,7 @@ public final class BlockingCommandManager extends Manager { /** * Block contacts. - * + * * @param jids * @throws NoResponseException * @throws XMPPErrorException @@ -209,7 +209,7 @@ public final class BlockingCommandManager extends Manager { /** * Unblock contacts. - * + * * @param jids * @throws NoResponseException * @throws XMPPErrorException @@ -224,7 +224,7 @@ public final class BlockingCommandManager extends Manager { /** * Unblock all. - * + * * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockContactsIQ.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockContactsIQ.java index ad4b363b0..c6ef8ae78 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockContactsIQ.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockContactsIQ.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid; /** * Block contact IQ class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command @@ -48,7 +48,7 @@ public class BlockContactsIQ extends IQ { /** * Block list IQ constructor. - * + * * @param jids */ public BlockContactsIQ(List jids) { @@ -59,7 +59,7 @@ public class BlockContactsIQ extends IQ { /** * Get the JID. - * + * * @return the list of JIDs */ public List getJids() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockListIQ.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockListIQ.java index 34e5bccf2..755956fa5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockListIQ.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockListIQ.java @@ -28,7 +28,7 @@ import org.jxmpp.jid.Jid; /** * Block list IQ class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command @@ -49,7 +49,7 @@ public class BlockListIQ extends IQ { /** * Block list IQ constructor. - * + * * @param jids */ public BlockListIQ(List jids) { @@ -70,7 +70,7 @@ public class BlockListIQ extends IQ { /** * Get the JIDs as unmodifiable list. - * + * * @return the blocked JIDs */ public List getBlockedJids() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockedErrorExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockedErrorExtension.java index 513f6f098..84ffee568 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockedErrorExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockedErrorExtension.java @@ -25,7 +25,7 @@ import org.jivesoftware.smackx.blocking.BlockingCommandManager; /** * Blocked error extension class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command @@ -64,7 +64,7 @@ public class BlockedErrorExtension implements ExtensionElement { * Check if a message contains a BlockedErrorExtension, which means that a * message was blocked because the JID blocked the sender, and that was * reflected back as an error message. - * + * * @param message * @return true if the message contains a BlockedErrorExtension, false if * not diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/UnblockContactsIQ.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/UnblockContactsIQ.java index ede8c9347..9c2b22ff9 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/UnblockContactsIQ.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/UnblockContactsIQ.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid; /** * Unblock contact IQ class. - * + * * @author Fernando Ramirez * @author Florian Schmaus * @see XEP-0191: Blocking @@ -49,7 +49,7 @@ public class UnblockContactsIQ extends IQ { /** * Unblock contacts IQ constructor. - * + * * @param jids */ public UnblockContactsIQ(List jids) { @@ -63,7 +63,7 @@ public class UnblockContactsIQ extends IQ { } /** - * Constructs a new unblock IQ which will unblock all JIDs. + * Constructs a new unblock IQ which will unblock all JIDs. */ public UnblockContactsIQ() { this(null); @@ -71,7 +71,7 @@ public class UnblockContactsIQ extends IQ { /** * Get the JIDs. This may return null, which means that all JIDs should be or where unblocked. - * + * * @return the list of JIDs or null. */ public List getJids() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/package-info.java index 129e93b6a..44f036294 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/package-info.java @@ -16,7 +16,7 @@ */ /** * Blocking command elements. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/package-info.java index 8521595e4..5659cdc39 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/package-info.java @@ -16,7 +16,7 @@ */ /** * Classes and interfaces of Blocking command. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockContactsIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockContactsIQProvider.java index 61db7032b..72174a8eb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockContactsIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockContactsIQProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Block contact IQ provider class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockListIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockListIQProvider.java index f938d5c4e..590cfda4b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockListIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockListIQProvider.java @@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Block list IQ provider class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockedErrorExtensionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockedErrorExtensionProvider.java index 997bdb1d9..441a84139 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockedErrorExtensionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/BlockedErrorExtensionProvider.java @@ -24,7 +24,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Blocked error extension class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/UnblockContactsIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/UnblockContactsIQProvider.java index df70037bf..c0a3b7c11 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/UnblockContactsIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/UnblockContactsIQProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Unblock contact IQ provider class. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/package-info.java index 054954ef7..76d76dcc2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/provider/package-info.java @@ -16,7 +16,7 @@ */ /** * Blocking command providers. - * + * * @author Fernando Ramirez * @see XEP-0191: Blocking * Command diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBData.java index 2d7deaca4..50106de41 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBData.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBData.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64; /** * Bits of Binary data class. - * + * * @author Fernando Ramirez * @author Florian Schmaus * @see XEP-0231: Bits of @@ -41,7 +41,7 @@ public class BoBData { /** * BoB data constructor. - * + * * @param type * @param content * @param maxAge @@ -64,7 +64,7 @@ public class BoBData { /** * Get the max age. - * + * * @return the max age */ public int getMaxAge() { @@ -73,7 +73,7 @@ public class BoBData { /** * Get the type. - * + * * @return the type */ public String getType() { @@ -89,7 +89,7 @@ public class BoBData { /** * Get the content. - * + * * @return the content */ public byte[] getContent() { @@ -99,7 +99,7 @@ public class BoBData { /** * Get the content in a Base64 encoded String. - * + * * @return the content in a Base64 encoded String */ public String getContentBase64Encoded() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBHash.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBHash.java index 47bcf766b..4d777028d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBHash.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBHash.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.util.StringUtils; /** * Bits of Binary hash class. - * + * * @author Fernando Ramirez * @author Florian Schmaus * @see XEP-0231: Bits of @@ -34,7 +34,7 @@ public class BoBHash { /** * BoB hash constructor. - * + * * @param hash * @param hashType */ @@ -46,7 +46,7 @@ public class BoBHash { /** * Get the hash. - * + * * @return the hash */ public String getHash() { @@ -55,7 +55,7 @@ public class BoBHash { /** * Get the hash type. - * + * * @return the hash type */ public String getHashType() { @@ -64,7 +64,7 @@ public class BoBHash { /** * BoB hash to src attribute string. - * + * * @return src attribute string */ public String toSrc() { @@ -73,7 +73,7 @@ public class BoBHash { /** * BoB hash to cid attribute string. - * + * * @return cid attribute string */ public String getCid() { @@ -96,7 +96,7 @@ public class BoBHash { /** * Get BoB hash from src attribute string. - * + * * @param src * @return the BoB hash */ @@ -108,7 +108,7 @@ public class BoBHash { /** * Get BoB hash from cid attribute string. - * + * * @param cid * @return the BoB hash */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBManager.java index f7c7d261f..66163cbb5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBManager.java @@ -44,7 +44,7 @@ import org.jxmpp.util.cache.LruCache; /** * Bits of Binary manager class. - * + * * @author Fernando Ramirez * @author Florian Schmaus * @see XEP-0231: Bits of @@ -67,7 +67,7 @@ public final class BoBManager extends Manager { /** * Get the singleton instance of BoBManager. - * + * * @param connection * @return the instance of BoBManager */ @@ -113,7 +113,7 @@ public final class BoBManager extends Manager { /** * Returns true if Bits of Binary is supported by the server. - * + * * @return true if Bits of Binary is supported by the server. * @throws NoResponseException * @throws XMPPErrorException @@ -127,7 +127,7 @@ public final class BoBManager extends Manager { /** * Request BoB data. - * + * * @param to * @param bobHash * @return the BoB data diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBExtension.java index ad5246974..967b52100 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBExtension.java @@ -25,7 +25,7 @@ import org.jivesoftware.smackx.xhtmlim.packet.XHTMLExtension; /** * Bits of Binary extension element. - * + * * @author Fernando Ramirez * @see XEP-0231: Bits of * Binary @@ -38,7 +38,7 @@ public class BoBExtension extends XHTMLExtension { /** * Bits of Binary extension constructor. - * + * * @param bobHash * @param alt * @param paragraph @@ -51,7 +51,7 @@ public class BoBExtension extends XHTMLExtension { /** * Get the BoB hash. - * + * * @return the BoB hash */ public BoBHash getBoBHash() { @@ -60,7 +60,7 @@ public class BoBExtension extends XHTMLExtension { /** * Get the alt field. - * + * * @return the alt field */ public String getAlt() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBIQ.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBIQ.java index ce0ff8f2e..56bfddc3d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBIQ.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBIQ.java @@ -24,7 +24,7 @@ import org.jivesoftware.smackx.bob.BoBManager; /** * Bits of Binary IQ class. - * + * * @author Fernando Ramirez * @see XEP-0231: Bits of * Binary @@ -46,7 +46,7 @@ public class BoBIQ extends IQ { /** * Bits of Binary IQ constructor. - * + * * @param bobHash * @param bobData */ @@ -58,7 +58,7 @@ public class BoBIQ extends IQ { /** * Bits of Binary IQ constructor. - * + * * @param bobHash */ public BoBIQ(BoBHash bobHash) { @@ -67,7 +67,7 @@ public class BoBIQ extends IQ { /** * Get the BoB hash. - * + * * @return the BoB hash */ public BoBHash getBoBHash() { @@ -76,7 +76,7 @@ public class BoBIQ extends IQ { /** * Get the BoB data. - * + * * @return the BoB data */ public BoBData getBoBData() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/package-info.java index fa044be00..6b9d8ea37 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/package-info.java @@ -16,7 +16,7 @@ */ /** * Bits of Binary elements. - * + * * @author Fernando Ramirez * @see XEP-0231: Bits of * Binary diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/package-info.java index 08a072b5c..ea3c7724e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/package-info.java @@ -16,7 +16,7 @@ */ /** * Classes and interfaces of XEP-0231: Bits of Binary. - * + * * @author Fernando Ramirez * @see XEP-0231: Bits of * Binary diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/BoBIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/BoBIQProvider.java index 49ee017c1..5eccdff17 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/BoBIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/BoBIQProvider.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Bits of Binary IQ provider class. - * + * * @author Florian Schmaus * @see XEP-0231: Bits of * Binary diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/package-info.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/package-info.java index 31d133038..290749c0e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/package-info.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bob/provider/package-info.java @@ -16,7 +16,7 @@ */ /** * Bits of Binary providers. - * + * * @author Fernando Ramirez * @see XEP-0231: Bits of * Binary diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java index fb1395c7c..e56e9c566 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java @@ -87,10 +87,10 @@ public final class BookmarkManager { * Returns all currently bookmarked conferences. * * @return returns all currently bookmarked conferences - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @see BookmarkedConference */ public List getBookmarkedConferences() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -109,8 +109,8 @@ public final class BookmarkManager { * @throws XMPPErrorException thrown when there is an issue retrieving the current bookmarks from * the server. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void addBookmarkedConference(String name, EntityBareJid jid, boolean isAutoJoin, Resourcepart nickname, String password) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -141,8 +141,8 @@ public final class BookmarkManager { * @throws XMPPErrorException thrown when there is a problem with the connection attempting to * retrieve the bookmarks or persist the bookmarks. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @throws IllegalArgumentException thrown when the conference being removed is a shared * conference */ @@ -168,8 +168,8 @@ public final class BookmarkManager { * @return returns an unmodifiable collection of all bookmarked urls. * @throws XMPPErrorException thrown when there is a problem retriving bookmarks from the server. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getBookmarkedURLs() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { retrieveBookmarks(); @@ -185,8 +185,8 @@ public final class BookmarkManager { * @throws XMPPErrorException thrown when there is an error retriving or saving bookmarks from or to * the server * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void addBookmarkedURL(String URL, String name, boolean isRSS) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { retrieveBookmarks(); @@ -213,8 +213,8 @@ public final class BookmarkManager { * @throws XMPPErrorException thrown if there is an error retriving or saving bookmarks from or to * the server. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void removeBookmarkedURL(String bookmarkURL) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { retrieveBookmarks(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamListener.java index 13d3169dd..0e62ec6d7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamListener.java @@ -35,14 +35,14 @@ import org.jivesoftware.smackx.bytestreams.socks5.Socks5BytestreamManager; *

    * {@link Socks5BytestreamListener} or {@link InBandBytestreamListener} provide a more specific * interface of the BytestreamListener. - * + * * @author Henning Staib */ public interface BytestreamListener { /** * This listener is notified if a bytestream request from another user has been received. - * + * * @param request the incoming bytestream request */ void incomingBytestreamRequest(BytestreamRequest request); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamManager.java index 4bb457854..eb9e6087e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamManager.java @@ -31,7 +31,7 @@ import org.jxmpp.jid.Jid; *

    * There are two implementations of the interface. See {@link Socks5BytestreamManager} and * {@link InBandBytestreamManager}. - * + * * @author Henning Staib */ public interface BytestreamManager { @@ -43,14 +43,14 @@ public interface BytestreamManager { * See {@link Socks5BytestreamManager#addIncomingBytestreamListener(BytestreamListener)} and * {@link InBandBytestreamManager#addIncomingBytestreamListener(BytestreamListener)} for further * details. - * + * * @param listener the listener to register */ void addIncomingBytestreamListener(BytestreamListener listener); /** * Removes the given listener from the list of listeners for all incoming bytestream requests. - * + * * @param listener the listener to remove */ void removeIncomingBytestreamListener(BytestreamListener listener); @@ -64,7 +64,7 @@ public interface BytestreamManager { * See {@link Socks5BytestreamManager#addIncomingBytestreamListener(BytestreamListener, Jid)} * and {@link InBandBytestreamManager#addIncomingBytestreamListener(BytestreamListener, Jid)} * for further details. - * + * * @param listener the listener to register * @param initiatorJID the JID of the user that wants to establish a bytestream */ @@ -72,7 +72,7 @@ public interface BytestreamManager { /** * Removes the listener for the given user. - * + * * @param initiatorJID the JID of the user the listener should be removed */ void removeIncomingBytestreamListener(Jid initiatorJID); @@ -89,7 +89,7 @@ public interface BytestreamManager { *

    * See {@link Socks5BytestreamManager#establishSession(Jid)} and * {@link InBandBytestreamManager#establishSession(Jid)} for further details. - * + * * @param targetJID the JID of the user a bytestream should be established * @return the session to send/receive data to/from the user * @throws XMPPException if an error occurred while establishing the session @@ -107,7 +107,7 @@ public interface BytestreamManager { *

    * See {@link Socks5BytestreamManager#establishSession(Jid)} and * {@link InBandBytestreamManager#establishSession(Jid)} for further details. - * + * * @param targetJID the JID of the user a bytestream should be established * @param sessionID the session ID for the bytestream request * @return the session to send/receive data to/from the user diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamRequest.java index d4b8cba36..5c2a81d3e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamRequest.java @@ -31,41 +31,41 @@ import org.jxmpp.jid.Jid; *

    * There are two implementations of the interface. See {@link Socks5BytestreamRequest} and * {@link InBandBytestreamRequest}. - * + * * @author Henning Staib */ public interface BytestreamRequest { /** * Returns the sender of the bytestream open request. - * + * * @return the sender of the bytestream open request */ Jid getFrom(); /** * Returns the session ID of the bytestream open request. - * + * * @return the session ID of the bytestream open request */ String getSessionID(); /** * Accepts the bytestream open request and returns the session to send/receive data. - * + * * @return the session to send/receive data * @throws XMPPErrorException if an error occurred while accepting the bytestream request * @throws InterruptedException if the thread was interrupted while waiting in a blocking * operation - * @throws NoResponseException - * @throws SmackException + * @throws NoResponseException + * @throws SmackException */ BytestreamSession accept() throws InterruptedException, XMPPErrorException, SmackException; /** * Rejects the bytestream request by sending a reject error to the initiator. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ void reject() throws NotConnectedException, InterruptedException; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamSession.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamSession.java index ccac7fc55..f0d9ce8e5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamSession.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamSession.java @@ -28,14 +28,14 @@ import org.jivesoftware.smackx.bytestreams.socks5.Socks5BytestreamSession; *

    * There are two implementations of the interface. See {@link Socks5BytestreamSession} and * {@link InBandBytestreamSession}. - * + * * @author Henning Staib */ public interface BytestreamSession { /** * Returns the InputStream associated with this session to send data. - * + * * @return the InputStream associated with this session to send data * @throws IOException if an error occurs while retrieving the input stream */ @@ -43,7 +43,7 @@ public interface BytestreamSession { /** * Returns the OutputStream associated with this session to receive data. - * + * * @return the OutputStream associated with this session to receive data * @throws IOException if an error occurs while retrieving the output stream */ @@ -54,7 +54,7 @@ public interface BytestreamSession { *

    * Closing the session will also close the input stream and the output stream associated to this * session. - * + * * @throws IOException if an error occurs while closing the session */ void close() throws IOException; @@ -62,7 +62,7 @@ public interface BytestreamSession { /** * Returns the timeout for read operations of the input stream associated with this session. 0 * returns implies that the option is disabled (i.e., timeout of infinity). Default is 0. - * + * * @return the timeout for read operations * @throws IOException if there is an error in the underlying protocol */ @@ -75,7 +75,7 @@ public interface BytestreamSession { * session is still valid. The option must be enabled prior to entering the blocking operation * to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite * timeout. Default is 0. - * + * * @param timeout the specified timeout, in milliseconds * @throws IOException if there is an error in the underlying protocol */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListener.java index b61aae330..825eeaa9f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListener.java @@ -28,7 +28,7 @@ import org.jivesoftware.smackx.bytestreams.ibb.packet.Close; * If a close request is received it looks if a stored In-Band Bytestream * session exists and closes it. If no session with the given session ID exists * an <item-not-found/> error is returned to the sender. - * + * * @author Henning Staib */ class CloseListener extends AbstractIqRequestHandler { @@ -38,7 +38,7 @@ class CloseListener extends AbstractIqRequestHandler { /** * Constructor. - * + * * @param manager the In-Band Bytestream manager */ protected CloseListener(InBandBytestreamManager manager) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java index 99380d60c..09d3f58b0 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java @@ -35,7 +35,7 @@ import org.jivesoftware.smackx.bytestreams.ibb.packet.DataPacketExtension; * Data packets belonging to a running In-Band Bytestream session are processed * by more specific listeners registered when an {@link InBandBytestreamSession} * is created. - * + * * @author Henning Staib */ class DataListener extends AbstractIqRequestHandler { @@ -45,7 +45,7 @@ class DataListener extends AbstractIqRequestHandler { /** * Constructor. - * + * * @param manager the In-Band Bytestream manager */ DataListener(InBandBytestreamManager manager) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamListener.java index cc69e7e74..aba1d94d7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamListener.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.bytestreams.BytestreamRequest; * {@link InBandBytestreamManager#addIncomingBytestreamListener(BytestreamListener)} and * {@link InBandBytestreamManager#addIncomingBytestreamListener(BytestreamListener, org.jxmpp.jid.Jid)} for * further details. - * + * * @author Henning Staib */ public abstract class InBandBytestreamListener implements BytestreamListener { @@ -42,7 +42,7 @@ public abstract class InBandBytestreamListener implements BytestreamListener { /** * This listener is notified if an In-Band Bytestream request from another user has been * received. - * + * * @param request the incoming In-Band Bytestream request */ public abstract void incomingBytestreamRequest(InBandBytestreamRequest request); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java index 1ab8a0447..8cd93ca10 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java @@ -79,7 +79,7 @@ import org.jxmpp.jid.Jid; *

    * If no {@link InBandBytestreamListener}s are registered, all incoming In-Band bytestream requests * will be rejected by returning a <not-acceptable/> error to the initiator. - * + * * @author Henning Staib */ public final class InBandBytestreamManager extends Manager implements BytestreamManager { @@ -186,7 +186,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns the InBandBytestreamManager to handle In-Band Bytestreams for a given * {@link XMPPConnection}. - * + * * @param connection the XMPP connection * @return the InBandBytestreamManager for the given XMPP connection */ @@ -203,7 +203,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Constructor. - * + * * @param connection the XMPP connection */ private InBandBytestreamManager(XMPPConnection connection) { @@ -233,7 +233,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream * Socks5 bytestream requests sent in the context of XEP-0096 file transfer. (See * {@link FileTransferManager}) - * + * * @param listener the listener to register */ @Override @@ -244,7 +244,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Removes the given listener from the list of listeners for all incoming In-Band Bytestream * requests. - * + * * @param listener the listener to remove */ @Override @@ -266,7 +266,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream * Socks5 bytestream requests sent in the context of XEP-0096 file transfer. (See * {@link FileTransferManager}) - * + * * @param listener the listener to register * @param initiatorJID the JID of the user that wants to establish an In-Band Bytestream */ @@ -277,7 +277,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Removes the listener for the given user. - * + * * @param initiatorJID the JID of the user the listener should be removed */ @Override @@ -292,7 +292,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream *

    * This method should be used if you are awaiting an In-Band Bytestream request as a reply to * another stanza (e.g. file transfer). - * + * * @param sessionID to be ignored */ public void ignoreBytestreamRequestOnce(String sessionID) { @@ -305,7 +305,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream *

    * The recommended default block size is 4096 bytes. See XEP-0047 Section 5. - * + * * @return the default block size */ public int getDefaultBlockSize() { @@ -319,7 +319,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream * The default block size must be between 1 and 65535 bytes. The recommended default block size * is 4096 bytes. See XEP-0047 * Section 5. - * + * * @param defaultBlockSize the default block size to set */ public void setDefaultBlockSize(int defaultBlockSize) { @@ -338,7 +338,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream * block size. *

    * The default maximum block size is 65535 bytes. - * + * * @return the maximum block size */ public int getMaximumBlockSize() { @@ -353,7 +353,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream * Incoming In-Band Bytestream open request will be rejected with an * <resource-constraint/> error if the block size is greater then the maximum allowed * block size. - * + * * @param maximumBlockSize the maximum block size to set */ public void setMaximumBlockSize(int maximumBlockSize) { @@ -369,7 +369,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream *

    * Default is {@link StanzaType#IQ}. See XEP-0047 Section 4. - * + * * @return the stanza used to send data packets */ public StanzaType getStanza() { @@ -381,7 +381,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream *

    * The use of {@link StanzaType#IQ} is recommended. See XEP-0047 Section 4. - * + * * @param stanza the stanza to set */ public void setStanza(StanzaType stanza) { @@ -398,13 +398,13 @@ public final class InBandBytestreamManager extends Manager implements Bytestream *

    * To establish an In-Band Bytestream after negotiation the kind of data to be sent (e.g. file * transfer) use {@link #establishSession(Jid, String)}. - * + * * @param targetJID the JID of the user an In-Band Bytestream should be established * @return the session to send/receive data to/from the user * @throws XMPPException if the user doesn't support or accept in-band bytestreams, or if the * user prefers smaller block sizes * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ @Override public InBandBytestreamSession establishSession(Jid targetJID) throws XMPPException, SmackException, InterruptedException { @@ -415,15 +415,15 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Establishes an In-Band Bytestream with the given user using the given session ID and returns * the session to send/receive data to/from the user. - * + * * @param targetJID the JID of the user an In-Band Bytestream should be established * @param sessionID the session ID for the In-Band Bytestream request * @return the session to send/receive data to/from the user * @throws XMPPErrorException if the user doesn't support or accept in-band bytestreams, or if the * user prefers smaller block sizes * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ @Override public InBandBytestreamSession establishSession(Jid targetJID, String sessionID) @@ -446,10 +446,10 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream is * not accepted. - * + * * @param request IQ stanza that should be answered with a not-acceptable error - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected void replyRejectPacket(IQ request) throws NotConnectedException, InterruptedException { IQ error = IQ.createErrorResponse(request, StanzaError.Condition.not_acceptable); @@ -459,10 +459,10 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream open * request is rejected because its block size is greater than the maximum allowed block size. - * + * * @param request IQ stanza that should be answered with a resource-constraint error - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected void replyResourceConstraintPacket(IQ request) throws NotConnectedException, InterruptedException { IQ error = IQ.createErrorResponse(request, StanzaError.Condition.resource_constraint); @@ -472,10 +472,10 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream * session could not be found. - * + * * @param request IQ stanza that should be answered with a item-not-found error - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected void replyItemNotFoundPacket(IQ request) throws NotConnectedException, InterruptedException { IQ error = IQ.createErrorResponse(request, StanzaError.Condition.item_not_found); @@ -484,7 +484,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns a new unique session ID. - * + * * @return a new unique session ID */ private static String getNextSessionID() { @@ -496,7 +496,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns the XMPP connection. - * + * * @return the XMPP connection */ protected XMPPConnection getConnection() { @@ -506,7 +506,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns the {@link InBandBytestreamListener} that should be informed if a In-Band Bytestream * request from the given initiator JID is received. - * + * * @param initiator the initiator's JID * @return the listener */ @@ -517,7 +517,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns a list of {@link InBandBytestreamListener} that are informed if there are no * listeners for a specific initiator. - * + * * @return list of listeners */ protected List getAllRequestListeners() { @@ -526,7 +526,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns the sessions map. - * + * * @return the sessions map */ protected Map getSessions() { @@ -535,7 +535,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream /** * Returns the list of session IDs that should be ignored by the InitialtionListener - * + * * @return list of session IDs */ protected List getIgnoredBytestreamRequests() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequest.java index bbc703121..b4c0f0ea3 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequest.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid; /** * InBandBytestreamRequest class handles incoming In-Band Bytestream requests. - * + * * @author Henning Staib */ public class InBandBytestreamRequest implements BytestreamRequest { @@ -49,7 +49,7 @@ public class InBandBytestreamRequest implements BytestreamRequest { /** * Returns the sender of the In-Band Bytestream open request. - * + * * @return the sender of the In-Band Bytestream open request */ @Override @@ -59,7 +59,7 @@ public class InBandBytestreamRequest implements BytestreamRequest { /** * Returns the session ID of the In-Band Bytestream open request. - * + * * @return the session ID of the In-Band Bytestream open request */ @Override @@ -70,10 +70,10 @@ public class InBandBytestreamRequest implements BytestreamRequest { /** * Accepts the In-Band Bytestream open request and returns the session to * send/receive data. - * + * * @return the session to send/receive data - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ @Override public InBandBytestreamSession accept() throws NotConnectedException, InterruptedException { @@ -94,8 +94,8 @@ public class InBandBytestreamRequest implements BytestreamRequest { /** * Rejects the In-Band Bytestream request by sending a reject error to the * initiator. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ @Override public void reject() throws NotConnectedException, InterruptedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java index a78ea1587..3ff082df2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java @@ -55,7 +55,7 @@ import org.jxmpp.jid.Jid; * closed individually the session will be closed automatically once the second stream is closed. * Use the {@link #setCloseBothStreamsEnabled(boolean)} method if both streams should be closed * automatically if one of them is closed. - * + * * @author Henning Staib */ public class InBandBytestreamSession implements BytestreamSession { @@ -87,7 +87,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Constructor. - * + * * @param connection the XMPP connection * @param byteStreamRequest the In-Band Bytestream open request for this session * @param remoteJID JID of the remote peer @@ -138,7 +138,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Returns whether both streams should be closed automatically if one of the streams is closed. * Default is false. - * + * * @return true if both streams will be closed if one of the streams is closed, * false if both streams can be closed independently. */ @@ -149,7 +149,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Sets whether both streams should be closed automatically if one of the streams is closed. * Default is false. - * + * * @param closeBothStreamsEnabled true if both streams should be closed if one of * the streams is closed, false if both streams should be closed * independently @@ -166,10 +166,10 @@ public class InBandBytestreamSession implements BytestreamSession { /** * This method is invoked if a request to close the In-Band Bytestream has been received. - * + * * @param closeRequest the close request from the remote peer - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected void closeByPeer(Close closeRequest) throws NotConnectedException, InterruptedException { @@ -282,14 +282,14 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Returns the stanza listener that processes In-Band Bytestream data packets. - * + * * @return the data stanza listener */ protected abstract StanzaListener getDataPacketListener(); /** * Returns the stanza filter that accepts In-Band Bytestream data packets. - * + * * @return the data stanza filter */ protected abstract StanzaFilter getDataPacketFilter(); @@ -352,7 +352,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * This method blocks until a data stanza is received, the stream is closed or the current * thread is interrupted. - * + * * @return true if data was received, otherwise false * @throws IOException if data packets are out of sequence */ @@ -406,7 +406,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Checks if this stream is closed and throws an IOException if necessary - * + * * @throws IOException if stream is closed and no data should be read anymore */ private void checkClosed() throws IOException { @@ -633,11 +633,11 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Writes the given data stanza to the XMPP stream. - * + * * @param data the data packet * @throws IOException if an I/O error occurred while sending or if the stream is closed - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected abstract void writeToXML(DataPacketExtension data) throws IOException, NotConnectedException, InterruptedException; @@ -695,7 +695,7 @@ public class InBandBytestreamSession implements BytestreamSession { * Fills the buffer with the given data and sends it over the XMPP stream if the buffers * capacity has been reached. This method is only called from this class so it is assured * that the amount of data to send is <= buffer capacity - * + * * @param b the data * @param off the data * @param len the number of bytes to write @@ -771,7 +771,7 @@ public class InBandBytestreamSession implements BytestreamSession { /** * Sets the close flag and optionally flushes the stream. - * + * * @param flush if true flushes the stream */ protected void closeInternal(boolean flush) { @@ -848,8 +848,8 @@ public class InBandBytestreamSession implements BytestreamSession { * Process IQ stanza. * @param data * @throws NotConnectedException - * @throws InterruptedException - * @throws NotLoggedInException + * @throws InterruptedException + * @throws NotLoggedInException */ public void processIQPacket(Data data) throws NotConnectedException, InterruptedException, NotLoggedInException { inputStream.dataPacketListener.processStanza(data); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListener.java index 5a8c1121c..e5de08106 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListener.java @@ -40,7 +40,7 @@ import org.jivesoftware.smackx.filetransfer.StreamNegotiator; * All In-Band Bytestream request having a block size greater than the maximum allowed block size * for this connection are rejected with an <resource-constraint/> error. The maximum block * size can be set by invoking {@link InBandBytestreamManager#setMaximumBlockSize(int)}. - * + * * @author Henning Staib */ class InitiationListener extends AbstractIqRequestHandler { @@ -54,7 +54,7 @@ class InitiationListener extends AbstractIqRequestHandler { /** * Constructor. - * + * * @param manager the In-Band Bytestream manager */ protected InitiationListener(InBandBytestreamManager manager) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Close.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Close.java index 40d295169..cdd002590 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Close.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Close.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.IQ; /** * Represents a request to close an In-Band Bytestream. - * + * * @author Henning Staib */ public class Close extends IQ { @@ -33,7 +33,7 @@ public class Close extends IQ { /** * Creates a new In-Band Bytestream close request packet. - * + * * @param sessionID unique session ID identifying this In-Band Bytestream */ public Close(String sessionID) { @@ -47,7 +47,7 @@ public class Close extends IQ { /** * Returns the unique session ID identifying this In-Band Bytestream. - * + * * @return the unique session ID identifying this In-Band Bytestream */ public String getSessionID() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java index 67e7f88cd..54bbaeb80 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.IQ; /** * Represents a chunk of data sent over an In-Band Bytestream encapsulated in an * IQ stanza. - * + * * @author Henning Staib */ public class Data extends IQ { @@ -31,7 +31,7 @@ public class Data extends IQ { /** * Constructor. - * + * * @param data data stanza extension containing the encoded data */ public Data(DataPacketExtension data) { @@ -46,7 +46,7 @@ public class Data extends IQ { /** * Returns the data stanza extension. - * + * * @return the data stanza extension */ public DataPacketExtension getDataPacketExtension() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java index 580c17191..d27f27221 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java @@ -24,7 +24,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64; /** * Represents a chunk of data of an In-Band Bytestream within an IQ stanza or a * message stanza. - * + * * @author Henning Staib */ public class DataPacketExtension implements ExtensionElement { @@ -52,7 +52,7 @@ public class DataPacketExtension implements ExtensionElement { /** * Creates a new In-Band Bytestream data packet. - * + * * @param sessionID unique session ID identifying this In-Band Bytestream * @param seq sequence of this stanza in regard to the other data packets * @param data the base64 encoded data contained in this packet @@ -74,7 +74,7 @@ public class DataPacketExtension implements ExtensionElement { /** * Returns the unique session ID identifying this In-Band Bytestream. - * + * * @return the unique session ID identifying this In-Band Bytestream */ public String getSessionID() { @@ -83,7 +83,7 @@ public class DataPacketExtension implements ExtensionElement { /** * Returns the sequence of this stanza in regard to the other data packets. - * + * * @return the sequence of this stanza in regard to the other data packets. */ public long getSeq() { @@ -92,7 +92,7 @@ public class DataPacketExtension implements ExtensionElement { /** * Returns the data contained in this packet. - * + * * @return the data contained in this packet. */ public String getData() { @@ -107,7 +107,7 @@ public class DataPacketExtension implements ExtensionElement { * character(s) of the data. See XEP-0047 Section * 6. - * + * * @return the decoded data */ public byte[] getDecodedData() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java index 11043dd3c..768cf3f20 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Open.java @@ -24,7 +24,7 @@ import org.jivesoftware.smackx.bytestreams.ibb.InBandBytestreamManager.StanzaTyp /** * Represents a request to open an In-Band Bytestream. - * + * * @author Henning Staib */ public class Open extends IQ { @@ -49,7 +49,7 @@ public class Open extends IQ { * 65535. A recommended default value is 4096. *

    * The data can be sent using IQ stanzas or message stanzas. - * + * * @param sessionID unique session ID identifying this In-Band Bytestream * @param blockSize block size in which the data will be fragmented * @param stanza stanza type used to encapsulate the data @@ -77,7 +77,7 @@ public class Open extends IQ { * 65535. A recommended default value is 4096. *

    * The data will be sent using IQ stanzas. - * + * * @param sessionID unique session ID identifying this In-Band Bytestream * @param blockSize block size in which the data will be fragmented */ @@ -87,7 +87,7 @@ public class Open extends IQ { /** * Returns the unique session ID identifying this In-Band Bytestream. - * + * * @return the unique session ID identifying this In-Band Bytestream */ public String getSessionID() { @@ -96,7 +96,7 @@ public class Open extends IQ { /** * Returns the block size in which the data will be fragmented. - * + * * @return the block size in which the data will be fragmented */ public int getBlockSize() { @@ -105,7 +105,7 @@ public class Open extends IQ { /** * Returns the stanza type used to encapsulate the data. - * + * * @return the stanza type used to encapsulate the data */ public StanzaType getStanza() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/CloseIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/CloseIQProvider.java index a42233294..6e29aab9c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/CloseIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/CloseIQProvider.java @@ -24,7 +24,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Parses a close In-Band Bytestream packet. - * + * * @author Henning Staib */ public class CloseIQProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java index ab83d95d4..90c019f75 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * Parses an In-Band Bytestream data stanza which can be a stanza extension of * either an IQ stanza or a message stanza. - * + * * @author Henning Staib */ public class DataPacketProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProvider.java index 53c9e9864..388e1434d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * Parses an In-Band Bytestream open packet. - * + * * @author Henning Staib */ public class OpenIQProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListener.java index 3b8de3941..7cf019013 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListener.java @@ -35,7 +35,7 @@ import org.jivesoftware.smackx.filetransfer.StreamNegotiator; * listeners for a SOCKS5 bytestream request InitiationListener will always refuse the request and * reply with a <not-acceptable/> error (XEP-0065 Section 5.2.A2). - * + * * @author Henning Staib */ final class InitiationListener extends AbstractIqRequestHandler { @@ -49,7 +49,7 @@ final class InitiationListener extends AbstractIqRequestHandler { /** * Constructor - * + * * @param manager the SOCKS5 Bytestream manager */ protected InitiationListener(Socks5BytestreamManager manager) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamListener.java index 6c8f9d916..3bde5e3b2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamListener.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.bytestreams.BytestreamRequest; * {@link Socks5BytestreamManager#addIncomingBytestreamListener(BytestreamListener)} and * {@link Socks5BytestreamManager#addIncomingBytestreamListener(BytestreamListener, org.jxmpp.jid.Jid)} for * further details. - * + * * @author Henning Staib */ public abstract class Socks5BytestreamListener implements BytestreamListener { @@ -39,7 +39,7 @@ public abstract class Socks5BytestreamListener implements BytestreamListener { /** * This listener is notified if a SOCKS5 Bytestream request from another user has been received. - * + * * @param request the incoming SOCKS5 Bytestream request */ public abstract void incomingBytestreamRequest(Socks5BytestreamRequest request); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java index 113533c4b..e45ed98f6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java @@ -88,7 +88,7 @@ import org.jxmpp.jid.Jid; *

    * If no {@link Socks5BytestreamListener}s are registered, all incoming SOCKS5 Bytestream requests * will be rejected by returning a <not-acceptable/> error to the initiator. - * + * * @author Henning Staib */ public final class Socks5BytestreamManager extends Manager implements BytestreamManager { @@ -159,7 +159,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream * {@link XMPPConnection}. *

    * If no manager exists a new is created and initialized. - * + * * @param connection the XMPP connection or null if given connection is * null * @return the Socks5BytestreamManager for the given XMPP connection @@ -178,7 +178,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Private constructor. - * + * * @param connection the XMPP connection */ private Socks5BytestreamManager(XMPPConnection connection) { @@ -198,7 +198,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream * bytestream requests sent in the context of XEP-0096 file transfer. (See * {@link FileTransferManager}) - * + * * @param listener the listener to register */ @Override @@ -209,7 +209,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Removes the given listener from the list of listeners for all incoming SOCKS5 Bytestream * requests. - * + * * @param listener the listener to remove */ @Override @@ -231,7 +231,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream * bytestream requests sent in the context of XEP-0096 file transfer. (See * {@link FileTransferManager}) - * + * * @param listener the listener to register * @param initiatorJID the JID of the user that wants to establish a SOCKS5 Bytestream */ @@ -242,7 +242,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Removes the listener for the given user. - * + * * @param initiatorJID the JID of the user the listener should be removed */ @Override @@ -257,7 +257,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream *

    * This method should be used if you are awaiting a SOCKS5 Bytestream request as a reply to * another stanza (e.g. file transfer). - * + * * @param sessionID to be ignored */ public void ignoreBytestreamRequestOnce(String sessionID) { @@ -310,7 +310,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the timeout to wait for the response to the SOCKS5 Bytestream initialization request. * Default is 10000ms. - * + * * @return the timeout to wait for the response to the SOCKS5 Bytestream initialization request */ public int getTargetResponseTimeout() { @@ -323,7 +323,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Sets the timeout to wait for the response to the SOCKS5 Bytestream initialization request. * Default is 10000ms. - * + * * @param targetResponseTimeout the timeout to set */ public void setTargetResponseTimeout(int targetResponseTimeout) { @@ -333,7 +333,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the timeout for connecting to the SOCKS5 proxy selected by the target. Default is * 10000ms. - * + * * @return the timeout for connecting to the SOCKS5 proxy selected by the target */ public int getProxyConnectionTimeout() { @@ -346,7 +346,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Sets the timeout for connecting to the SOCKS5 proxy selected by the target. Default is * 10000ms. - * + * * @param proxyConnectionTimeout the timeout to set */ public void setProxyConnectionTimeout(int proxyConnectionTimeout) { @@ -356,7 +356,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns if the prioritization of the last working SOCKS5 proxy on successive SOCKS5 * Bytestream connections is enabled. Default is true. - * + * * @return true if prioritization is enabled, false otherwise */ public boolean isProxyPrioritizationEnabled() { @@ -366,7 +366,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Enable/disable the prioritization of the last working SOCKS5 proxy on successive SOCKS5 * Bytestream connections. - * + * * @param proxyPrioritizationEnabled enable/disable the prioritization of the last working * SOCKS5 proxy */ @@ -384,7 +384,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream *

    * To establish a SOCKS5 Bytestream after negotiation the kind of data to be sent (e.g. file * transfer) use {@link #establishSession(Jid, String)}. - * + * * @param targetJID the JID of the user a SOCKS5 Bytestream should be established * @return the Socket to send/receive data to/from the user * @throws XMPPException if the user doesn't support or accept SOCKS5 Bytestreams, if no Socks5 @@ -403,14 +403,14 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Establishes a SOCKS5 Bytestream with the given user using the given session ID and returns * the Socket to send/receive data to/from the user. - * + * * @param targetJID the JID of the user a SOCKS5 Bytestream should be established * @param sessionID the session ID for the SOCKS5 Bytestream request * @return the Socket to send/receive data to/from the user * @throws IOException if the bytestream could not be established * @throws InterruptedException if the current thread was interrupted while waiting * @throws SmackException if the target does not support SOCKS5. - * @throws XMPPException + * @throws XMPPException */ @Override public Socks5BytestreamSession establishSession(Jid targetJID, String sessionID) @@ -512,14 +512,14 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns true if the given target JID supports feature SOCKS5 Bytestream. - * + * * @param targetJID the target JID * @return true if the given target JID supports feature SOCKS5 Bytestream * otherwise false - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ private boolean supportsSocks5(Jid targetJID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(targetJID, Bytestream.NAMESPACE); @@ -528,12 +528,12 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns a list of JIDs of SOCKS5 proxies by querying the XMPP server. The SOCKS5 proxies are * in the same order as returned by the XMPP server. - * + * * @return list of JIDs of SOCKS5 proxies * @throws XMPPErrorException if there was an error querying the XMPP server for SOCKS5 proxies * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List determineProxies() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { XMPPConnection connection = connection(); @@ -580,7 +580,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream * SOCKS5 proxy JIDs. The order of the returned list is the same as the given list of JIDs * excluding all SOCKS5 proxies who's network settings could not be determined. If a local * SOCKS5 proxy is running it will be the first item in the list returned. - * + * * @param proxies a list of SOCKS5 proxy JIDs * @return a list of stream hosts containing the IP address an the port */ @@ -613,7 +613,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns a IQ stanza to query a SOCKS5 proxy its network settings. - * + * * @param proxy the proxy to query * @return IQ stanza to query a SOCKS5 proxy its network settings */ @@ -627,7 +627,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the stream host information of the local SOCKS5 proxy containing the IP address and * the port or null if local SOCKS5 proxy is not running. - * + * * @return the stream host information of the local SOCKS5 proxy or null if local SOCKS5 proxy * is not running */ @@ -666,7 +666,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns a SOCKS5 Bytestream initialization request stanza with the given session ID * containing the given stream hosts for the given target JID. - * + * * @param sessionID the session ID for the SOCKS5 Bytestream * @param targetJID the target JID of SOCKS5 Bytestream request * @param streamHosts a list of SOCKS5 proxies the target should connect to @@ -693,10 +693,10 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream *

    * Specified in XEP-65 5.3.1 (Example 13) *

    - * + * * @param packet Stanza that should be answered with a not-acceptable error - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ protected void replyRejectPacket(IQ packet) throws NotConnectedException, InterruptedException { StanzaError.Builder xmppError = StanzaError.getBuilder(StanzaError.Condition.not_acceptable); @@ -726,7 +726,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns a new unique session ID. - * + * * @return a new unique session ID */ private static String getNextSessionID() { @@ -738,7 +738,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the XMPP connection. - * + * * @return the XMPP connection */ protected XMPPConnection getConnection() { @@ -748,7 +748,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the {@link BytestreamListener} that should be informed if a SOCKS5 Bytestream request * from the given initiator JID is received. - * + * * @param initiator the initiator's JID * @return the listener */ @@ -759,7 +759,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns a list of {@link BytestreamListener} that are informed if there are no listeners for * a specific initiator. - * + * * @return list of listeners */ protected List getAllRequestListeners() { @@ -768,7 +768,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream /** * Returns the list of session IDs that should be ignored by the InitialtionListener - * + * * @return list of session IDs */ protected List getIgnoredBytestreamRequests() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java index 3acccf5d0..cd226f1d5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java @@ -38,7 +38,7 @@ import org.jxmpp.util.cache.ExpirationCache; /** * Socks5BytestreamRequest class handles incoming SOCKS5 Bytestream requests. - * + * * @author Henning Staib */ public class Socks5BytestreamRequest implements BytestreamRequest { @@ -76,7 +76,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { * Returns the number of connection failures it takes for a particular SOCKS5 proxy to be * blacklisted. When a proxy is blacklisted no more connection attempts will be made to it for a * period of 2 hours. Default is 2. - * + * * @return the number of connection failures it takes for a particular SOCKS5 proxy to be * blacklisted */ @@ -90,7 +90,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { * period of 2 hours. Default is 2. *

    * Setting the connection failure threshold to zero disables the blacklisting. - * + * * @param connectFailureThreshold the number of connection failures it takes for a particular * SOCKS5 proxy to be blacklisted */ @@ -100,7 +100,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Creates a new Socks5BytestreamRequest. - * + * * @param manager the SOCKS5 Bytestream manager * @param bytestreamRequest the SOCKS5 Bytestream initialization packet */ @@ -118,7 +118,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { *

    * You can set the minimum timeout for establishing a connection to one SOCKS5 proxy by invoking * {@link #setMinimumConnectTimeout(int)}. - * + * * @return the maximum timeout to connect to SOCKS5 proxies */ public int getTotalConnectTimeout() { @@ -137,7 +137,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { *

    * You can set the minimum timeout for establishing a connection to one SOCKS5 proxy by invoking * {@link #setMinimumConnectTimeout(int)}. - * + * * @param totalConnectTimeout the maximum timeout to connect to SOCKS5 proxies */ public void setTotalConnectTimeout(int totalConnectTimeout) { @@ -147,7 +147,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Returns the timeout to connect to one SOCKS5 proxy while accepting the SOCKS5 Bytestream * request. Default is 2000ms. - * + * * @return the timeout to connect to one SOCKS5 proxy */ public int getMinimumConnectTimeout() { @@ -160,7 +160,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Sets the timeout to connect to one SOCKS5 proxy while accepting the SOCKS5 Bytestream * request. Default is 2000ms. - * + * * @param minimumConnectTimeout the timeout to connect to one SOCKS5 proxy */ public void setMinimumConnectTimeout(int minimumConnectTimeout) { @@ -169,7 +169,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Returns the sender of the SOCKS5 Bytestream initialization request. - * + * * @return the sender of the SOCKS5 Bytestream initialization request. */ @Override @@ -179,7 +179,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Returns the session ID of the SOCKS5 Bytestream initialization request. - * + * * @return the session ID of the SOCKS5 Bytestream initialization request. */ @Override @@ -193,11 +193,11 @@ public class Socks5BytestreamRequest implements BytestreamRequest { *

    * Before accepting the SOCKS5 Bytestream request you can set timeouts by invoking * {@link #setTotalConnectTimeout(int)} and {@link #setMinimumConnectTimeout(int)}. - * + * * @return the socket to send/receive data * @throws InterruptedException if the current thread was interrupted while waiting - * @throws XMPPErrorException - * @throws SmackException + * @throws XMPPErrorException + * @throws SmackException */ @Override public Socks5BytestreamSession accept() throws InterruptedException, XMPPErrorException, SmackException { @@ -266,8 +266,8 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Rejects the SOCKS5 Bytestream request by sending a reject error to the initiator. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ @Override public void reject() throws NotConnectedException, InterruptedException { @@ -277,9 +277,9 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Cancels the SOCKS5 Bytestream request by sending an error to the initiator and building a * XMPP exception. - * @throws XMPPErrorException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NotConnectedException + * @throws InterruptedException */ private void cancelRequest() throws XMPPErrorException, NotConnectedException, InterruptedException { String errorMessage = "Could not establish socket with any provided host"; @@ -291,7 +291,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Returns the response to the SOCKS5 Bytestream request containing the SOCKS5 proxy used. - * + * * @param selectedHost the used SOCKS5 proxy * @return the response to the SOCKS5 Bytestream request */ @@ -306,7 +306,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Increments the connection failure counter by one for the given address. - * + * * @param address the address the connection failure counter should be increased */ private static void incrementConnectionFailures(String address) { @@ -316,7 +316,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest { /** * Returns how often the connection to the given address failed. - * + * * @param address the address * @return number of connection failures */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamSession.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamSession.java index c44b85f2a..a75a1763f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamSession.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamSession.java @@ -26,7 +26,7 @@ import org.jivesoftware.smackx.bytestreams.BytestreamSession; /** * Socks5BytestreamSession class represents a SOCKS5 Bytestream session. - * + * * @author Henning Staib */ public class Socks5BytestreamSession implements BytestreamSession { @@ -45,7 +45,7 @@ public class Socks5BytestreamSession implements BytestreamSession { /** * Returns true if the session is established through a direct connection between * the initiator and target, false if the session is mediated over a SOCKS proxy. - * + * * @return true if session is a direct connection, false if session is * mediated over a SOCKS5 proxy */ @@ -56,7 +56,7 @@ public class Socks5BytestreamSession implements BytestreamSession { /** * Returns true if the session is mediated over a SOCKS proxy, false * if this session is established through a direct connection between the initiator and target. - * + * * @return true if session is mediated over a SOCKS5 proxy, false if * session is a direct connection */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java index b2d35e500..1e58b9c9f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java @@ -41,7 +41,7 @@ import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream.StreamHost; * The SOCKS5 client class handles establishing a connection to a SOCKS5 proxy. Connecting to a * SOCKS5 proxy requires authentication. This implementation only supports the no-authentication * authentication method. - * + * * @author Henning Staib */ public class Socks5Client { @@ -56,7 +56,7 @@ public class Socks5Client { /** * Constructor for a SOCKS5 client. - * + * * @param streamHost containing network settings of the SOCKS5 proxy * @param digest identifying the SOCKS5 Bytestream */ @@ -68,14 +68,14 @@ public class Socks5Client { /** * Returns the initialized socket that can be used to transfer data between peers via the SOCKS5 * proxy. - * + * * @param timeout timeout to connect to SOCKS5 proxy in milliseconds * @return socket the initialized socket * @throws IOException if initializing the socket failed due to a network error * @throws TimeoutException if connecting to SOCKS5 proxy timed out * @throws InterruptedException if the current thread was interrupted while waiting * @throws SmackException if the connection to the SOCKS5 proxy failed - * @throws XMPPException + * @throws XMPPException */ public Socket getSocket(int timeout) throws IOException, InterruptedException, TimeoutException, SmackException, XMPPException { @@ -139,10 +139,10 @@ public class Socks5Client { * Initializes the connection to the SOCKS5 proxy by negotiating authentication method and * requesting a stream for the given digest. Currently only the no-authentication method is * supported by the Socks5Client. - * + * * @param socket connected to a SOCKS5 proxy - * @throws SmackException - * @throws IOException + * @throws SmackException + * @throws IOException */ protected void establish(Socket socket) throws SmackException, IOException { @@ -196,7 +196,7 @@ public class Socks5Client { * type "domain" and the digest as address. *

    * (see RFC1928) - * + * * @return SOCKS5 connection request message */ private byte[] createSocks5ConnectRequest() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java index a81b87f6f..536aeaa23 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java @@ -39,7 +39,7 @@ import org.jxmpp.jid.Jid; * to the local SOCKS5 proxy differs form the regular way to connect to a SOCKS5 proxy. Additionally * a remote SOCKS5 proxy has to be activated by the initiator before data can be transferred between * the peers. - * + * * @author Henning Staib */ public class Socks5ClientForInitiator extends Socks5Client { @@ -56,7 +56,7 @@ public class Socks5ClientForInitiator extends Socks5Client { /** * Creates a new SOCKS5 client for the initiators side. - * + * * @param streamHost containing network settings of the SOCKS5 proxy * @param digest identifying the SOCKS5 Bytestream * @param connection the XMPP connection @@ -107,10 +107,10 @@ public class Socks5ClientForInitiator extends Socks5Client { /** * Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation stanza to the * SOCKS5 proxy. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @throws SmackException if there was no response from the server. */ private void activate() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -121,7 +121,7 @@ public class Socks5ClientForInitiator extends Socks5Client { /** * Returns a SOCKS5 Bytestream activation packet. - * + * * @return SOCKS5 Bytestream activation packet */ private Bytestream createStreamHostActivation() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java index 88727c668..e97ea15e6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java @@ -66,7 +66,7 @@ import org.jivesoftware.smack.util.StringUtils; * with other address types

    • * * (see RFC 1928) - * + * * @author Henning Staib */ public final class Socks5Proxy { @@ -131,7 +131,7 @@ public final class Socks5Proxy { /** * Returns true if the local Socks5 proxy should be started. Default is true. - * + * * @return if the local Socks5 proxy should be started */ public static boolean isLocalSocks5ProxyEnabled() { @@ -140,7 +140,7 @@ public final class Socks5Proxy { /** * Sets if the local Socks5 proxy should be started. Default is true. - * + * * @param localSocks5ProxyEnabled if the local Socks5 proxy should be started */ public static void setLocalSocks5ProxyEnabled(boolean localSocks5ProxyEnabled) { @@ -149,7 +149,7 @@ public final class Socks5Proxy { /** * Return the port of the local Socks5 proxy. Default is 7777. - * + * * @return the port of the local Socks5 proxy */ public static int getLocalSocks5ProxyPort() { @@ -159,7 +159,7 @@ public final class Socks5Proxy { /** * Sets the port of the local Socks5 proxy. Default is 7777. If you set the port to a negative * value Smack tries the absolute value and all following until it finds an open port. - * + * * @param localSocks5ProxyPort the port of the local Socks5 proxy to set */ public static void setLocalSocks5ProxyPort(int localSocks5ProxyPort) { @@ -171,7 +171,7 @@ public final class Socks5Proxy { /** * Returns the local SOCKS5 proxy server. - * + * * @return the local SOCKS5 proxy server */ public static synchronized Socks5Proxy getSocks5Proxy() { @@ -260,7 +260,7 @@ public final class Socks5Proxy { * Note that the list of addresses initially contains the address returned by * InetAddress.getLocalHost().getHostAddress(). You can replace the list of * addresses by invoking {@link #replaceLocalAddresses(Collection)}. - * + * * @param address the local network address to add */ public void addLocalAddress(String address) { @@ -275,7 +275,7 @@ public final class Socks5Proxy { /** * Removes the given address from the list of local network addresses. This address will then no * longer be used of outgoing SOCKS5 Bytestream requests. - * + * * @param address the local network address to remove * @return true if the address was removed. */ @@ -288,7 +288,7 @@ public final class Socks5Proxy { /** * Returns an set of the local network addresses that will be used for streamhost * candidates of outgoing SOCKS5 Bytestream requests. - * + * * @return set of the local network addresses */ public List getLocalAddresses() { @@ -304,7 +304,7 @@ public final class Socks5Proxy { * want to define their order. This may be necessary if your application is running on a machine * with multiple network interfaces or if you want to provide your public address in case you * are behind a NAT router. - * + * * @param addresses the new list of local network addresses */ public void replaceLocalAddresses(Collection addresses) { @@ -319,7 +319,7 @@ public final class Socks5Proxy { /** * Returns the port of the local SOCKS5 proxy server. If it is not running -1 will be returned. - * + * * @return the port of the local SOCKS5 proxy server or -1 if proxy is not running */ public int getPort() { @@ -333,7 +333,7 @@ public final class Socks5Proxy { * Returns the socket for the given digest. A socket will be returned if the given digest has * been in the list of allowed transfers (see {@link #addTransfer(String)}) while the peer * connected to the SOCKS5 proxy. - * + * * @param digest identifying the connection * @return socket or null if there is no socket for the given digest */ @@ -345,7 +345,7 @@ public final class Socks5Proxy { * Add the given digest to the list of allowed transfers. Only connections for allowed transfers * are stored and can be retrieved by invoking {@link #getSocket(String)}. All connections to * the local SOCKS5 proxy that don't contain an allowed digest are discarded. - * + * * @param digest to be added to the list of allowed transfers */ public void addTransfer(String digest) { @@ -358,7 +358,7 @@ public final class Socks5Proxy { *

    * The digest should be removed after establishing the SOCKS5 Bytestream is finished, an error * occurred while establishing the connection or if the connection is not allowed anymore. - * + * * @param digest to be removed from the list of allowed transfers */ protected void removeTransfer(String digest) { @@ -369,7 +369,7 @@ public final class Socks5Proxy { /** * Returns true if the local SOCKS5 proxy server is running, otherwise * false. - * + * * @return true if the local SOCKS5 proxy server is running, otherwise * false */ @@ -423,7 +423,7 @@ public final class Socks5Proxy { /** * Negotiates a SOCKS5 connection and stores it on success. - * + * * @param socket connection to the client * @throws SmackException if client requests a connection in an unsupported way * @throws IOException if a network error occurred diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Utils.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Utils.java index bca0c5727..209c3d1d4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Utils.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Utils.java @@ -26,7 +26,7 @@ import org.jxmpp.jid.Jid; /** * A collection of utility methods for SOcKS5 messages. - * + * * @author Henning Staib */ public class Socks5Utils { @@ -34,7 +34,7 @@ public class Socks5Utils { /** * Returns a SHA-1 digest of the given parameters as specified in XEP-0065. - * + * * @param sessionID for the SOCKS5 Bytestream * @param initiatorJID JID of the initiator of a SOCKS5 Bytestream * @param targetJID JID of the target of a SOCKS5 Bytestream @@ -51,7 +51,7 @@ public class Socks5Utils { * message or a SOCKS5 response message. *

    * (see RFC1928) - * + * * @param in the DataInputStream to read the message from * @return the SOCKS5 message * @throws IOException if a network error occurred diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java index 39732bf08..a11226c75 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java @@ -30,7 +30,7 @@ import org.jxmpp.jid.Jid; /** * A stanza representing part of a SOCKS5 Bytestream negotiation. - * + * * @author Alexander Wenckus */ public class Bytestream extends IQ { @@ -61,7 +61,7 @@ public class Bytestream extends IQ { /** * A constructor where the session ID can be specified. - * + * * @param SID The session ID related to the negotiation. * @see #setSessionID(String) */ @@ -73,7 +73,7 @@ public class Bytestream extends IQ { /** * Set the session ID related to the bytestream. The session ID is a unique identifier used to * differentiate between stream negotiations. - * + * * @param sessionID the unique session ID that identifies the transfer. */ public void setSessionID(final String sessionID) { @@ -82,7 +82,7 @@ public class Bytestream extends IQ { /** * Returns the session ID related to the bytestream negotiation. - * + * * @return Returns the session ID related to the bytestream negotiation. * @see #setSessionID(String) */ @@ -92,7 +92,7 @@ public class Bytestream extends IQ { /** * Set the transport mode. This should be put in the initiation of the interaction. - * + * * @param mode the transport mode, either UDP or TCP * @see Mode */ @@ -102,7 +102,7 @@ public class Bytestream extends IQ { /** * Returns the transport mode. - * + * * @return Returns the transport mode. * @see #setMode(Mode) */ @@ -112,7 +112,7 @@ public class Bytestream extends IQ { /** * Adds a potential stream host that the remote user can connect to to receive the file. - * + * * @param JID The JID of the stream host. * @param address The internet address of the stream host. * @return The added stream host. @@ -123,7 +123,7 @@ public class Bytestream extends IQ { /** * Adds a potential stream host that the remote user can connect to to receive the file. - * + * * @param JID The JID of the stream host. * @param address The internet address of the stream host. * @param port The port on which the remote host is seeking connections. @@ -138,7 +138,7 @@ public class Bytestream extends IQ { /** * Adds a potential stream host that the remote user can transfer the file through. - * + * * @param host The potential stream host. */ public void addStreamHost(final StreamHost host) { @@ -147,7 +147,7 @@ public class Bytestream extends IQ { /** * Returns the list of stream hosts contained in the packet. - * + * * @return Returns the list of stream hosts contained in the packet. */ public List getStreamHosts() { @@ -156,7 +156,7 @@ public class Bytestream extends IQ { /** * Returns the stream host related to the given JID, or null if there is none. - * + * * @param JID The JID of the desired stream host. * @return Returns the stream host related to the given JID, or null if there is none. */ @@ -175,7 +175,7 @@ public class Bytestream extends IQ { /** * Returns the count of stream hosts contained in this packet. - * + * * @return Returns the count of stream hosts contained in this packet. */ public int countStreamHosts() { @@ -185,7 +185,7 @@ public class Bytestream extends IQ { /** * Upon connecting to the stream host the target of the stream replies to the initiator with the * JID of the SOCKS5 host that they used. - * + * * @param JID The JID of the used host. */ public void setUsedHost(final Jid JID) { @@ -194,7 +194,7 @@ public class Bytestream extends IQ { /** * Returns the SOCKS5 host connected to by the remote user. - * + * * @return Returns the SOCKS5 host connected to by the remote user. */ public StreamHostUsed getUsedHost() { @@ -204,7 +204,7 @@ public class Bytestream extends IQ { /** * Returns the activate element of the stanza sent to the proxy host to verify the identity of * the initiator and match them to the appropriate stream. - * + * * @return Returns the activate element of the stanza sent to the proxy host to verify the * identity of the initiator and match them to the appropriate stream. */ @@ -216,7 +216,7 @@ public class Bytestream extends IQ { * Upon the response from the target of the used host the activate stanza is sent to the SOCKS5 * proxy. The proxy will activate the stream or return an error after verifying the identity of * the initiator, using the activate packet. - * + * * @param targetID The JID of the target of the file transfer. */ public void setToActivate(final Jid targetID) { @@ -262,7 +262,7 @@ public class Bytestream extends IQ { /** * Stanza extension that represents a potential SOCKS5 proxy for the file transfer. Stream hosts * are forwarded to the target of the file transfer who then chooses and connects to one. - * + * * @author Alexander Wenckus */ public static class StreamHost implements NamedElement { @@ -281,7 +281,7 @@ public class Bytestream extends IQ { /** * Default constructor. - * + * * @param JID The JID of the stream host. * @param address The internet address of the stream host. * @param port port of the stream host. @@ -294,7 +294,7 @@ public class Bytestream extends IQ { /** * Returns the JID of the stream host. - * + * * @return Returns the JID of the stream host. */ public Jid getJID() { @@ -303,7 +303,7 @@ public class Bytestream extends IQ { /** * Returns the internet address of the stream host. - * + * * @return Returns the internet address of the stream host. */ public String getAddress() { @@ -312,7 +312,7 @@ public class Bytestream extends IQ { /** * Returns the port on which the potential stream host would accept the connection. - * + * * @return Returns the port on which the potential stream host would accept the connection. */ public int getPort() { @@ -342,7 +342,7 @@ public class Bytestream extends IQ { /** * After selected a SOCKS5 stream host and successfully connecting, the target of the file * transfer returns a byte stream stanza with the stream host used extension. - * + * * @author Alexander Wenckus */ public static class StreamHostUsed implements NamedElement { @@ -353,7 +353,7 @@ public class Bytestream extends IQ { /** * Default constructor. - * + * * @param JID The JID of the selected stream host. */ public StreamHostUsed(final Jid JID) { @@ -362,7 +362,7 @@ public class Bytestream extends IQ { /** * Returns the JID of the selected stream host. - * + * * @return Returns the JID of the selected stream host. */ public Jid getJID() { @@ -385,7 +385,7 @@ public class Bytestream extends IQ { /** * The stanza sent by the stream initiator to the stream proxy to activate the connection. - * + * * @author Alexander Wenckus */ public static class Activate implements NamedElement { @@ -396,7 +396,7 @@ public class Bytestream extends IQ { /** * Default constructor specifying the target of the stream. - * + * * @param target The target of the stream. */ public Activate(final Jid target) { @@ -405,7 +405,7 @@ public class Bytestream extends IQ { /** * Returns the target of the activation. - * + * * @return Returns the target of the activation. */ public Jid getTarget() { @@ -429,7 +429,7 @@ public class Bytestream extends IQ { /** * The stream can be either a TCP stream or a UDP stream. - * + * * @author Alexander Wenckus */ public enum Mode { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/provider/BytestreamsProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/provider/BytestreamsProvider.java index a4569b0d8..510d5f7d8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/provider/BytestreamsProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/provider/BytestreamsProvider.java @@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * Parses a bytestream packet. - * + * * @author Alexander Wenckus */ public class BytestreamsProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java index 920329835..ffe84d231 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java @@ -73,7 +73,7 @@ import org.jxmpp.util.cache.LruCache; /** * Keeps track of entity capabilities. - * + * * @author Florian Schmaus * @see XEP-0115: Entity Capabilities */ @@ -141,7 +141,7 @@ public final class EntityCapsManager extends Manager { /** * Add DiscoverInfo to the database. - * + * * @param nodeVer * The node and verification String (e.g. * "http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w="). @@ -158,7 +158,7 @@ public final class EntityCapsManager extends Manager { /** * Get the Node version (node#ver) of a JID. Returns a String or null if * EntiyCapsManager does not have any information. - * + * * @param jid * the user (Full JID) * @return the node version (node#ver) or null @@ -180,7 +180,7 @@ public final class EntityCapsManager extends Manager { * Get the discover info given a user name. The discover info is returned if * the user has a node#ver associated with it and the node#ver has a * discover info associated with it. - * + * * @param user * user name (Full JID) * @return the discovered info @@ -195,7 +195,7 @@ public final class EntityCapsManager extends Manager { /** * Retrieve DiscoverInfo for a specific node. - * + * * @param nodeVer * The node name (e.g. * "http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w="). @@ -222,7 +222,7 @@ public final class EntityCapsManager extends Manager { /** * Set the persistent cache implementation. - * + * * @param cache */ public static void setPersistentCache(EntityCapsPersistentCache cache) { @@ -404,7 +404,7 @@ public final class EntityCapsManager extends Manager { /** * Remove a record telling what entity caps node a user has. - * + * * @param user * the user (Full JID) */ @@ -417,7 +417,7 @@ public final class EntityCapsManager extends Manager { /** * Get our own caps version. The version depends on the enabled features. * A caps version looks like '66/0NaeaBKkwk85efJTGmU47vXI=' - * + * * @return our own caps version */ public CapsVersionAndHash getCapsVersionAndHash() { @@ -428,7 +428,7 @@ public final class EntityCapsManager extends Manager { * Returns the local entity's NodeVer (e.g. * "http://www.igniterealtime.org/projects/smack/#66/0NaeaBKkwk85efJTGmU47vXI= * ) - * + * * @return the local NodeVer */ public String getLocalNodeVer() { @@ -441,13 +441,13 @@ public final class EntityCapsManager extends Manager { /** * Returns true if Entity Caps are supported by a given JID. - * + * * @param jid * @return true if the entity supports Entity Capabilities. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean areEntityCapsSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return sdm.supportsFeature(jid, NAMESPACE); @@ -455,12 +455,12 @@ public final class EntityCapsManager extends Manager { /** * Returns true if Entity Caps are supported by the local service/server. - * + * * @return true if the user's server supports Entity Capabilities. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean areEntityCapsSupportedByServer() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return areEntityCapsSupported(connection().getXMPPServiceDomain()); @@ -531,10 +531,10 @@ public final class EntityCapsManager extends Manager { /** * Verify DiscoverInfo and Caps Node as defined in XEP-0115 5.4 Processing * Method. - * + * * @see XEP-0115 * 5.4 Processing Method - * + * * @param ver * @param hash * @param info @@ -562,7 +562,7 @@ public final class EntityCapsManager extends Manager { } /** - * + * * @param info * @return true if the stanza extensions is ill-formed */ @@ -591,10 +591,10 @@ public final class EntityCapsManager extends Manager { /** * Generates a XEP-115 Verification String - * + * * @see XEP-115 * Verification String - * + * * @param discoverInfo * @param hash * the used hash function, if null, default hash will be used diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java index 64c5c58f3..87df05d49 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java @@ -21,7 +21,7 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo; public interface EntityCapsPersistentCache { /** * Add an DiscoverInfo to the persistent Cache. - * + * * @param nodeVer * @param info */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java index 6caf1e9ee..f6a60b960 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java @@ -35,9 +35,9 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo; * Simple implementation of an EntityCapsPersistentCache that uses a directory * to store the Caps information for every known node. Every node is represented * by a file. - * + * * @author Florian Schmaus - * + * */ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache { private static final Logger LOGGER = Logger.getLogger(SimpleDirectoryPersistentCache.class.getName()); @@ -49,10 +49,10 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache * Creates a new SimpleDirectoryPersistentCache Object. Make sure that the * cacheDir exists and that it's an directory. *

    - * Default filename encoder {@link Base32}, as this will work on all - * file systems, both case sensitive and case insensitive. It does however + * Default filename encoder {@link Base32}, as this will work on all + * file systems, both case sensitive and case insensitive. It does however * produce longer filenames. - * + * * @param cacheDir */ public SimpleDirectoryPersistentCache(File cacheDir) { @@ -62,10 +62,10 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache /** * Creates a new SimpleDirectoryPersistentCache Object. Make sure that the * cacheDir exists and that it's an directory. - * + * * If your cacheDir is case insensitive then make sure to set the * StringEncoder to {@link Base32} (which is the default). - * + * * @param cacheDir The directory where the cache will be stored. * @param filenameEncoder Encodes the node string into a filename. */ @@ -124,7 +124,7 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache /** * Writes the DiscoverInfo stanza to an file - * + * * @param file * @param info * @throws IOException @@ -140,7 +140,7 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache /** * Tries to restore an DiscoverInfo stanza from a file. - * + * * @param file * @return the restored DiscoverInfo * @throws Exception diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java index 37028483d..fffd03cd5 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java @@ -68,9 +68,9 @@ import org.jxmpp.jid.Jid; *

    * Use the getSpecificErrorConditionFrom to obtain the specific * information from an XMPPError. - * + * * @author Gabriel Guardincerri - * + * */ public abstract class AdHocCommand { // TODO: Analyze the redesign of command by having an ExecutionResponse as a @@ -89,7 +89,7 @@ public abstract class AdHocCommand { /** * Returns the specific condition of the error or null if the * error doesn't have any. - * + * * @param error the error the get the specific condition from. * @return the specific condition of this error, or null if it doesn't have * any. @@ -109,7 +109,7 @@ public abstract class AdHocCommand { /** * Set the the human readable name of the command, usually used for * displaying in a UI. - * + * * @param name the name. */ public void setName(String name) { @@ -118,7 +118,7 @@ public abstract class AdHocCommand { /** * Returns the human readable name of the command. - * + * * @return the human readable name of the command */ public String getName() { @@ -128,7 +128,7 @@ public abstract class AdHocCommand { /** * Sets the unique identifier of the command. This value must be unique for * the OwnerJID. - * + * * @param node the unique identifier of the command. */ public void setNode(String node) { @@ -138,7 +138,7 @@ public abstract class AdHocCommand { /** * Returns the unique identifier of the command. It is unique for the * OwnerJID. - * + * * @return the unique identifier of the command. */ public String getNode() { @@ -148,14 +148,14 @@ public abstract class AdHocCommand { /** * Returns the full JID of the owner of this command. This JID is the "to" of a * execution request. - * + * * @return the owner JID. */ public abstract Jid getOwnerJID(); /** * Returns the notes that the command has at the current stage. - * + * * @return a list of notes. */ public List getNotes() { @@ -167,7 +167,7 @@ public abstract class AdHocCommand { * response to the execution of an action. All the notes added here are * returned by the {@link #getNotes} method during the current stage. * Once the stage changes all the notes are discarded. - * + * * @param note the note. */ protected void addNote(AdHocCommandNote note) { @@ -184,7 +184,7 @@ public abstract class AdHocCommand { * used by the requester to fill all the information that the executor needs * to continue to the next stage. It can also be the result of the * execution. - * + * * @return the form of the current stage to fill out or the result of the * execution. */ @@ -201,7 +201,7 @@ public abstract class AdHocCommand { * Sets the form of the current stage. This should be used when setting a * response. It could be a form to fill out the information needed to go to * the next stage or the result of an execution. - * + * * @param form the form of the current stage to fill out or the result of the * execution. */ @@ -216,8 +216,8 @@ public abstract class AdHocCommand { * * @throws NoResponseException * @throws XMPPErrorException if there is an error executing the command. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public abstract void execute() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException; @@ -227,12 +227,12 @@ public abstract class AdHocCommand { * previous stage. This method will be only invoked for commands that have one * or more stages. If there is a problem executing the command it throws an * XMPPException. - * + * * @param response the form answer of the previous stage. * @throws NoResponseException * @throws XMPPErrorException if there is a problem executing the command. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public abstract void next(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException; @@ -242,13 +242,13 @@ public abstract class AdHocCommand { * previous stage. This method will be only invoked for commands that have one * or more stages. If there is a problem executing the command it throws an * XMPPException. - * + * * @param response the form answer of the previous stage. * * @throws NoResponseException * @throws XMPPErrorException if there is a problem executing the command. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public abstract void complete(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException; @@ -260,8 +260,8 @@ public abstract class AdHocCommand { * * @throws NoResponseException * @throws XMPPErrorException if there is a problem executing the command. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public abstract void prev() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException; @@ -272,8 +272,8 @@ public abstract class AdHocCommand { * * @throws NoResponseException * @throws XMPPErrorException if there is a problem executing the command. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public abstract void cancel() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException; @@ -282,7 +282,7 @@ public abstract class AdHocCommand { * Possible actions are: {@link Action#prev prev}, {@link Action#next next} and * {@link Action#complete complete}. This method will be only invoked for commands that * have one or more stages. - * + * * @return a collection with the allowed actions based on the current stage * as defined in the SessionData. */ @@ -293,7 +293,7 @@ public abstract class AdHocCommand { /** * Add an action to the current stage available actions. This should be used * when creating a response. - * + * * @param action the action. */ protected void addActionAvailable(Action action) { @@ -306,7 +306,7 @@ public abstract class AdHocCommand { * reply, if no action was defined in the command then the action will be * assumed "execute" thus assuming the action returned by this method. This * method will never be invoked for commands that have no stages. - * + * * @return the action available for the current stage which is considered * the equivalent to "execute". */ @@ -320,7 +320,7 @@ public abstract class AdHocCommand { * a response. When the requester sends his reply, if no action was defined * in the command then the action will be assumed "execute" thus assuming * the action returned by this method. - * + * * @param action the action. */ protected void setExecuteAction(Action action) { @@ -329,7 +329,7 @@ public abstract class AdHocCommand { /** * Returns the status of the current stage. - * + * * @return the current status. */ public Status getStatus() { @@ -338,7 +338,7 @@ public abstract class AdHocCommand { /** * Check if this command has been completed successfully. - * + * * @return true if this command is completed. * @since 4.2 */ @@ -348,7 +348,7 @@ public abstract class AdHocCommand { /** * Sets the data of the current stage. This should not used. - * + * * @param data the data. */ void setData(AdHocCommandData data) { @@ -368,7 +368,7 @@ public abstract class AdHocCommand { * Returns true if the action is available in the current stage. * The {@link Action#cancel cancel} action is always allowed. To define the * available actions use the addActionAvailable method. - * + * * @param action * The action to check if it is available. * @return True if the action is available for the current stage. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java index 5a7e72125..871d84840 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java @@ -59,8 +59,8 @@ import org.jxmpp.jid.Jid; * * Pass in an XMPPConnection instance to * {@link #getAddHocCommandsManager(XMPPConnection)} in order to - * get an instance of this class. - * + * get an instance of this class. + * * @author Gabriel Guardincerri */ public final class AdHocCommandManager extends Manager { @@ -258,7 +258,7 @@ public final class AdHocCommandManager extends Manager { * @return the discovered items. * @throws XMPPException if the operation failed for some reason. * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ public DiscoverItems discoverCommands(Jid jid) throws XMPPException, SmackException, InterruptedException { return serviceDiscoveryManager.discoverItems(jid, NAMESPACE); @@ -270,7 +270,7 @@ public final class AdHocCommandManager extends Manager { * @param jid the full JID to publish the commands to. * @throws XMPPException if the operation failed for some reason. * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException * @deprecated This method uses no longer existent XEP-0030 features and will be removed. */ @SuppressWarnings("deprecation") @@ -315,7 +315,7 @@ public final class AdHocCommandManager extends Manager { *
  • The command has more than one stage, if so, it saves the command and * session ID for further use
    • * - * + * *
    *
    * If this is not the first request, this method checks, before executing @@ -330,7 +330,7 @@ public final class AdHocCommandManager extends Manager { * the stanza to process. * @throws NotConnectedException * @throws NoResponseException - * @throws InterruptedException + * @throws InterruptedException */ private IQ processAdHocCommand(AdHocCommandData requestData) throws NoResponseException, NotConnectedException, InterruptedException { // Creates the response with the corresponding data @@ -587,10 +587,10 @@ public final class AdHocCommandManager extends Manager { /** * Responds an error with an specific condition. - * + * * @param response the response to send. * @param condition the condition of the error. - * @throws NotConnectedException + * @throws NotConnectedException */ private static IQ respondError(AdHocCommandData response, StanzaError.Condition condition) { @@ -599,11 +599,11 @@ public final class AdHocCommandManager extends Manager { /** * Responds an error with an specific condition. - * + * * @param response the response to send. * @param condition the condition of the error. * @param specificCondition the adhoc command error condition. - * @throws NotConnectedException + * @throws NotConnectedException */ private static IQ respondError(AdHocCommandData response, StanzaError.Condition condition, AdHocCommand.SpecificErrorCondition specificCondition) { @@ -613,10 +613,10 @@ public final class AdHocCommandManager extends Manager { /** * Responds an error with an specific error. - * + * * @param response the response to send. * @param error the error to send. - * @throws NotConnectedException + * @throws NotConnectedException */ private static IQ respondError(AdHocCommandData response, StanzaError.Builder error) { response.setType(IQ.Type.error); @@ -626,17 +626,17 @@ public final class AdHocCommandManager extends Manager { /** * Creates a new instance of a command to be used by a new execution request - * + * * @param commandNode the command node that identifies it. * @param sessionID the session id of this execution. * @return the command instance to execute. * @throws XMPPErrorException if there is problem creating the new instance. - * @throws SecurityException - * @throws NoSuchMethodException - * @throws InvocationTargetException - * @throws IllegalArgumentException - * @throws IllegalAccessException - * @throws InstantiationException + * @throws SecurityException + * @throws NoSuchMethodException + * @throws InvocationTargetException + * @throws IllegalArgumentException + * @throws IllegalAccessException + * @throws InstantiationException */ private LocalCommand newInstanceOfCmd(String commandNode, String sessionID) throws XMPPErrorException, InstantiationException, IllegalAccessException, IllegalArgumentException, @@ -653,7 +653,7 @@ public final class AdHocCommandManager extends Manager { /** * Returns the registered commands of this command manager, which is related * to a connection. - * + * * @return the registered commands. */ private Collection getRegisteredCommands() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandNote.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandNote.java index 31489b177..7c8dfe72c 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandNote.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandNote.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.commands; /** * Notes can be added to a command execution response. A note has a type and value. - * + * * @author Gabriel Guardincerri */ public class AdHocCommandNote { @@ -40,7 +40,7 @@ public class AdHocCommandNote { /** * Returns the value or message of the note. - * + * * @return the value or message of the note. */ public String getValue() { @@ -49,7 +49,7 @@ public class AdHocCommandNote { /** * Return the type of the note. - * + * * @return the type of the note. */ public Type getType() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java index 51af61483..4a3c49fce 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java @@ -36,7 +36,7 @@ import org.jxmpp.jid.Jid; * methods. When implementing the actions remember that they could be invoked * several times, and that you must use the current stage number to know what to * do. - * + * * @author Gabriel Guardincerri */ public abstract class LocalCommand extends AdHocCommand { @@ -70,7 +70,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * The sessionID is an unique identifier of an execution request. This is * automatically handled and should not be called. - * + * * @param sessionID the unique session id of this execution */ public void setSessionID(String sessionID) { @@ -80,7 +80,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * Returns the session ID of this execution. - * + * * @return the unique session id of this execution */ public String getSessionID() { @@ -90,7 +90,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * Sets the JID of the command host. This is automatically handled and should * not be called. - * + * * @param ownerJID the JID of the owner. */ public void setOwnerJID(Jid ownerJID) { @@ -104,7 +104,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * Returns the date the command was created. - * + * * @return the date the command was created. */ public long getCreationDate() { @@ -115,7 +115,7 @@ public abstract class LocalCommand extends AdHocCommand { * Returns true if the current stage is the last one. If it is then the * execution of some action will complete the execution of the command. * Commands that don't have multiple stages can always return true. - * + * * @return true if the command is in the last stage. */ public abstract boolean isLastStage(); @@ -151,7 +151,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * Increase the current stage number. This is automatically handled and should * not be called. - * + * */ void incrementStage() { currentStage++; @@ -160,7 +160,7 @@ public abstract class LocalCommand extends AdHocCommand { /** * Decrease the current stage number. This is automatically handled and should * not be called. - * + * */ void decrementStage() { currentStage--; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommandFactory.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommandFactory.java index 84fd2b876..0df24d776 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommandFactory.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommandFactory.java @@ -24,7 +24,7 @@ import java.lang.reflect.InvocationTargetException; * when arguments must be passed into the constructor or when using a dependency injection * framework. When a LocalCommandFactory isn't used, you can provide the AdHocCommandManager * a Class object instead. For more details, see - * {@link AdHocCommandManager#registerCommand(String, String, LocalCommandFactory)}. + * {@link AdHocCommandManager#registerCommand(String, String, LocalCommandFactory)}. * * @author Matt Tucker */ @@ -36,10 +36,10 @@ public interface LocalCommandFactory { * @return a LocalCommand instance. * @throws InstantiationException if creating an instance failed. * @throws IllegalAccessException if creating an instance is not allowed. - * @throws SecurityException - * @throws NoSuchMethodException - * @throws InvocationTargetException - * @throws IllegalArgumentException + * @throws SecurityException + * @throws NoSuchMethodException + * @throws InvocationTargetException + * @throws IllegalArgumentException */ LocalCommand getInstance() throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java index 10507ecea..98f61c331 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java @@ -97,8 +97,8 @@ public class RemoteCommand extends AdHocCommand { * @param form the form answer of the previous stage. * @throws XMPPErrorException if an error occurs. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void execute(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { executeAction(Action.execute, form); @@ -127,8 +127,8 @@ public class RemoteCommand extends AdHocCommand { * @param form the form with the information. * @throws XMPPErrorException if there is a problem executing the command. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ private void executeAction(Action action, Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // TODO: Check that all the required fields of the form were filled, if diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java index de2a8c04d..e25154811 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java @@ -33,7 +33,7 @@ import org.jxmpp.jid.Jid; /** * Represents the state and the request of the execution of an adhoc command. - * + * * @author Gabriel Guardincerri */ public class AdHocCommandData extends IQ { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/provider/AdHocCommandDataProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/provider/AdHocCommandDataProvider.java index bc64d2e78..79866ffb6 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/provider/AdHocCommandDataProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/provider/AdHocCommandDataProvider.java @@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParser; /** * The AdHocCommandDataProvider parses AdHocCommandData packets. - * + * * @author Gabriel Guardincerri */ public class AdHocCommandDataProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java index c17068d43..6fe3c4de6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java @@ -25,14 +25,14 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jxmpp.util.XmppDateTime; /** - * Represents timestamp information about data stored for later delivery. A DelayInformation will - * always includes the timestamp when the stanza was originally sent and may include more + * Represents timestamp information about data stored for later delivery. A DelayInformation will + * always includes the timestamp when the stanza was originally sent and may include more * information such as the JID of the entity that originally sent the stanza as well as the reason * for the delay.

    - * + * * For more information see XEP-0091 * and XEP-0203. - * + * * @author Gaston Dombiak * @author Florian Schmaus */ @@ -45,7 +45,7 @@ public class DelayInformation implements ExtensionElement { private final String reason; /** - * Creates a new instance with the specified timestamp. + * Creates a new instance with the specified timestamp. * @param stamp the timestamp * @param from sender * @param reason reason of delay. @@ -61,10 +61,10 @@ public class DelayInformation implements ExtensionElement { } /** - * Returns the JID of the entity that originally sent the stanza or that delayed the + * Returns the JID of the entity that originally sent the stanza or that delayed the * delivery of the stanza or null if this information is not available. - * - * @return the JID of the entity that originally sent the stanza or that delayed the + * + * @return the JID of the entity that originally sent the stanza or that delayed the * delivery of the packet. */ public String getFrom() { @@ -72,9 +72,9 @@ public class DelayInformation implements ExtensionElement { } /** - * Returns the timestamp when the stanza was originally sent. The returned Date is + * Returns the timestamp when the stanza was originally sent. The returned Date is * be understood as UTC. - * + * * @return the timestamp when the stanza was originally sent. */ public Date getStamp() { @@ -82,9 +82,9 @@ public class DelayInformation implements ExtensionElement { } /** - * Returns a natural-language description of the reason for the delay or null if + * Returns a natural-language description of the reason for the delay or null if * this information is not available. - * + * * @return a natural-language description of the reason for the delay or null. */ public String getReason() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/provider/DelayInformationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/provider/DelayInformationProvider.java index a9ed78498..fc7378410 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/provider/DelayInformationProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/provider/DelayInformationProvider.java @@ -23,7 +23,7 @@ import org.jxmpp.util.XmppDateTime; /** * The DelayInformationProvider parses DelayInformation packets. - * + * * @author Florian Schmaus */ public class DelayInformationProvider extends AbstractDelayInformationProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java index 34a8f4969..cc8a8a5a7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/NodeInformationProvider.java @@ -38,9 +38,9 @@ public interface NodeInformationProvider { /** * Returns a list of the Items {@link org.jivesoftware.smackx.disco.packet.DiscoverItems.Item} - * defined in the node. For example, the MUC protocol specifies that an XMPP client should + * defined in the node. For example, the MUC protocol specifies that an XMPP client should * answer an Item for each joined room when asked for the rooms where the use has joined. - * + * * @return a list of the Items defined in the node. */ List getNodeItems(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java index 963076be5..bb04d50c4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java @@ -63,8 +63,8 @@ import org.jxmpp.util.cache.ExpirationCache; *

  • Automatic response when this XMPP entity is queried for information. *
  • Ability to discover items and information of remote XMPP entities. *
  • Ability to publish publicly available items. - * - * + * + * * @author Gaston Dombiak * @author Florian Schmaus */ @@ -101,7 +101,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Set the default identity all new connections will have. If unchanged the default identity is an * identity where category is set to 'client', type is set to 'pc' and name is set to 'Smack'. - * + * * @param identity */ public static void setDefaultIdentity(DiscoverInfo.Identity identity) { @@ -109,10 +109,10 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Creates a new ServiceDiscoveryManager for a given XMPPConnection. This means that the + * Creates a new ServiceDiscoveryManager for a given XMPPConnection. This means that the * service manager will respond to any service discovery request that the connection may - * receive. - * + * receive. + * * @param connection the connection to which a ServiceDiscoveryManager is going to be created. */ private ServiceDiscoveryManager(XMPPConnection connection) { @@ -121,7 +121,7 @@ public final class ServiceDiscoveryManager extends Manager { addFeature(DiscoverInfo.NAMESPACE); addFeature(DiscoverItems.NAMESPACE); - // Listen for disco#items requests and answer with an empty result + // Listen for disco#items requests and answer with an empty result connection.registerIQRequestHandler(new AbstractIqRequestHandler(DiscoverItems.ELEMENT, DiscoverItems.NAMESPACE, IQ.Type.get, Mode.async) { @Override public IQ handleIQRequest(IQ iqRequest) { @@ -150,8 +150,8 @@ public final class ServiceDiscoveryManager extends Manager { } }); - // Listen for disco#info requests and answer the client's supported features - // To add a new feature as supported use the #addFeature message + // Listen for disco#info requests and answer the client's supported features + // To add a new feature as supported use the #addFeature message connection.registerIQRequestHandler(new AbstractIqRequestHandler(DiscoverInfo.ELEMENT, DiscoverInfo.NAMESPACE, IQ.Type.get, Mode.async) { @Override public IQ handleIQRequest(IQ iqRequest) { @@ -193,7 +193,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the name of the client that will be returned when asked for the client identity * in a disco request. The name could be any value you need to identity this client. - * + * * @return the name of the client that will be returned when asked for the client identity * in a disco request. */ @@ -223,11 +223,11 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Returns the type of client that will be returned when asked for the client identity in a - * disco request. The valid types are defined by the category client. Follow this link to learn + * Returns the type of client that will be returned when asked for the client identity in a + * disco request. The valid types are defined by the category client. Follow this link to learn * the possible types: Jabber::Registrar. - * - * @return the type of client that will be returned when asked for the client identity in a + * + * @return the type of client that will be returned when asked for the client identity in a * disco request. */ public String getIdentityType() { @@ -236,7 +236,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Add an further identity to the client. - * + * * @param identity */ public synchronized void addIdentity(DiscoverInfo.Identity identity) { @@ -249,7 +249,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Remove an identity from the client. Note that the client needs at least one identity, the default identity, which * can not be removed. - * + * * @param identity * @return true, if successful. Otherwise the default identity was given. */ @@ -264,7 +264,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns all identities of this client as unmodifiable Collection. - * + * * @return all identies as set */ public Set getIdentities() { @@ -276,7 +276,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the ServiceDiscoveryManager instance associated with a given XMPPConnection. - * + * * @param connection the connection used to look for the proper ServiceDiscoveryManager. * @return the ServiceDiscoveryManager associated with a given XMPPConnection. */ @@ -292,7 +292,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Add discover info response data. - * + * * @see XEP-30 Basic Protocol; Example 2 * * @param response the discover info response packet @@ -309,14 +309,14 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Returns the NodeInformationProvider responsible for providing information + * Returns the NodeInformationProvider responsible for providing information * (ie items) related to a given node or null if none.

    - * + * * In MUC, a node could be 'http://jabber.org/protocol/muc#rooms' which means that the * NodeInformationProvider will provide information about the rooms where the user has joined. - * + * * @param node the node that contains items associated with an entity not addressable as a JID. - * @return the NodeInformationProvider responsible for providing information related + * @return the NodeInformationProvider responsible for providing information related * to a given node. */ private NodeInformationProvider getNodeInformationProvider(String node) { @@ -327,14 +327,14 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Sets the NodeInformationProvider responsible for providing information + * Sets the NodeInformationProvider responsible for providing information * (ie items) related to a given node. Every time this client receives a disco request - * regarding the items of a given node, the provider associated to that node will be the + * regarding the items of a given node, the provider associated to that node will be the * responsible for providing the requested information.

    - * + * * In MUC, a node could be 'http://jabber.org/protocol/muc#rooms' which means that the - * NodeInformationProvider will provide information about the rooms where the user has joined. - * + * NodeInformationProvider will provide information about the rooms where the user has joined. + * * @param node the node whose items will be provided by the NodeInformationProvider. * @param listener the NodeInformationProvider responsible for providing items related * to the node. @@ -344,13 +344,13 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Removes the NodeInformationProvider responsible for providing information + * Removes the NodeInformationProvider responsible for providing information * (ie items) related to a given node. This means that no more information will be * available for the specified node. - * + * * In MUC, a node could be 'http://jabber.org/protocol/muc#rooms' which means that the - * NodeInformationProvider will provide information about the rooms where the user has joined. - * + * NodeInformationProvider will provide information about the rooms where the user has joined. + * * @param node the node to remove the associated NodeInformationProvider. */ public void removeNodeInformationProvider(String node) { @@ -362,7 +362,7 @@ public final class ServiceDiscoveryManager extends Manager { *

    * The result is a copied modifiable list of the original features. *

    - * + * * @return a List of the supported features by this XMPP entity. */ public synchronized List getFeatures() { @@ -370,7 +370,7 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Registers that a new feature is supported by this XMPP entity. When this client is + * Registers that a new feature is supported by this XMPP entity. When this client is * queried for its information the registered features will be answered.

    * * Since no stanza is actually sent to the server it is safe to perform this operation @@ -436,7 +436,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the data form that is set as extended information for this Service Discovery instance (XEP-0128). - * + * * @see XEP-128: Service Discovery Extensions * @return the data form */ @@ -447,7 +447,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the data form as List of PacketExtensions, or null if no data form is set. * This representation is needed by some classes (e.g. EntityCapsManager, NodeInformationProvider) - * + * * @return the data form as List of PacketExtensions */ public List getExtendedInfoAsList() { @@ -476,13 +476,13 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the discovered information of a given XMPP entity addressed by its JID. * Use null as entityID to query the server - * + * * @param entityID the address of the XMPP entity or null. * @return the discovered information. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverInfo discoverInfo(Jid entityID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { if (entityID == null) @@ -516,19 +516,19 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the discovered information of a given XMPP entity addressed by its JID and - * note attribute. Use this message only when trying to query information which is not + * note attribute. Use this message only when trying to query information which is not * directly addressable. - * + * * @see XEP-30 Basic Protocol * @see XEP-30 Info Nodes - * + * * @param entityID the address of the XMPP entity. * @param node the optional attribute that supplements the 'jid' attribute. * @return the discovered information. * @throws XMPPErrorException if the operation failed for some reason. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverInfo discoverInfo(Jid entityID, String node) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Discover the entity's info @@ -544,13 +544,13 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the discovered items of a given XMPP entity addressed by its JID. - * + * * @param entityID the address of the XMPP entity. * @return the discovered information. * @throws XMPPErrorException if the operation failed for some reason. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverItems discoverItems(Jid entityID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return discoverItems(entityID, null); @@ -558,16 +558,16 @@ public final class ServiceDiscoveryManager extends Manager { /** * Returns the discovered items of a given XMPP entity addressed by its JID and - * note attribute. Use this message only when trying to query information which is not + * note attribute. Use this message only when trying to query information which is not * directly addressable. - * + * * @param entityID the address of the XMPP entity. * @param node the optional attribute that supplements the 'jid' attribute. * @return the discovered items. * @throws XMPPErrorException if the operation failed for some reason. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverItems discoverItems(Jid entityID, String node) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Discover the entity's items @@ -585,13 +585,13 @@ public final class ServiceDiscoveryManager extends Manager { * to the server so that the server can provide items associated to the client. These items will * be returned by the server whenever the server receives a disco request targeted to the bare * address of the client (i.e. user@host.com). - * + * * @param entityID the address of the XMPP entity. * @return true if the server supports publishing of items. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated The disco-publish feature was removed from XEP-0030 in 2008 in favor of XEP-0060: Publish-Subscribe. */ @Deprecated @@ -606,7 +606,7 @@ public final class ServiceDiscoveryManager extends Manager { * to the server so that the server can provide items associated to the client. These items will * be returned by the server whenever the server receives a disco request targeted to the bare * address of the client (i.e. user@host.com). - * + * * @param info the discover info stanza to check. * @return true if the server supports publishing of items. * @deprecated The disco-publish feature was removed from XEP-0030 in 2008 in favor of XEP-0060: Publish-Subscribe. @@ -618,17 +618,17 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Publishes new items to a parent entity. The item elements to publish MUST have at least - * a 'jid' attribute specifying the Entity ID of the item, and an action attribute which - * specifies the action being taken for that item. Possible action values are: "update" and + * Publishes new items to a parent entity. The item elements to publish MUST have at least + * a 'jid' attribute specifying the Entity ID of the item, and an action attribute which + * specifies the action being taken for that item. Possible action values are: "update" and * "remove". - * + * * @param entityID the address of the XMPP entity. * @param discoverItems the DiscoveryItems to publish. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated The disco-publish feature was removed from XEP-0030 in 2008 in favor of XEP-0060: Publish-Subscribe. */ @Deprecated @@ -638,18 +638,18 @@ public final class ServiceDiscoveryManager extends Manager { } /** - * Publishes new items to a parent entity and node. The item elements to publish MUST have at - * least a 'jid' attribute specifying the Entity ID of the item, and an action attribute which - * specifies the action being taken for that item. Possible action values are: "update" and + * Publishes new items to a parent entity and node. The item elements to publish MUST have at + * least a 'jid' attribute specifying the Entity ID of the item, and an action attribute which + * specifies the action being taken for that item. Possible action values are: "update" and * "remove". - * + * * @param entityID the address of the XMPP entity. * @param node the attribute that supplements the 'jid' attribute. * @param discoverItems the DiscoveryItems to publish. * @throws XMPPErrorException if the operation failed for some reason. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated The disco-publish feature was removed from XEP-0030 in 2008 in favor of XEP-0060: Publish-Subscribe. */ @Deprecated @@ -670,7 +670,7 @@ public final class ServiceDiscoveryManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @since 4.1 */ public boolean serverSupportsFeature(CharSequence feature) throws NoResponseException, XMPPErrorException, @@ -730,10 +730,10 @@ public final class ServiceDiscoveryManager extends Manager { * @param jid the JID of the remote entity * @param feature * @return true if the entity supports the feature, false otherwise - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean supportsFeature(Jid jid, CharSequence feature) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return supportsFeatures(jid, feature); @@ -762,7 +762,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Find all services under the users service that provide a given feature. - * + * * @param feature the feature to search for * @param stopOnFirst if true, stop searching after the first service was found * @param useCache if true, query a cache first to avoid network I/O @@ -770,7 +770,7 @@ public final class ServiceDiscoveryManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List findServicesDiscoverInfo(String feature, boolean stopOnFirst, boolean useCache) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -884,7 +884,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Find all services under the users service that provide a given feature. - * + * * @param feature the feature to search for * @param stopOnFirst if true, stop searching after the first service was found * @param useCache if true, query a cache first to avoid network I/O @@ -892,7 +892,7 @@ public final class ServiceDiscoveryManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List findServices(String feature, boolean stopOnFirst, boolean useCache) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { List services = findServicesDiscoverInfo(feature, stopOnFirst, useCache); @@ -939,7 +939,7 @@ public final class ServiceDiscoveryManager extends Manager { /** * Loads the ServiceDiscoveryManager with an EntityCapsManger that speeds up certain lookups. - * + * * @param manager */ public void setEntityCapsManager(EntityCapsManager manager) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java index 0d760a02e..309293b9b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java @@ -32,10 +32,10 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jxmpp.util.XmppStringUtils; /** - * A DiscoverInfo IQ packet, which is used by XMPP clients to request and receive information - * to/from other XMPP entities.

    - * - * The received information may contain one or more identities of the requested XMPP entity, and + * A DiscoverInfo IQ packet, which is used by XMPP clients to request and receive information + * to/from other XMPP entities.

    + * + * The received information may contain one or more identities of the requested XMPP entity, and * a list of supported features by the requested XMPP entity. * * @author Gaston Dombiak @@ -58,7 +58,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Copy constructor. - * + * * @param d */ public DiscoverInfo(DiscoverInfo d) { @@ -120,7 +120,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Adds a new identity of the requested entity to the discovered information. - * + * * @param identity the discovered entity's identity */ public void addIdentity(Identity identity) { @@ -130,7 +130,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Adds identities to the DiscoverInfo stanza. - * + * * @param identitiesToAdd */ public void addIdentities(Collection identitiesToAdd) { @@ -142,7 +142,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Returns the discovered identities of an XMPP entity. - * + * * @return an unmodifiable list of the discovered identities */ public List getIdentities() { @@ -179,10 +179,10 @@ public class DiscoverInfo extends IQ implements TypedCloneable { } /** - * Returns the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Returns the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. * * @return the node attribute that supplements the 'jid' attribute @@ -192,12 +192,12 @@ public class DiscoverInfo extends IQ implements TypedCloneable { } /** - * Sets the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Sets the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. - * + * * @param node the node attribute that supplements the 'jid' attribute */ public void setNode(String node) { @@ -206,7 +206,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Returns true if the specified feature is part of the discovered information. - * + * * @param feature the feature to check * @return true if the requests feature has been discovered */ @@ -230,7 +230,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Test if a DiscoverInfo response contains duplicate identities. - * + * * @return true if duplicate identities where found, otherwise false */ public boolean containsDuplicateIdentities() { @@ -247,7 +247,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Test if a DiscoverInfo response contains duplicate features. - * + * * @return true if duplicate identities where found, otherwise false */ public boolean containsDuplicateFeatures() { @@ -262,11 +262,11 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Represents the identity of a given XMPP entity. An entity may have many identities but all * the identities SHOULD have the same name.

    - * + * * Refer to Jabber::Registrar - * in order to get the official registry of values for the category and type + * in order to get the official registry of values for the category and type * attributes. - * + * */ public static class Identity implements Comparable, TypedCloneable { @@ -286,7 +286,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Creates a new identity for an XMPP entity. - * + * * @param category the entity's category (required as per XEP-30). * @param type the entity's type (required as per XEP-30). */ @@ -296,9 +296,9 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Creates a new identity for an XMPP entity. - * 'category' and 'type' are required by + * 'category' and 'type' are required by * XEP-30 XML Schemas - * + * * @param category the entity's category (required as per XEP-30). * @param name the entity's name. * @param type the entity's type (required as per XEP-30). @@ -309,9 +309,9 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Creates a new identity for an XMPP entity. - * 'category' and 'type' are required by + * 'category' and 'type' are required by * XEP-30 XML Schemas - * + * * @param category the entity's category (required as per XEP-30). * @param type the entity's type (required as per XEP-30). * @param name the entity's name. @@ -326,8 +326,8 @@ public class DiscoverInfo extends IQ implements TypedCloneable { } /** - * Returns the entity's category. To get the official registry of values for the - * 'category' attribute refer to Jabber::Registrar + * Returns the entity's category. To get the official registry of values for the + * 'category' attribute refer to Jabber::Registrar * * @return the entity's category. */ @@ -345,8 +345,8 @@ public class DiscoverInfo extends IQ implements TypedCloneable { } /** - * Returns the entity's type. To get the official registry of values for the - * 'type' attribute refer to Jabber::Registrar + * Returns the entity's type. To get the official registry of values for the + * 'type' attribute refer to Jabber::Registrar * * @return the entity's type. */ @@ -356,7 +356,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Returns the identities natural language if one is set. - * + * * @return the value of xml:lang of this Identity */ public String getLanguage() { @@ -389,11 +389,11 @@ public class DiscoverInfo extends IQ implements TypedCloneable { return xml; } - /** + /** * Check equality for Identity for category, type, lang and name * in that order as defined by * XEP-0015 5.4 Processing Method (Step 3.3). - * + * */ @Override public boolean equals(Object obj) { @@ -434,7 +434,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { * Compares this identity with another one. The comparison order is: Category, Type, Lang. * If all three are identical the other Identity is considered equal. Name is not used for * comparison, as defined by XEP-0115 - * + * * @param other * @return a negative integer, zero, or a positive integer as this object is less than, * equal to, or greater than the specified object. @@ -473,8 +473,8 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Represents the features offered by the item. This information helps the requester to determine - * what actions are possible with regard to this item (registration, search, join, etc.) - * as well as specific feature types of interest, if any (e.g., for the purpose of feature + * what actions are possible with regard to this item (registration, search, join, etc.) + * as well as specific feature types of interest, if any (e.g., for the purpose of feature * negotiation). */ public static class Feature implements TypedCloneable { @@ -491,7 +491,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable { /** * Creates a new feature offered by an XMPP entity or item. - * + * * @param variable the feature's variable. */ public Feature(String variable) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverItems.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverItems.java index 78fc3f2ac..9936184a6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverItems.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverItems.java @@ -27,10 +27,10 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jxmpp.jid.Jid; /** - * A DiscoverItems IQ packet, which is used by XMPP clients to request and receive items + * A DiscoverItems IQ packet, which is used by XMPP clients to request and receive items * associated with XMPP entities.

    - * - * The items could also be queried in order to discover if they contain items inside. Some items + * + * The items could also be queried in order to discover if they contain items inside. Some items * may be addressable by its JID and others may require to be addressed by a JID and a node name. * * @author Gaston Dombiak @@ -49,7 +49,7 @@ public class DiscoverItems extends IQ { /** * Adds a new item to the discovered information. - * + * * @param item the discovered entity's item */ public void addItem(Item item) { @@ -70,7 +70,7 @@ public class DiscoverItems extends IQ { /** - * Returns the discovered items of the queried XMPP entity. + * Returns the discovered items of the queried XMPP entity. * * @return an unmodifiable list of the discovered entity's items */ @@ -79,10 +79,10 @@ public class DiscoverItems extends IQ { } /** - * Returns the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Returns the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. * * @return the node attribute that supplements the 'jid' attribute @@ -92,12 +92,12 @@ public class DiscoverItems extends IQ { } /** - * Sets the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Sets the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. - * + * * @param node the node attribute that supplements the 'jid' attribute */ public void setNode(String node) { @@ -117,11 +117,11 @@ public class DiscoverItems extends IQ { } /** - * An item is associated with an XMPP Entity, usually thought of a children of the parent - * entity and normally are addressable as a JID.

    - * - * An item associated with an entity may not be addressable as a JID. In order to handle - * such items, Service Discovery uses an optional 'node' attribute that supplements the + * An item is associated with an XMPP Entity, usually thought of a children of the parent + * entity and normally are addressable as a JID.

    + * + * An item associated with an entity may not be addressable as a JID. In order to handle + * such items, Service Discovery uses an optional 'node' attribute that supplements the * 'jid' attribute. */ public static class Item { @@ -143,7 +143,7 @@ public class DiscoverItems extends IQ { /** * Create a new Item associated with a given entity. - * + * * @param entityID the id of the entity that contains the item */ public Item(Jid entityID) { @@ -178,10 +178,10 @@ public class DiscoverItems extends IQ { } /** - * Returns the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Returns the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. * * @return the node attribute that supplements the 'jid' attribute @@ -191,12 +191,12 @@ public class DiscoverItems extends IQ { } /** - * Sets the node attribute that supplements the 'jid' attribute. A node is merely - * something that is associated with a JID and for which the JID can provide information.

    - * - * Node attributes SHOULD be used only when trying to provide or query information which + * Sets the node attribute that supplements the 'jid' attribute. A node is merely + * something that is associated with a JID and for which the JID can provide information.

    + * + * Node attributes SHOULD be used only when trying to provide or query information which * is not directly addressable. - * + * * @param node the node attribute that supplements the 'jid' attribute */ public void setNode(String node) { @@ -204,11 +204,11 @@ public class DiscoverItems extends IQ { } /** - * Returns the action that specifies the action being taken for this item. Possible action - * values are: "update" and "remove". Update should either create a new entry if the node - * and jid combination does not already exist, or simply update an existing entry. If + * Returns the action that specifies the action being taken for this item. Possible action + * values are: "update" and "remove". Update should either create a new entry if the node + * and jid combination does not already exist, or simply update an existing entry. If * "remove" is used as the action, the item should be removed from persistent storage. - * + * * @return the action being taken for this item */ public String getAction() { @@ -216,11 +216,11 @@ public class DiscoverItems extends IQ { } /** - * Sets the action that specifies the action being taken for this item. Possible action - * values are: "update" and "remove". Update should either create a new entry if the node - * and jid combination does not already exist, or simply update an existing entry. If + * Sets the action that specifies the action being taken for this item. Possible action + * values are: "update" and "remove". Update should either create a new entry if the node + * and jid combination does not already exist, or simply update an existing entry. If * "remove" is used as the action, the item should be removed from persistent storage. - * + * * @param action the action being taken for this item */ public void setAction(String action) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferException.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferException.java index 71a1b9428..4efcc86a8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferException.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferException.java @@ -21,14 +21,14 @@ import org.jivesoftware.smack.SmackException; public abstract class FileTransferException extends SmackException { /** - * + * */ private static final long serialVersionUID = 1L; public static class NoStreamMethodsOfferedException extends FileTransferException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -37,7 +37,7 @@ public abstract class FileTransferException extends SmackException { public static class NoAcceptableTransferMechanisms extends FileTransferException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java index 92633be0e..d54b19ae9 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java @@ -19,13 +19,13 @@ package org.jivesoftware.smackx.filetransfer; /** * File transfers can cause several events to be raised. These events can be * monitored through this interface. - * + * * @author Alexander Wenckus */ public interface FileTransferListener { /** * A request to send a file has been received from another user. - * + * * @param request * The request from the other user. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java index ced4802d9..dc44d4b11 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java @@ -41,9 +41,9 @@ import org.jxmpp.jid.EntityFullJid; * listener will notify you when there is a new file transfer request. To create * the {@link IncomingFileTransfer} object accept the transfer, or, if the * transfer is not desirable reject it. - * + * * @author Alexander Wenckus - * + * */ public final class FileTransferManager extends Manager { @@ -64,7 +64,7 @@ public final class FileTransferManager extends Manager { /** * Creates a file transfer manager to initiate and receive file transfers. - * + * * @param connection * The XMPPConnection that the file transfers will use. */ @@ -89,7 +89,7 @@ public final class FileTransferManager extends Manager { /** * Add a file transfer listener to listen to incoming file transfer * requests. - * + * * @param li * The listener * @see #removeFileTransferListener(FileTransferListener) @@ -101,7 +101,7 @@ public final class FileTransferManager extends Manager { /** * Removes a file transfer listener. - * + * * @param li * The file transfer listener to be removed * @see FileTransferListener @@ -112,7 +112,7 @@ public final class FileTransferManager extends Manager { /** * Creates an OutgoingFileTransfer to send a file to another user. - * + * * @param userID * The fully qualified jabber ID (i.e. full JID) with resource of the user to * send the file to. @@ -136,7 +136,7 @@ public final class FileTransferManager extends Manager { * When the file transfer request is acceptable, this method should be * invoked. It will create an IncomingFileTransfer which allows the * transmission of the file to proceed. - * + * * @param request * The remote request that is being accepted. * @return The IncomingFileTransfer which manages the download of the file @@ -162,7 +162,7 @@ public final class FileTransferManager extends Manager { *

    * @param request * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ protected void rejectIncomingFileTransfer(FileTransferRequest request) throws NotConnectedException, InterruptedException { StreamInitiation initiation = request.getStreamInitiation(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java index 59b1fdf15..301638645 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java @@ -182,9 +182,9 @@ public final class FileTransferNegotiator extends Manager { * @return The file transfer object that handles the transfer * @throws NoStreamMethodsOfferedException If there are either no stream methods contained in the packet, or * there is not an appropriate stream method. - * @throws NotConnectedException - * @throws NoAcceptableTransferMechanisms - * @throws InterruptedException + * @throws NotConnectedException + * @throws NoAcceptableTransferMechanisms + * @throws InterruptedException */ public StreamNegotiator selectStreamNegotiator( FileTransferRequest request) throws NotConnectedException, NoStreamMethodsOfferedException, NoAcceptableTransferMechanisms, InterruptedException { @@ -239,7 +239,7 @@ public final class FileTransferNegotiator extends Manager { throw new FileTransferException.NoAcceptableTransferMechanisms(); } - if (isByteStream && isIBB) { + if (isByteStream && isIBB) { return new FaultTolerantNegotiator(connection(), byteStreamTransferManager, inbandTransferManager); @@ -296,10 +296,10 @@ public final class FileTransferNegotiator extends Manager { * user to respond. If they do not respond in time, this * @return Returns the stream negotiator selected by the peer. * @throws XMPPErrorException Thrown if there is an error negotiating the file transfer. - * @throws NotConnectedException - * @throws NoResponseException - * @throws NoAcceptableTransferMechanisms - * @throws InterruptedException + * @throws NotConnectedException + * @throws NoResponseException + * @throws NoAcceptableTransferMechanisms + * @throws InterruptedException */ public StreamNegotiator negotiateOutgoingTransfer(final Jid userID, final String streamID, final String fileName, final long size, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java index 5970aa275..d6d732c3a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java @@ -24,9 +24,9 @@ import org.jxmpp.jid.Jid; /** * A request to send a file received from another user. - * + * * @author Alexander Wenckus - * + * */ public class FileTransferRequest { private final StreamInitiation streamInitiation; @@ -36,10 +36,10 @@ public class FileTransferRequest { /** * A receive request is constructed from the Stream Initiation request * received from the initiator. - * + * * @param manager * The manager handling this file transfer - * + * * @param si * The Stream initiation received from the initiator. */ @@ -50,7 +50,7 @@ public class FileTransferRequest { /** * Returns the name of the file. - * + * * @return Returns the name of the file. */ public String getFileName() { @@ -59,7 +59,7 @@ public class FileTransferRequest { /** * Returns the size in bytes of the file. - * + * * @return Returns the size in bytes of the file. */ public long getFileSize() { @@ -68,7 +68,7 @@ public class FileTransferRequest { /** * Returns the description of the file provided by the requester. - * + * * @return Returns the description of the file provided by the requester. */ public String getDescription() { @@ -77,7 +77,7 @@ public class FileTransferRequest { /** * Returns the mime-type of the file. - * + * * @return Returns the mime-type of the file. */ public String getMimeType() { @@ -87,7 +87,7 @@ public class FileTransferRequest { /** * Returns the fully-qualified jabber ID of the user that requested this * file transfer. - * + * * @return Returns the fully-qualified jabber ID of the user that requested * this file transfer. */ @@ -97,7 +97,7 @@ public class FileTransferRequest { /** * Returns the stream ID that uniquely identifies this file transfer. - * + * * @return Returns the stream ID that uniquely identifies this file * transfer. */ @@ -109,7 +109,7 @@ public class FileTransferRequest { * Returns the stream initiation stanza that was sent by the requester which * contains the parameters of the file transfer being transfer and also the * methods available to transfer the file. - * + * * @return Returns the stream initiation stanza that was sent by the * requester which contains the parameters of the file transfer * being transfer and also the methods available to transfer the @@ -121,7 +121,7 @@ public class FileTransferRequest { /** * Accepts this file transfer and creates the incoming file transfer. - * + * * @return Returns the IncomingFileTransfer on which the * file transfer can be carried out. */ @@ -131,8 +131,8 @@ public class FileTransferRequest { /** * Rejects the file transfer request. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void reject() throws NotConnectedException, InterruptedException { manager.rejectIncomingFileTransfer(this); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IBBTransferNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IBBTransferNegotiator.java index dfc15e8c3..ed7c328c5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IBBTransferNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IBBTransferNegotiator.java @@ -38,7 +38,7 @@ import org.jxmpp.jid.Jid; * The In-Band Bytestream file transfer method, or IBB for short, transfers the * file over the same XML Stream used by XMPP. It is the fall-back mechanism in * case the SOCKS5 bytestream method of transferring files is not available. - * + * * @author Alexander Wenckus * @author Henning Staib * @see XEP-0047: In-Band @@ -50,7 +50,7 @@ public class IBBTransferNegotiator extends StreamNegotiator { /** * The default constructor for the In-Band Bytestream Negotiator. - * + * * @param connection The connection which this negotiator works on. */ protected IBBTransferNegotiator(XMPPConnection connection) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java index 1b8998b6f..a5a5e0dd5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java @@ -74,10 +74,10 @@ public class IncomingFileTransfer extends FileTransfer { * the negotiated stream. * * @return The negotiated InputStream from which to read the data. - * @throws SmackException + * @throws SmackException * @throws XMPPErrorException If there is an error in the negotiation process an exception * is thrown. - * @throws InterruptedException + * @throws InterruptedException */ public InputStream receiveFile() throws SmackException, XMPPErrorException, InterruptedException { if (inputStream != null) { @@ -107,10 +107,10 @@ public class IncomingFileTransfer extends FileTransfer { *
  • {@link FileTransfer#getProgress()}
    • *
  • {@link FileTransfer#isDone()}
    • * - * + * * @param file The location to save the file. * @throws SmackException when the file transfer fails - * @throws IOException + * @throws IOException * @throws IllegalArgumentException This exception is thrown when the the provided file is * either null, or cannot be written to. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java index d4562a42e..72197ee5b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java @@ -122,7 +122,7 @@ public class OutgoingFileTransfer extends FileTransfer { * Thrown if an error occurs during the file transfer * negotiation process. * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ public synchronized OutputStream sendFile(String fileName, long fileSize, String description) throws XMPPException, SmackException, InterruptedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/Socks5TransferNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/Socks5TransferNegotiator.java index 908abe6a9..a123ca382 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/Socks5TransferNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/Socks5TransferNegotiator.java @@ -37,7 +37,7 @@ import org.jxmpp.jid.Jid; /** * Negotiates a SOCKS5 Bytestream to be used for file transfers. The implementation is based on the * {@link Socks5BytestreamManager} and the {@link Socks5BytestreamRequest}. - * + * * @author Henning Staib * @see     XEP-0065: SOCKS5 Bytestreams */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java index a71254dae..5537f6f0d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java @@ -152,7 +152,7 @@ public abstract class StreamNegotiator extends Manager { * @throws XMPPErrorException If an error occurs during this process an XMPPException is * thrown. * @throws InterruptedException If thread is interrupted. - * @throws SmackException + * @throws SmackException */ public abstract InputStream createIncomingStream(StreamInitiation initiation) throws XMPPErrorException, InterruptedException, SmackException; @@ -168,9 +168,9 @@ public abstract class StreamNegotiator extends Manager { * @param target The fully-qualified JID of the target or receiver of the file * transfer. * @return The negotiated stream ready for data. - * @throws SmackException - * @throws XMPPException - * @throws InterruptedException + * @throws SmackException + * @throws XMPPException + * @throws InterruptedException */ public abstract OutputStream createOutgoingStream(String streamID, Jid initiator, Jid target) throws SmackException, XMPPException, InterruptedException; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java index c4a579791..5aec4388e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java @@ -24,7 +24,7 @@ import org.jivesoftware.smackx.delay.packet.DelayInformation; /** * Stanza extension for XEP-0297: Stanza Forwarding. - * + * * @author Georg Lukas * @see XEP-0297: Stanza Forwarding */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/GeoLocationManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/GeoLocationManager.java index 3fa1e01f3..e6b75b46b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/GeoLocationManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/GeoLocationManager.java @@ -57,7 +57,7 @@ public final class GeoLocationManager extends Manager { /** * Retrieves a {@link GeoLocationManager} for the specified {@link XMPPConnection}, creating one if it doesn't * already exist. - * + * * @param connection The connection the manager is attached to. * @return The new or existing manager. */ @@ -84,7 +84,7 @@ public final class GeoLocationManager extends Manager { /** * Returns true if the message contains a GeoLocation extension. - * + * * @param message the message to check if contains a GeoLocation extension or not * @return a boolean indicating whether the message is a GeoLocation message */ @@ -94,13 +94,13 @@ public final class GeoLocationManager extends Manager { /** * Send geolocation through the PubSub node. - * + * * @param geoLocation * @throws InterruptedException * @throws NotConnectedException * @throws XMPPErrorException * @throws NoResponseException - * @throws NotALeafNodeException + * @throws NotALeafNodeException */ public void sendGeolocation(GeoLocation geoLocation) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotALeafNodeException { @@ -109,12 +109,12 @@ public final class GeoLocationManager extends Manager { /** * Send empty geolocation through the PubSub node. - * + * * @throws InterruptedException * @throws NotConnectedException * @throws XMPPErrorException * @throws NoResponseException - * @throws NotALeafNodeException + * @throws NotALeafNodeException */ public void stopPublishingGeolocation() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotALeafNodeException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/packet/GeoLocation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/packet/GeoLocation.java index 53e86bc82..083e59fa8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/packet/GeoLocation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/packet/GeoLocation.java @@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * A GeoLocation Extension packet, which is used by the XMPP clients to exchange their respective geographic locations. - * + * * @see XEP-0080 * @author Ishan Khanna */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java index 4d3954b9c..56dd9d645 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java @@ -48,7 +48,7 @@ import org.jxmpp.jid.Jid; * associated with a Jabber ID. A manager handles incoming LastActivity requests * of existing Connections. It also allows to request last activity information * of other users. - * + * * LastActivity (XEP-0012) based on the sending JID's type allows for retrieval * of: *
      @@ -57,31 +57,31 @@ import org.jxmpp.jid.Jid; * specified when doing so. *
    1. How long a host has been up. *
    - * + * * For example to get the idle time of a user logged in a resource, simple send * the LastActivity stanza to them, as in the following code: - * + * * 
      * XMPPConnection con = new XMPPTCPConnection("jabber.org");
  * con.login("john", "doe");
  * LastActivity activity = LastActivity.getLastActivity(con, "xray@jabber.org/Smack");
  *
    - * + * * To get the lapsed time since the last user logout is the same as above but * with out the resource: - * + * * 
      * LastActivity activity = LastActivity.getLastActivity(con, "xray@jabber.org");
  *
    - * + * * To get the uptime of a host, you simple send the LastActivity stanza to it, * as in the following code example: *

    - * + * * 

      * LastActivity activity = LastActivity.getLastActivity(con, "jabber.org");
  *
    - * + * * @author Gabriel Guardincerri * @author Florian Schmaus * @see XEP-0012: Last @@ -126,7 +126,7 @@ public final class LastActivityManager extends Manager { /** * Creates a last activity manager to response last activity requests. - * + * * @param connection * The XMPPConnection that the last activity requests will use. */ @@ -208,7 +208,7 @@ public final class LastActivityManager extends Manager { /** * The idle time is the lapsed time between the last message sent and now. - * + * * @return the lapsed time between the last message sent and now. */ private long getIdleTime() { @@ -225,15 +225,15 @@ public final class LastActivityManager extends Manager { * time since the last logout or 0 if the user is currently logged in. * Moreover, when the jid is a server or component (e.g., a JID of the form * 'host') the last activity is the uptime. - * + * * @param jid * the JID of the user. * @return the LastActivity stanza of the jid. * @throws XMPPErrorException * thrown if a server error has occured. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public LastActivity getLastActivity(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -243,13 +243,13 @@ public final class LastActivityManager extends Manager { /** * Returns true if Last Activity (XEP-0012) is supported by a given JID. - * + * * @param jid a JID to be tested for Last Activity support * @return true if Last Activity is supported, otherwise false - * @throws NotConnectedException - * @throws XMPPErrorException - * @throws NoResponseException - * @throws InterruptedException + * @throws NotConnectedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws InterruptedException */ public boolean isLastActivitySupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, LastActivity.NAMESPACE); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java index c47db4291..73c88566d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java @@ -153,10 +153,10 @@ public final class PrivateDataManager extends Manager { * @param elementName the element name. * @param namespace the namespace. * @return the private data. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public PrivateData getPrivateData(final String elementName, final String namespace) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Create an IQ packet to get the private data. @@ -173,10 +173,10 @@ public final class PrivateDataManager extends Manager { * element name and namespace, then the new private data will overwrite the old value. * * @param privateData the private data. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void setPrivateData(final PrivateData privateData) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Create an IQ packet to set the private data. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java index 923317715..defd0cef6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java @@ -131,10 +131,10 @@ public final class AccountManager extends Manager { * behavior is to only create new accounts before having logged in to a server. * * @return true if the server support creating new accounts. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean supportsAccountCreation() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // TODO: Replace this body with isSupported() and possible deprecate this method. @@ -176,10 +176,10 @@ public final class AccountManager extends Manager { * the user's email address. * * @return the required account attributes. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Set getAccountAttributes() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { if (info == null) { @@ -200,10 +200,10 @@ public final class AccountManager extends Manager { * @param name the name of the account attribute to return its value. * @return the value of the account attribute or null if an account * attribute wasn't found for the requested name. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public String getAccountAttribute(String name) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { if (info == null) { @@ -218,10 +218,10 @@ public final class AccountManager extends Manager { * that will complete the registration process. * * @return the account creation instructions, or null if there are none. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public String getAccountInstructions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { if (info == null) { @@ -240,10 +240,10 @@ public final class AccountManager extends Manager { * * @param username the username. * @param password the password. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void createAccount(Localpart username, String password) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Create a map for all the required attributes, but give them blank values. @@ -264,8 +264,8 @@ public final class AccountManager extends Manager { * @param attributes the account attributes. * @throws XMPPErrorException if an error occurs creating the account. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @see #getAccountAttributes() */ public void createAccount(Localpart username, String password, Map attributes) @@ -298,8 +298,8 @@ public final class AccountManager extends Manager { * @throws IllegalStateException if not currently logged-in to the server. * @throws XMPPErrorException if an error occurs when changing the password. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void changePassword(String newPassword) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { if (!connection().isSecureConnection() && !allowSensitiveOperationOverInsecureConnection) { @@ -322,8 +322,8 @@ public final class AccountManager extends Manager { * @throws IllegalStateException if not currently logged-in to the server. * @throws XMPPErrorException if an error occurs when deleting the account. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteAccount() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Map attributes = new HashMap<>(); @@ -356,10 +356,10 @@ public final class AccountManager extends Manager { /** * Gets the account registration info from the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * * @throws XMPPException if an error occurs. * @throws SmackException if there was no response from the server. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/VersionManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/VersionManager.java index 8ce82ba11..4dce8988e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/VersionManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/VersionManager.java @@ -134,13 +134,13 @@ public final class VersionManager extends Manager { /** * Request version information from a given JID. - * + * * @param jid * @return the version information or {@code null} if not supported by JID * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public Version getVersion(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java index 289064cff..7332d9857 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java @@ -46,7 +46,7 @@ public class Version extends IQ { /** * Request version IQ. - * + * * @param to the jid where to request version from */ public Version(Jid to) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/Jingle.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/Jingle.java index 0dd8e4c40..8920cd9ac 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/Jingle.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/Jingle.java @@ -29,7 +29,7 @@ import org.jxmpp.jid.FullJid; /** * The Jingle element. - * + * * @author Florian Schmaus */ public final class Jingle extends IQ { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleAction.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleAction.java index 7b1beb719..9e91988fe 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleAction.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleAction.java @@ -21,8 +21,8 @@ import java.util.Map; /** * The "action" in the jingle packet, as an enum. - * - * + * + * * @author Florian Schmaus */ public enum JingleAction { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleContent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleContent.java index a424884bf..ce723d4b6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleContent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleContent.java @@ -99,7 +99,7 @@ public final class JingleContent implements NamedElement { /** * Gets the description for this Jingle content. - * + * * @return The description. */ public JingleContentDescription getDescription() { @@ -108,7 +108,7 @@ public final class JingleContent implements NamedElement { /** * Returns an Iterator for the JingleTransports in the packet. - * + * * @return an Iterator for the JingleTransports in the packet. * @deprecated use {@link #getTransport()} instead. */ @@ -119,7 +119,7 @@ public final class JingleContent implements NamedElement { /** * Returns an Iterator for the JingleTransports in the packet. - * + * * @return an Iterator for the JingleTransports in the packet. */ public JingleContentTransport getTransport() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java index f57beec10..424e71762 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java @@ -50,7 +50,7 @@ public class JivePropertiesManager { /** * Convenience method to add a property to a packet. - * + * * @param packet the stanza to add the property to. * @param name the name of the property to add. * @param value the value of the property to add. @@ -67,7 +67,7 @@ public class JivePropertiesManager { /** * Convenience method to get a property from a packet. Will return null if the stanza contains * not property with the given name. - * + * * @param packet * @param name * @return the property or null if none found. @@ -84,7 +84,7 @@ public class JivePropertiesManager { /** * Return a collection of the names of all properties of the given packet. If the packet * contains no properties extension, then an empty collection will be returned. - * + * * @param packet * @return a collection of the names of all properties. */ @@ -99,7 +99,7 @@ public class JivePropertiesManager { /** * Return a map of all properties of the given packet. If the stanza contains no properties * extension, an empty map will be returned. - * + * * @param packet * @return a map of all properties of the given packet. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java index 30b8ebf86..b5719be65 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java @@ -45,11 +45,11 @@ public class JivePropertiesExtensionProvider extends ExtensionElementProvider * Note that you have to explicitly enabled Java object deserialization with @{link * {@link JivePropertiesManager#setJavaObjectEnabled(boolean)} - * + * * @param parser the XML parser, positioned at the start of a properties sub-packet. * @return a map of the properties. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ @Override public JivePropertiesExtension parse(XmlPullParser parser, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/element/MessageCorrectExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/element/MessageCorrectExtension.java index 7336cc6ed..e15a3d8a2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/element/MessageCorrectExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/element/MessageCorrectExtension.java @@ -23,10 +23,10 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * An Extension that implements XEP-0308: Last Message Correction - * + * * This extension is expected to be added to message stanzas. Please refer to * the XEP for more implementation guidelines. - * + * * @author Fernando Ramirez, f.e.ramirez94@gmail.com * @see XEP-0308: Last *  Message Correction diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/MessageCorrectProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/MessageCorrectProvider.java index 87d0af8ed..ec1c2fc27 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/MessageCorrectProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/MessageCorrectProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * A ExtensionElementProvider for the MessageCorrectExtension. As * MessageCorrection elements have only the ID of the message to replace. - * + * * @author Fernando Ramirez, f.e.ramirez94@gmail.com */ public class MessageCorrectProvider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultParticipantStatusListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultParticipantStatusListener.java index baf836557..8d9f49746 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultParticipantStatusListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultParticipantStatusListener.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.parts.Resourcepart; * This class does not provide any behavior by default. It just avoids having * to implement all the inteface methods if the user is only interested in implementing * some of the methods. - * + * * @author Gaston Dombiak */ public class DefaultParticipantStatusListener implements ParticipantStatusListener { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultUserStatusListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultUserStatusListener.java index 9b0d71108..67d1984ed 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultUserStatusListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DefaultUserStatusListener.java @@ -25,7 +25,7 @@ import org.jxmpp.jid.Jid; * This class does not provide any behavior by default. It just avoids having * to implement all the inteface methods if the user is only interested in implementing * some of the methods. - * + * * @author Gaston Dombiak */ public class DefaultUserStatusListener implements UserStatusListener { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DiscussionHistory.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DiscussionHistory.java index 37556d47a..71f3c357c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DiscussionHistory.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/DiscussionHistory.java @@ -23,21 +23,21 @@ import org.jivesoftware.smackx.muc.packet.MUCInitialPresence; /** * The DiscussionHistory class controls the number of characters or messages to receive - * when entering a room. The room will decide the amount of history to return if you don't + * when entering a room. The room will decide the amount of history to return if you don't * specify a DiscussionHistory while joining a room.

    - * - * You can use some or all of these variable to control the amount of history to receive: + * + * You can use some or all of these variable to control the amount of history to receive: *

      *
    • maxchars -> total number of characters to receive in the history. *
    • maxstanzas -> total number of messages to receive in the history. - *
    • seconds -> only the messages received in the last "X" seconds will be included in the + *
    • seconds -> only the messages received in the last "X" seconds will be included in the * history. - *
    • since -> only the messages received since the datetime specified will be included in + *
    • since -> only the messages received since the datetime specified will be included in * the history. *
    - * + * * Note: Setting maxchars to 0 indicates that the user requests to receive no history. - * + * * @author Gaston Dombiak * @deprecated use {@link org.jivesoftware.smackx.muc.MucEnterConfiguration} instead. */ @@ -51,7 +51,7 @@ public class DiscussionHistory { /** * Returns the total number of characters to receive in the history. - * + * * @return total number of characters to receive in the history. */ public int getMaxChars() { @@ -60,7 +60,7 @@ public class DiscussionHistory { /** * Returns the total number of messages to receive in the history. - * + * * @return the total number of messages to receive in the history. */ public int getMaxStanzas() { @@ -68,10 +68,10 @@ public class DiscussionHistory { } /** - * Returns the number of seconds to use to filter the messages received during that time. - * In other words, only the messages received in the last "X" seconds will be included in + * Returns the number of seconds to use to filter the messages received during that time. + * In other words, only the messages received in the last "X" seconds will be included in * the history. - * + * * @return the number of seconds to use to filter the messages received during that time. */ public int getSeconds() { @@ -79,10 +79,10 @@ public class DiscussionHistory { } /** - * Returns the since date to use to filter the messages received during that time. - * In other words, only the messages received since the datetime specified will be + * Returns the since date to use to filter the messages received during that time. + * In other words, only the messages received since the datetime specified will be * included in the history. - * + * * @return the since date to use to filter the messages received during that time. */ public Date getSince() { @@ -91,7 +91,7 @@ public class DiscussionHistory { /** * Sets the total number of characters to receive in the history. - * + * * @param maxChars the total number of characters to receive in the history. */ public void setMaxChars(int maxChars) { @@ -100,7 +100,7 @@ public class DiscussionHistory { /** * Sets the total number of messages to receive in the history. - * + * * @param maxStanzas the total number of messages to receive in the history. */ public void setMaxStanzas(int maxStanzas) { @@ -108,11 +108,11 @@ public class DiscussionHistory { } /** - * Sets the number of seconds to use to filter the messages received during that time. - * In other words, only the messages received in the last "X" seconds will be included in + * Sets the number of seconds to use to filter the messages received during that time. + * In other words, only the messages received in the last "X" seconds will be included in * the history. - * - * @param seconds the number of seconds to use to filter the messages received during + * + * @param seconds the number of seconds to use to filter the messages received during * that time. */ public void setSeconds(int seconds) { @@ -120,10 +120,10 @@ public class DiscussionHistory { } /** - * Sets the since date to use to filter the messages received during that time. - * In other words, only the messages received since the datetime specified will be + * Sets the since date to use to filter the messages received during that time. + * In other words, only the messages received since the datetime specified will be * included in the history. - * + * * @param since the since date to use to filter the messages received during that time. */ public void setSince(Date since) { @@ -132,7 +132,7 @@ public class DiscussionHistory { /** * Returns true if the history has been configured with some values. - * + * * @return true if the history has been configured with some values. */ private boolean isConfigured() { @@ -140,14 +140,14 @@ public class DiscussionHistory { } /** - * Returns the History that manages the amount of discussion history provided on entering a + * Returns the History that manages the amount of discussion history provided on entering a * room. - * - * @return the History that manages the amount of discussion history provided on entering a + * + * @return the History that manages the amount of discussion history provided on entering a * room. */ MUCInitialPresence.History getMUCHistory() { - // Return null if the history was not properly configured + // Return null if the history was not properly configured if (!isConfigured()) { return null; } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationListener.java index 2855d8e5a..74699fa4e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationListener.java @@ -26,17 +26,17 @@ import org.jxmpp.jid.EntityJid; /** * A listener that is fired anytime an invitation to join a MUC room is received. - * + * * @author Gaston Dombiak */ public interface InvitationListener { /** * Called when the an invitation to join a MUC room is received.

    - * + * * If the room is password-protected, the invitee will receive a password to use to join * the room. If the room is members-only, the the invitee may be added to the member list. - * + * * @param conn the XMPPConnection that received the invitation. * @param room the room that invitation refers to. * @param inviter the inviter that sent the invitation. (e.g. crone1@shakespeare.lit). diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationRejectionListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationRejectionListener.java index b31d0830d..a9844d87b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationRejectionListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/InvitationRejectionListener.java @@ -25,14 +25,14 @@ import org.jxmpp.jid.EntityBareJid; /** * A listener that is fired anytime an invitee declines or rejects an invitation. - * + * * @author Gaston Dombiak */ public interface InvitationRejectionListener { /** * Called when the invitee declines the invitation. - * + * * @param invitee the invitee that declined the invitation. (e.g. hecate@shakespeare.lit). * @param reason the reason why the invitee declined the invitation. * @param message the message used to decline the invitation. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucConfigFormManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucConfigFormManager.java index b97b49e1e..30ecf0860 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucConfigFormManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucConfigFormManager.java @@ -83,10 +83,10 @@ public class MucConfigFormManager { *

    * * @param multiUserChat the MUC for this configuration form. - * @throws InterruptedException - * @throws NotConnectedException - * @throws XMPPErrorException - * @throws NoResponseException + * @throws InterruptedException + * @throws NotConnectedException + * @throws XMPPErrorException + * @throws NoResponseException */ MucConfigFormManager(MultiUserChat multiUserChat) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucEnterConfiguration.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucEnterConfiguration.java index a430bd1e0..7a8d9ec54 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucEnterConfiguration.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucEnterConfiguration.java @@ -33,7 +33,7 @@ import org.jxmpp.jid.parts.Resourcepart; *

    * A builder for this can be obtained by calling {@link MultiUserChat#getEnterConfigurationBuilder(Resourcepart)}. *

    - * + * * @author Florian Schmaus * @since 4.2 */ @@ -140,7 +140,7 @@ public final class MucEnterConfiguration { /** * Request that that MUC is going to sent us no history when joining. - * + * * @return a reference to this builder. */ public Builder requestNoHistory() { @@ -153,7 +153,7 @@ public final class MucEnterConfiguration { /** * Sets the total number of characters to receive in the history. - * + * * @param maxChars the total number of characters to receive in the history. * @return a reference to this builder. */ @@ -164,7 +164,7 @@ public final class MucEnterConfiguration { /** * Sets the total number of messages to receive in the history. - * + * * @param maxStanzas the total number of messages to receive in the history. * @return a reference to this builder. */ @@ -174,11 +174,11 @@ public final class MucEnterConfiguration { } /** - * Sets the number of seconds to use to filter the messages received during that time. - * In other words, only the messages received in the last "X" seconds will be included in + * Sets the number of seconds to use to filter the messages received during that time. + * In other words, only the messages received in the last "X" seconds will be included in * the history. - * - * @param seconds the number of seconds to use to filter the messages received during + * + * @param seconds the number of seconds to use to filter the messages received during * that time. * @return a reference to this builder. */ @@ -188,10 +188,10 @@ public final class MucEnterConfiguration { } /** - * Sets the since date to use to filter the messages received during that time. - * In other words, only the messages received since the datetime specified will be + * Sets the since date to use to filter the messages received during that time. + * In other words, only the messages received since the datetime specified will be * included in the history. - * + * * @param since the since date to use to filter the messages received during that time. * @return a reference to this builder. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java index afbf4aa6e..c22995cd6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java @@ -322,7 +322,7 @@ public class MultiUserChat { * @throws NoResponseException * @throws XMPPErrorException * @throws InterruptedException - * @throws NotAMucServiceException + * @throws NotAMucServiceException * @see XEP-45 7.2 Entering a Room */ private Presence enter(MucEnterConfiguration conf) throws NotConnectedException, NoResponseException, @@ -393,7 +393,7 @@ public class MultiUserChat { /** * Get a new MUC enter configuration builder. - * + * * @param nickname the nickname used when entering the MUC room. * @return a new MUC enter configuration builder. * @since 4.2 @@ -418,17 +418,17 @@ public class MultiUserChat { * the room. Once the completed configuration form is sent to the server, the server will unlock * the room. You can use the returned {@link MucCreateConfigFormHandle} to configure the room. *

    - * + * * @param nickname the nickname to use. * @return a handle to the MUC create configuration form API. * @throws XMPPErrorException if the room couldn't be created for some reason (e.g. 405 error if * the user is not allowed to create the room) * @throws NoResponseException if there was no response from the server. - * @throws InterruptedException - * @throws NotConnectedException - * @throws MucAlreadyJoinedException - * @throws MissingMucCreationAcknowledgeException - * @throws NotAMucServiceException + * @throws InterruptedException + * @throws NotConnectedException + * @throws MucAlreadyJoinedException + * @throws MissingMucCreationAcknowledgeException + * @throws NotAMucServiceException */ public synchronized MucCreateConfigFormHandle create(Resourcepart nickname) throws NoResponseException, XMPPErrorException, InterruptedException, MucAlreadyJoinedException, @@ -449,15 +449,15 @@ public class MultiUserChat { /** * Create or join the MUC room with the given nickname. - * + * * @param nickname the nickname to use in the MUC room. * @return A {@link MucCreateConfigFormHandle} if the room was created while joining, or {@code null} if the room was just joined. * @throws NoResponseException * @throws XMPPErrorException - * @throws InterruptedException - * @throws NotConnectedException - * @throws MucAlreadyJoinedException - * @throws NotAMucServiceException + * @throws InterruptedException + * @throws NotConnectedException + * @throws MucAlreadyJoinedException + * @throws NotAMucServiceException */ public synchronized MucCreateConfigFormHandle createOrJoin(Resourcepart nickname) throws NoResponseException, XMPPErrorException, InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException { @@ -479,10 +479,10 @@ public class MultiUserChat { * @throws XMPPErrorException if the room couldn't be created for some reason (e.g. 405 error if * the user is not allowed to create the room) * @throws NoResponseException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException * @throws MucAlreadyJoinedException if the MUC is already joined - * @throws NotConnectedException - * @throws NotAMucServiceException + * @throws NotConnectedException + * @throws NotAMucServiceException * @deprecated use {@link #createOrJoin(MucEnterConfiguration)} instead. */ @Deprecated @@ -505,10 +505,10 @@ public class MultiUserChat { * @throws XMPPErrorException if the room couldn't be created for some reason (e.g. 405 error if * the user is not allowed to create the room) * @throws NoResponseException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException * @throws MucAlreadyJoinedException if the MUC is already joined - * @throws NotConnectedException - * @throws NotAMucServiceException + * @throws NotConnectedException + * @throws NotAMucServiceException */ public synchronized MucCreateConfigFormHandle createOrJoin(MucEnterConfiguration mucEnterConfiguration) throws NoResponseException, XMPPErrorException, InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException { @@ -581,7 +581,7 @@ public class MultiUserChat { * @throws XMPPErrorException * @throws NotConnectedException * @throws InterruptedException - * @throws NotAMucServiceException + * @throws NotAMucServiceException */ public MucCreateConfigFormHandle createOrJoinIfNecessary(Resourcepart nickname, String password) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotAMucServiceException { @@ -606,7 +606,7 @@ public class MultiUserChat { * joining the room, the room will decide the amount of history to send. * * @param nickname the nickname to use. - * @throws NoResponseException + * @throws NoResponseException * @throws XMPPErrorException if an error occurs joining the room. In particular, a * 401 error can occur if no password was provided and one is required; or a * 403 error can occur if the user is banned; or a @@ -614,9 +614,9 @@ public class MultiUserChat { * 407 error can occur if user is not on the member list; or a * 409 error can occur if someone is already in the group chat with the same nickname. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException - * @throws NotAMucServiceException + * @throws NotConnectedException + * @throws InterruptedException + * @throws NotAMucServiceException */ public void join(Resourcepart nickname) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotAMucServiceException { @@ -642,10 +642,10 @@ public class MultiUserChat { * 404 error can occur if the room does not exist or is locked; or a * 407 error can occur if user is not on the member list; or a * 409 error can occur if someone is already in the group chat with the same nickname. - * @throws InterruptedException - * @throws NotConnectedException - * @throws NoResponseException if there was no response from the server. - * @throws NotAMucServiceException + * @throws InterruptedException + * @throws NotConnectedException + * @throws NoResponseException if there was no response from the server. + * @throws NotAMucServiceException */ public void join(Resourcepart nickname, String password) throws XMPPErrorException, InterruptedException, NoResponseException, NotConnectedException, NotAMucServiceException { MucEnterConfiguration.Builder builder = getEnterConfigurationBuilder(nickname).withPassword( @@ -678,9 +678,9 @@ public class MultiUserChat { * 407 error can occur if user is not on the member list; or a * 409 error can occur if someone is already in the group chat with the same nickname. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException - * @throws NotAMucServiceException + * @throws NotConnectedException + * @throws InterruptedException + * @throws NotAMucServiceException * @deprecated use {@link #join(MucEnterConfiguration)} instead. */ @Deprecated @@ -718,9 +718,9 @@ public class MultiUserChat { * 407 error can occur if user is not on the member list; or a * 409 error can occur if someone is already in the group chat with the same nickname. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException - * @throws NotAMucServiceException + * @throws NotConnectedException + * @throws InterruptedException + * @throws NotAMucServiceException */ public synchronized void join(MucEnterConfiguration mucEnterConfiguration) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException, NotAMucServiceException { @@ -744,8 +744,8 @@ public class MultiUserChat { /** * Leave the chat room. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public synchronized void leave() throws NotConnectedException, InterruptedException { // Note that this method is intentionally not guarded by @@ -791,8 +791,8 @@ public class MultiUserChat { * null if no configuration is possible. * @throws XMPPErrorException if an error occurs asking the configuration form for the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public Form getConfigurationForm() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { MUCOwner iq = new MUCOwner(); @@ -810,7 +810,7 @@ public class MultiUserChat { * @param form the form with the new settings. * @throws XMPPErrorException if an error occurs setting the new rooms' configuration. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException + * @throws NotConnectedException * @throws InterruptedException */ public void sendConfigurationForm(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -836,8 +836,8 @@ public class MultiUserChat { * @throws XMPPErrorException if an error occurs asking the registration form for the room or a * 405 error if the user is not allowed to register with the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public Form getRegistrationForm() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Registration reg = new Registration(); @@ -862,8 +862,8 @@ public class MultiUserChat { * 409 error can occur if the desired room nickname is already reserved for that room; * or a 503 error can occur if the room does not support registration. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendRegistrationForm(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Registration reg = new Registration(); @@ -886,8 +886,8 @@ public class MultiUserChat { * XMPP error code 403. The error code can be used to present more * appropiate error messages to end-users. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void destroy(String reason, EntityBareJid alternateJID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { MUCOwner iq = new MUCOwner(); @@ -925,8 +925,8 @@ public class MultiUserChat { * * @param user the user to invite to the room.(e.g. hecate@shakespeare.lit) * @param reason the reason why the user is being invited. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void invite(EntityBareJid user, String reason) throws NotConnectedException, InterruptedException { invite(new Message(), user, reason); @@ -942,8 +942,8 @@ public class MultiUserChat { * @param message the message to use for sending the invitation. * @param user the user to invite to the room.(e.g. hecate@shakespeare.lit) * @param reason the reason why the user is being invited. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void invite(Message message, EntityBareJid user, String reason) throws NotConnectedException, InterruptedException { // TODO listen for 404 error code when inviter supplies a non-existent JID @@ -1069,7 +1069,7 @@ public class MultiUserChat { * * @return the reserved room nickname or null if none. * @throws SmackException if there was no response from the server. - * @throws InterruptedException + * @throws InterruptedException */ public String getReservedNickname() throws SmackException, InterruptedException { try { @@ -1109,9 +1109,9 @@ public class MultiUserChat { * @param nickname the new nickname within the room. * @throws XMPPErrorException if the new nickname is already in use by another occupant. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException - * @throws MucNotJoinedException + * @throws NotConnectedException + * @throws InterruptedException + * @throws MucNotJoinedException */ public synchronized void changeNickname(Resourcepart nickname) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, MucNotJoinedException { StringUtils.requireNotNullOrEmpty(nickname, "Nickname must not be null or blank."); @@ -1147,9 +1147,9 @@ public class MultiUserChat { * * @param status a text message describing the presence update. * @param mode the mode type for the presence update. - * @throws NotConnectedException - * @throws InterruptedException - * @throws MucNotJoinedException + * @throws NotConnectedException + * @throws InterruptedException + * @throws MucNotJoinedException */ public void changeAvailabilityStatus(String status, Presence.Mode mode) throws NotConnectedException, InterruptedException, MucNotJoinedException { StringUtils.requireNotNullOrEmpty(nickname, "Nickname must not be null or blank."); @@ -1187,8 +1187,8 @@ public class MultiUserChat { * not have kicking privileges (i.e. Forbidden error); or a * 400 error can occur if the provided nickname is not present in the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void kickParticipant(Resourcepart nickname, String reason) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nickname, MUCRole.none, reason); @@ -1198,7 +1198,7 @@ public class MultiUserChat { * Sends a voice request to the MUC. The room moderators usually need to approve this request. * * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @see XEP-45 § 7.13 Requesting * Voice * @since 4.1 @@ -1229,8 +1229,8 @@ public class MultiUserChat { * a moderator in this room (i.e. Forbidden error); or a * 400 error can occur if the provided nickname is not present in the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantVoice(Collection nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nicknames, MUCRole.participant); @@ -1247,8 +1247,8 @@ public class MultiUserChat { * a moderator in this room (i.e. Forbidden error); or a * 400 error can occur if the provided nickname is not present in the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantVoice(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nickname, MUCRole.participant, null); @@ -1265,8 +1265,8 @@ public class MultiUserChat { * was tried to revoke his voice (i.e. Not Allowed error); or a * 400 error can occur if the provided nickname is not present in the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeVoice(Collection nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nicknames, MUCRole.visitor); @@ -1283,8 +1283,8 @@ public class MultiUserChat { * was tried to revoke his voice (i.e. Not Allowed error); or a * 400 error can occur if the provided nickname is not present in the room. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeVoice(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nickname, MUCRole.visitor, null); @@ -1302,8 +1302,8 @@ public class MultiUserChat { * 405 error can occur if a moderator or a user with an affiliation of "owner" or "admin" * was tried to be banned (i.e. Not Allowed error). * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void banUsers(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.outcast); @@ -1322,8 +1322,8 @@ public class MultiUserChat { * 405 error can occur if a moderator or a user with an affiliation of "owner" or "admin" * was tried to be banned (i.e. Not Allowed error). * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void banUser(Jid jid, String reason) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.outcast, reason); @@ -1337,8 +1337,8 @@ public class MultiUserChat { * @param jids the XMPP user IDs of the users to grant membership. * @throws XMPPErrorException if an error occurs granting membership to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantMembership(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.member); @@ -1352,8 +1352,8 @@ public class MultiUserChat { * @param jid the XMPP user ID of the user to grant membership (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs granting membership to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantMembership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.member, null); @@ -1368,8 +1368,8 @@ public class MultiUserChat { * @param jids the bare XMPP user IDs of the users to revoke membership. * @throws XMPPErrorException if an error occurs revoking membership to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeMembership(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.none); @@ -1384,8 +1384,8 @@ public class MultiUserChat { * @param jid the bare XMPP user ID of the user to revoke membership (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs revoking membership to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeMembership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.none, null); @@ -1399,8 +1399,8 @@ public class MultiUserChat { * @param nicknames the nicknames of the occupants to grant moderator privileges. * @throws XMPPErrorException if an error occurs granting moderator privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantModerator(Collection nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nicknames, MUCRole.moderator); @@ -1414,8 +1414,8 @@ public class MultiUserChat { * @param nickname the nickname of the occupant to grant moderator privileges. * @throws XMPPErrorException if an error occurs granting moderator privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantModerator(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nickname, MUCRole.moderator, null); @@ -1430,8 +1430,8 @@ public class MultiUserChat { * @param nicknames the nicknames of the occupants to revoke moderator privileges. * @throws XMPPErrorException if an error occurs revoking moderator privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeModerator(Collection nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nicknames, MUCRole.participant); @@ -1446,8 +1446,8 @@ public class MultiUserChat { * @param nickname the nickname of the occupant to revoke moderator privileges. * @throws XMPPErrorException if an error occurs revoking moderator privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeModerator(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeRole(nickname, MUCRole.participant, null); @@ -1462,8 +1462,8 @@ public class MultiUserChat { * @param jids the collection of bare XMPP user IDs of the users to grant ownership. * @throws XMPPErrorException if an error occurs granting ownership privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantOwnership(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.owner); @@ -1478,8 +1478,8 @@ public class MultiUserChat { * @param jid the bare XMPP user ID of the user to grant ownership (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs granting ownership privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantOwnership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.owner, null); @@ -1493,8 +1493,8 @@ public class MultiUserChat { * @param jids the bare XMPP user IDs of the users to revoke ownership. * @throws XMPPErrorException if an error occurs revoking ownership privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeOwnership(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.admin); @@ -1508,8 +1508,8 @@ public class MultiUserChat { * @param jid the bare XMPP user ID of the user to revoke ownership (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs revoking ownership privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeOwnership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.admin, null); @@ -1523,8 +1523,8 @@ public class MultiUserChat { * @param jids the bare XMPP user IDs of the users to grant administrator privileges. * @throws XMPPErrorException if an error occurs granting administrator privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantAdmin(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.admin); @@ -1539,8 +1539,8 @@ public class MultiUserChat { * (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs granting administrator privileges to a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void grantAdmin(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.admin); @@ -1554,8 +1554,8 @@ public class MultiUserChat { * @param jids the bare XMPP user IDs of the user to revoke administrator privileges. * @throws XMPPErrorException if an error occurs revoking administrator privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeAdmin(Collection jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jids, MUCAffiliation.admin); @@ -1570,8 +1570,8 @@ public class MultiUserChat { * (e.g. "user@host.org"). * @throws XMPPErrorException if an error occurs revoking administrator privileges from a user. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void revokeAdmin(EntityJid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException { changeAffiliationByAdmin(jid, MUCAffiliation.member); @@ -1585,7 +1585,7 @@ public class MultiUserChat { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ private void changeAffiliationByAdmin(Jid jid, MUCAffiliation affiliation) throws NoResponseException, XMPPErrorException, @@ -1599,10 +1599,10 @@ public class MultiUserChat { * @param jid * @param affiliation * @param reason the reason for the affiliation change (optional) - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ private void changeAffiliationByAdmin(Jid jid, MUCAffiliation affiliation, String reason) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { MUCAdmin iq = new MUCAdmin(); @@ -1743,8 +1743,8 @@ public class MultiUserChat { * @return a list of Affiliate with the room owners. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getOwners() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getAffiliatesByAdmin(MUCAffiliation.owner); @@ -1756,8 +1756,8 @@ public class MultiUserChat { * @return a list of Affiliate with the room administrators. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getAdmins() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getAffiliatesByAdmin(MUCAffiliation.admin); @@ -1769,8 +1769,8 @@ public class MultiUserChat { * @return a list of Affiliate with the room members. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getMembers() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getAffiliatesByAdmin(MUCAffiliation.member); @@ -1782,8 +1782,8 @@ public class MultiUserChat { * @return a list of Affiliate with the room outcasts. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getOutcasts() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getAffiliatesByAdmin(MUCAffiliation.outcast); @@ -1797,8 +1797,8 @@ public class MultiUserChat { * @return a collection of Affiliate that have the specified room affiliation. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ private List getAffiliatesByAdmin(MUCAffiliation affiliation) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { MUCAdmin iq = new MUCAdmin(); @@ -1824,8 +1824,8 @@ public class MultiUserChat { * @return a list of Occupant with the room moderators. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getModerators() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getOccupants(MUCRole.moderator); @@ -1833,12 +1833,12 @@ public class MultiUserChat { /** * Returns a list of Occupant with the room participants. - * + * * @return a list of Occupant with the room participants. * @throws XMPPErrorException if you don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getParticipants() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getOccupants(MUCRole.participant); @@ -1852,8 +1852,8 @@ public class MultiUserChat { * @throws XMPPErrorException if an error occured while performing the request to the server or you * don't have enough privileges to get this information. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ private List getOccupants(MUCRole role) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { MUCAdmin iq = new MUCAdmin(); @@ -1876,8 +1876,8 @@ public class MultiUserChat { * Sends a message to the chat room. * * @param text the text of the message to send. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendMessage(String text) throws NotConnectedException, InterruptedException { Message message = createMessage(); @@ -1916,8 +1916,8 @@ public class MultiUserChat { * Sends a Message to the chat room. * * @param message the message. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendMessage(Message message) throws NotConnectedException, InterruptedException { message.setTo(room); @@ -1935,7 +1935,7 @@ public class MultiUserChat { * * @return the next message if one is immediately available and * null otherwise. - * @throws MucNotJoinedException + * @throws MucNotJoinedException */ public Message pollMessage() throws MucNotJoinedException { if (messageCollector == null) { @@ -1949,8 +1949,8 @@ public class MultiUserChat { * (not return) until a message is available. * * @return the next message. - * @throws MucNotJoinedException - * @throws InterruptedException + * @throws MucNotJoinedException + * @throws InterruptedException */ public Message nextMessage() throws MucNotJoinedException, InterruptedException { if (messageCollector == null) { @@ -1967,8 +1967,8 @@ public class MultiUserChat { * @param timeout the maximum amount of time to wait for the next message. * @return the next message, or null if the timeout elapses without a * message becoming available. - * @throws MucNotJoinedException - * @throws InterruptedException + * @throws MucNotJoinedException + * @throws InterruptedException */ public Message nextMessage(long timeout) throws MucNotJoinedException, InterruptedException { if (messageCollector == null) { @@ -2013,8 +2013,8 @@ public class MultiUserChat { * @throws XMPPErrorException if someone without appropriate privileges attempts to change the * room subject will throw an error with code 403 (i.e. Forbidden) * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void changeSubject(final String subject) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Message message = createMessage(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatException.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatException.java index 46c990845..1f7f930a2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatException.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatException.java @@ -30,7 +30,7 @@ public abstract class MultiUserChatException extends SmackException { } /** - * + * */ private static final long serialVersionUID = 1L; @@ -39,7 +39,7 @@ public abstract class MultiUserChatException extends SmackException { public static class MucAlreadyJoinedException extends MultiUserChatException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -48,12 +48,12 @@ public abstract class MultiUserChatException extends SmackException { /** * Thrown if the requested operation required the MUC to be joined by the * client, while the client is currently joined. - * + * */ public static class MucNotJoinedException extends MultiUserChatException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -65,7 +65,7 @@ public abstract class MultiUserChatException extends SmackException { public static class MissingMucCreationAcknowledgeException extends MultiUserChatException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -77,7 +77,7 @@ public abstract class MultiUserChatException extends SmackException { public static class MucConfigurationNotSupportedException extends MultiUserChatException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -94,7 +94,7 @@ public abstract class MultiUserChatException extends SmackException { public static class NotAMucServiceException extends MultiUserChatException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatManager.java index 8d2600b1b..c88b64e3a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatManager.java @@ -74,7 +74,7 @@ import org.jxmpp.jid.parts.Resourcepart; * notified if this mechanism failed for some reason. Note that as soon as rejoining for a single room failed, no * further attempts will be made for the other rooms. *

    - * + * * @see XEP-0045: Multi-User Chat */ public final class MultiUserChatManager extends Manager { @@ -117,7 +117,7 @@ public final class MultiUserChatManager extends Manager { /** * Get a instance of a multi user chat manager for the given connection. - * + * * @param connection * @return a multi user chat manager. */ @@ -268,7 +268,7 @@ public final class MultiUserChatManager extends Manager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public boolean isServiceEnabled(Jid user) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(user, MUCInitialPresence.NAMESPACE); @@ -293,7 +293,7 @@ public final class MultiUserChatManager extends Manager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getJoinedRooms(EntityJid user) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -322,7 +322,7 @@ public final class MultiUserChatManager extends Manager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public RoomInfo getRoomInfo(EntityBareJid room) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { DiscoverInfo info = ServiceDiscoveryManager.getInstanceFor(connection()).discoverInfo(room); @@ -336,7 +336,7 @@ public final class MultiUserChatManager extends Manager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getMucServiceDomains() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection()); @@ -361,7 +361,7 @@ public final class MultiUserChatManager extends Manager { /** * Check if the provided domain bare JID provides a MUC service. - * + * * @param domainBareJid the domain bare JID to check. * @return true if the provided JID provides a MUC service, false otherwise. * @throws NoResponseException @@ -387,8 +387,8 @@ public final class MultiUserChatManager extends Manager { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException - * @throws NotAMucServiceException + * @throws InterruptedException + * @throws NotAMucServiceException */ public List getHostedRooms(DomainBareJid serviceName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotAMucServiceException { @@ -413,7 +413,7 @@ public final class MultiUserChatManager extends Manager { * @param inviter the inviter of the declined invitation. * @param reason the reason why the invitee is declining the invitation. * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public void decline(EntityBareJid room, EntityBareJid inviter, String reason) throws NotConnectedException, InterruptedException { Message message = new Message(room); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/Occupant.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/Occupant.java index 8fb3ae151..babce3829 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/Occupant.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/Occupant.java @@ -64,7 +64,7 @@ public class Occupant { if (from == null) { LOGGER.warning("Occupant presence without resource: " + presence.getFrom()); this.nick = null; - } else { + } else { this.nick = from.getResourcepart(); } } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/ParticipantStatusListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/ParticipantStatusListener.java index d22fbd0af..756bf41db 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/ParticipantStatusListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/ParticipantStatusListener.java @@ -22,9 +22,9 @@ import org.jxmpp.jid.Jid; import org.jxmpp.jid.parts.Resourcepart; /** - * A listener that is fired anytime a participant's status in a room is changed, such as the + * A listener that is fired anytime a participant's status in a room is changed, such as the * user being kicked, banned, or granted admin permissions. - * + * * @author Gaston Dombiak */ public interface ParticipantStatusListener { @@ -49,10 +49,10 @@ public interface ParticipantStatusListener { void left(EntityFullJid participant); /** - * Called when a room participant has been kicked from the room. This means that the kicked + * Called when a room participant has been kicked from the room. This means that the kicked * participant is no longer participating in the room. - * - * @param participant the participant that was kicked from the room + * + * @param participant the participant that was kicked from the room * (e.g. room@conference.jabber.org/nick). * @param actor the moderator that kicked the occupant from the room (e.g. user@host.org). * @param reason the reason provided by the actor to kick the occupant from the room. @@ -60,29 +60,29 @@ public interface ParticipantStatusListener { void kicked(EntityFullJid participant, Jid actor, String reason); /** - * Called when a moderator grants voice to a visitor. This means that the visitor + * Called when a moderator grants voice to a visitor. This means that the visitor * can now participate in the moderated room sending messages to all occupants. - * - * @param participant the participant that was granted voice in the room + * + * @param participant the participant that was granted voice in the room * (e.g. room@conference.jabber.org/nick). */ void voiceGranted(EntityFullJid participant); /** - * Called when a moderator revokes voice from a participant. This means that the participant - * in the room was able to speak and now is a visitor that can't send messages to the room + * Called when a moderator revokes voice from a participant. This means that the participant + * in the room was able to speak and now is a visitor that can't send messages to the room * occupants. - * - * @param participant the participant that was revoked voice from the room + * + * @param participant the participant that was revoked voice from the room * (e.g. room@conference.jabber.org/nick). */ void voiceRevoked(EntityFullJid participant); /** - * Called when an administrator or owner banned a participant from the room. This means that + * Called when an administrator or owner banned a participant from the room. This means that * banned participant will no longer be able to join the room unless the ban has been removed. - * - * @param participant the participant that was banned from the room + * + * @param participant the participant that was banned from the room * (e.g. room@conference.jabber.org/nick). * @param actor the administrator that banned the occupant (e.g. user@host.org). * @param reason the reason provided by the administrator to ban the occupant. @@ -90,87 +90,87 @@ public interface ParticipantStatusListener { void banned(EntityFullJid participant, Jid actor, String reason); /** - * Called when an administrator grants a user membership to the room. This means that the user + * Called when an administrator grants a user membership to the room. This means that the user * will be able to join the members-only room. - * - * @param participant the participant that was granted membership in the room + * + * @param participant the participant that was granted membership in the room * (e.g. room@conference.jabber.org/nick). */ void membershipGranted(EntityFullJid participant); /** - * Called when an administrator revokes a user membership to the room. This means that the + * Called when an administrator revokes a user membership to the room. This means that the * user will not be able to join the members-only room. - * - * @param participant the participant that was revoked membership from the room + * + * @param participant the participant that was revoked membership from the room * (e.g. room@conference.jabber.org/nick). */ void membershipRevoked(EntityFullJid participant); /** - * Called when an administrator grants moderator privileges to a user. This means that the user - * will be able to kick users, grant and revoke voice, invite other users, modify room's + * Called when an administrator grants moderator privileges to a user. This means that the user + * will be able to kick users, grant and revoke voice, invite other users, modify room's * subject plus all the partcipants privileges. - * - * @param participant the participant that was granted moderator privileges in the room + * + * @param participant the participant that was granted moderator privileges in the room * (e.g. room@conference.jabber.org/nick). */ void moderatorGranted(EntityFullJid participant); /** - * Called when an administrator revokes moderator privileges from a user. This means that the - * user will no longer be able to kick users, grant and revoke voice, invite other users, + * Called when an administrator revokes moderator privileges from a user. This means that the + * user will no longer be able to kick users, grant and revoke voice, invite other users, * modify room's subject plus all the partcipants privileges. - * - * @param participant the participant that was revoked moderator privileges in the room + * + * @param participant the participant that was revoked moderator privileges in the room * (e.g. room@conference.jabber.org/nick). */ void moderatorRevoked(EntityFullJid participant); /** - * Called when an owner grants a user ownership on the room. This means that the user - * will be able to change defining room features as well as perform all administrative + * Called when an owner grants a user ownership on the room. This means that the user + * will be able to change defining room features as well as perform all administrative * functions. - * - * @param participant the participant that was granted ownership on the room + * + * @param participant the participant that was granted ownership on the room * (e.g. room@conference.jabber.org/nick). */ void ownershipGranted(EntityFullJid participant); /** - * Called when an owner revokes a user ownership on the room. This means that the user - * will no longer be able to change defining room features as well as perform all + * Called when an owner revokes a user ownership on the room. This means that the user + * will no longer be able to change defining room features as well as perform all * administrative functions. - * - * @param participant the participant that was revoked ownership on the room + * + * @param participant the participant that was revoked ownership on the room * (e.g. room@conference.jabber.org/nick). */ void ownershipRevoked(EntityFullJid participant); /** - * Called when an owner grants administrator privileges to a user. This means that the user - * will be able to perform administrative functions such as banning users and edit moderator + * Called when an owner grants administrator privileges to a user. This means that the user + * will be able to perform administrative functions such as banning users and edit moderator * list. - * - * @param participant the participant that was granted administrator privileges + * + * @param participant the participant that was granted administrator privileges * (e.g. room@conference.jabber.org/nick). */ void adminGranted(EntityFullJid participant); /** - * Called when an owner revokes administrator privileges from a user. This means that the user - * will no longer be able to perform administrative functions such as banning users and edit + * Called when an owner revokes administrator privileges from a user. This means that the user + * will no longer be able to perform administrative functions such as banning users and edit * moderator list. - * - * @param participant the participant that was revoked administrator privileges + * + * @param participant the participant that was revoked administrator privileges * (e.g. room@conference.jabber.org/nick). */ void adminRevoked(EntityFullJid participant); /** - * Called when a participant changed his/her nickname in the room. The new participant's + * Called when a participant changed his/her nickname in the room. The new participant's * nickname will be informed with the next available presence. - * + * * @param participant the participant that was revoked administrator privileges * (e.g. room@conference.jabber.org/nick). * @param newNickname the new nickname that the participant decided to use. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java index a7a94d0c4..b31f5bb4f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/RoomInfo.java @@ -252,7 +252,7 @@ public class RoomInfo { * The name returnd here was provided as value of the name attribute * of the returned identity within the disco#info result. *

    - * + * * @return the name of the room. */ public String getName() { @@ -265,7 +265,7 @@ public class RoomInfo { * The description returned by this method was provided as value of the form * field of the extended disco info result. It may be null. *

    - * + * * @return the discovered description of the room or null */ public String getDescription() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/SubjectUpdatedListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/SubjectUpdatedListener.java index 723d4a787..eaebad4b6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/SubjectUpdatedListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/SubjectUpdatedListener.java @@ -21,14 +21,14 @@ import org.jxmpp.jid.EntityFullJid; /** * A listener that is fired anytime a MUC room changes its subject. - * + * * @author Gaston Dombiak */ public interface SubjectUpdatedListener { /** * Called when a MUC room has changed its subject. - * + * * @param subject the new room's subject. * @param from the user that changed the room's subject or null if the room itself changed the subject. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/UserStatusListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/UserStatusListener.java index e0b270660..105a09a0d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/UserStatusListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/UserStatusListener.java @@ -20,9 +20,9 @@ package org.jivesoftware.smackx.muc; import org.jxmpp.jid.Jid; /** - * A listener that is fired anytime your participant's status in a room is changed, such as the + * A listener that is fired anytime your participant's status in a room is changed, such as the * user being kicked, banned, or granted admin permissions or the room is destroyed. - * + * * @author Gaston Dombiak */ public interface UserStatusListener { @@ -30,102 +30,102 @@ public interface UserStatusListener { /** * Called when a moderator kicked your user from the room. This means that you are no longer * participanting in the room. - * + * * @param actor the moderator that kicked your user from the room (e.g. user@host.org). * @param reason the reason provided by the actor to kick you from the room. */ void kicked(Jid actor, String reason); /** - * Called when a moderator grants voice to your user. This means that you were a visitor in - * the moderated room before and now you can participate in the room by sending messages to + * Called when a moderator grants voice to your user. This means that you were a visitor in + * the moderated room before and now you can participate in the room by sending messages to * all occupants. - * + * */ void voiceGranted(); /** - * Called when a moderator revokes voice from your user. This means that you were a - * participant in the room able to speak and now you are a visitor that can't send + * Called when a moderator revokes voice from your user. This means that you were a + * participant in the room able to speak and now you are a visitor that can't send * messages to the room occupants. - * + * */ void voiceRevoked(); /** - * Called when an administrator or owner banned your user from the room. This means that you + * Called when an administrator or owner banned your user from the room. This means that you * will no longer be able to join the room unless the ban has been removed. - * + * * @param actor the administrator that banned your user (e.g. user@host.org). * @param reason the reason provided by the administrator to banned you. */ void banned(Jid actor, String reason); /** - * Called when an administrator grants your user membership to the room. This means that you - * will be able to join the members-only room. - * + * Called when an administrator grants your user membership to the room. This means that you + * will be able to join the members-only room. + * */ void membershipGranted(); /** - * Called when an administrator revokes your user membership to the room. This means that you + * Called when an administrator revokes your user membership to the room. This means that you * will not be able to join the members-only room. - * + * */ void membershipRevoked(); /** - * Called when an administrator grants moderator privileges to your user. This means that you - * will be able to kick users, grant and revoke voice, invite other users, modify room's + * Called when an administrator grants moderator privileges to your user. This means that you + * will be able to kick users, grant and revoke voice, invite other users, modify room's * subject plus all the partcipants privileges. - * + * */ void moderatorGranted(); /** - * Called when an administrator revokes moderator privileges from your user. This means that - * you will no longer be able to kick users, grant and revoke voice, invite other users, + * Called when an administrator revokes moderator privileges from your user. This means that + * you will no longer be able to kick users, grant and revoke voice, invite other users, * modify room's subject plus all the partcipants privileges. - * + * */ void moderatorRevoked(); /** - * Called when an owner grants to your user ownership on the room. This means that you - * will be able to change defining room features as well as perform all administrative + * Called when an owner grants to your user ownership on the room. This means that you + * will be able to change defining room features as well as perform all administrative * functions. - * + * */ void ownershipGranted(); /** - * Called when an owner revokes from your user ownership on the room. This means that you - * will no longer be able to change defining room features as well as perform all + * Called when an owner revokes from your user ownership on the room. This means that you + * will no longer be able to change defining room features as well as perform all * administrative functions. - * + * */ void ownershipRevoked(); /** - * Called when an owner grants administrator privileges to your user. This means that you - * will be able to perform administrative functions such as banning users and edit moderator + * Called when an owner grants administrator privileges to your user. This means that you + * will be able to perform administrative functions such as banning users and edit moderator * list. - * + * */ void adminGranted(); /** - * Called when an owner revokes administrator privileges from your user. This means that you - * will no longer be able to perform administrative functions such as banning users and edit + * Called when an owner revokes administrator privileges from your user. This means that you + * will no longer be able to perform administrative functions such as banning users and edit * moderator list. - * + * */ void adminRevoked(); /** * Called when the room is destroyed. - * + * * @param alternateMUC an alternate MultiUserChat, may be null. * @param reason the reason why the room was closed, may be null. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/Destroy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/Destroy.java index cf2fd22de..157a77dd2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/Destroy.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/Destroy.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.EntityBareJid; * Represents a request to the server to destroy a room. The sender of the request should be the * room's owner. If the sender of the destroy request is not the room's owner then the server will * answer a "Forbidden" error. - * + * * @author Gaston Dombiak */ public class Destroy implements NamedElement, Serializable { @@ -52,7 +52,7 @@ public class Destroy implements NamedElement, Serializable { /** * Returns the JID of an alternate location since the current room is being destroyed. - * + * * @return the JID of an alternate location. */ public EntityBareJid getJid() { @@ -61,7 +61,7 @@ public class Destroy implements NamedElement, Serializable { /** * Returns the reason for the room destruction. - * + * * @return the reason for the room destruction. */ public String getReason() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java index 37ab7d63a..6b2721b42 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java @@ -53,7 +53,7 @@ import org.xmlpull.v1.XmlPullParserException; * (XEP-45). However, most * existing clients still use this older protocol. Once MUC support becomes more * widespread, this API may be deprecated. - * + * * @author Matt Tucker */ public class GroupChatInvitation implements ExtensionElement { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java index 71dfa351e..a718b46fb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCAdmin.java @@ -23,11 +23,11 @@ import java.util.List; import org.jivesoftware.smack.packet.IQ; /** - * IQ stanza that serves for kicking users, granting and revoking voice, banning users, - * modifying the ban list, granting and revoking membership and granting and revoking - * moderator privileges. All these operations are scoped by the + * IQ stanza that serves for kicking users, granting and revoking voice, banning users, + * modifying the ban list, granting and revoking membership and granting and revoking + * moderator privileges. All these operations are scoped by the * 'http://jabber.org/protocol/muc#admin' namespace. - * + * * @author Gaston Dombiak */ public class MUCAdmin extends IQ { @@ -44,7 +44,7 @@ public class MUCAdmin extends IQ { /** * Returns a List of item children that holds information about roles, affiliation, * jids and nicks. - * + * * @return a List of item children that holds information about roles, affiliation, * jids and nicks. */ @@ -56,7 +56,7 @@ public class MUCAdmin extends IQ { /** * Adds an item child that holds information about roles, affiliation, jids and nicks. - * + * * @param item the item child that holds information about roles, affiliation, jids and nicks. */ public void addItem(MUCItem item) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCInitialPresence.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCInitialPresence.java index 31154f571..915ebafcf 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCInitialPresence.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCInitialPresence.java @@ -27,13 +27,13 @@ import org.jivesoftware.smack.util.XmlStringBuilder; import org.jxmpp.util.XmppDateTime; /** - * Represents extended presence information whose sole purpose is to signal the ability of - * the occupant to speak the MUC protocol when joining a room. If the room requires a password + * Represents extended presence information whose sole purpose is to signal the ability of + * the occupant to speak the MUC protocol when joining a room. If the room requires a password * then the MUCInitialPresence should include one. *

    - * The amount of discussion history provided on entering a room (perhaps because the + * The amount of discussion history provided on entering a room (perhaps because the * user is on a low-bandwidth connection or is using a small-footprint client) could be managed by - * setting a configured History instance to the MUCInitialPresence instance. + * setting a configured History instance to the MUCInitialPresence instance. * * @author Gaston Dombiak * @see MUCInitialPresence#setHistory(MUCInitialPresence.History) @@ -45,7 +45,7 @@ public class MUCInitialPresence implements ExtensionElement { // TODO make those fields final once deprecated setter methods have been removed. private String password; - private History history; + private History history; /** * Deprecated constructor. @@ -94,10 +94,10 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Returns the history that manages the amount of discussion history provided on + * Returns the history that manages the amount of discussion history provided on * entering a room. - * - * @return the history that manages the amount of discussion history provided on + * + * @return the history that manages the amount of discussion history provided on * entering a room. */ public History getHistory() { @@ -106,7 +106,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Returns the password to use when the room requires a password. - * + * * @return the password to use when the room requires a password. */ public String getPassword() { @@ -114,10 +114,10 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Sets the History that manages the amount of discussion history provided on + * Sets the History that manages the amount of discussion history provided on * entering a room. - * - * @param history that manages the amount of discussion history provided on + * + * @param history that manages the amount of discussion history provided on * entering a room. * @deprecated use {@link #MUCInitialPresence(String, int, int, int, Date)} instead. */ @@ -128,7 +128,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Sets the password to use when the room requires a password. - * + * * @param password the password to use when the room requires a password. * @deprecated use {@link #MUCInitialPresence(String, int, int, int, Date)} instead. */ @@ -162,7 +162,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * The History class controls the number of characters or messages to receive * when entering a room. - * + * * @author Gaston Dombiak */ public static class History implements NamedElement { @@ -173,7 +173,7 @@ public class MUCInitialPresence implements ExtensionElement { private int maxChars; private int maxStanzas; private int seconds; - private Date since; + private Date since; /** * Deprecated constructor. @@ -198,7 +198,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Returns the total number of characters to receive in the history. - * + * * @return total number of characters to receive in the history. */ public int getMaxChars() { @@ -207,7 +207,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Returns the total number of messages to receive in the history. - * + * * @return the total number of messages to receive in the history. */ public int getMaxStanzas() { @@ -215,10 +215,10 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Returns the number of seconds to use to filter the messages received during that time. - * In other words, only the messages received in the last "X" seconds will be included in + * Returns the number of seconds to use to filter the messages received during that time. + * In other words, only the messages received in the last "X" seconds will be included in * the history. - * + * * @return the number of seconds to use to filter the messages received during that time. */ public int getSeconds() { @@ -226,10 +226,10 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Returns the since date to use to filter the messages received during that time. - * In other words, only the messages received since the datetime specified will be + * Returns the since date to use to filter the messages received during that time. + * In other words, only the messages received since the datetime specified will be * included in the history. - * + * * @return the since date to use to filter the messages received during that time. */ public Date getSince() { @@ -238,7 +238,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Sets the total number of characters to receive in the history. - * + * * @param maxChars the total number of characters to receive in the history. * @deprecated use {@link #History(int, int, int, Date)} instead. */ @@ -249,7 +249,7 @@ public class MUCInitialPresence implements ExtensionElement { /** * Sets the total number of messages to receive in the history. - * + * * @param maxStanzas the total number of messages to receive in the history. * @deprecated use {@link #History(int, int, int, Date)} instead. */ @@ -259,11 +259,11 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Sets the number of seconds to use to filter the messages received during that time. - * In other words, only the messages received in the last "X" seconds will be included in + * Sets the number of seconds to use to filter the messages received during that time. + * In other words, only the messages received in the last "X" seconds will be included in * the history. - * - * @param seconds the number of seconds to use to filter the messages received during + * + * @param seconds the number of seconds to use to filter the messages received during * that time. * @deprecated use {@link #History(int, int, int, Date)} instead. */ @@ -273,10 +273,10 @@ public class MUCInitialPresence implements ExtensionElement { } /** - * Sets the since date to use to filter the messages received during that time. - * In other words, only the messages received since the datetime specified will be + * Sets the since date to use to filter the messages received during that time. + * In other words, only the messages received since the datetime specified will be * included in the history. - * + * * @param since the since date to use to filter the messages received during that time. * @deprecated use {@link #History(int, int, int, Date)} instead. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCItem.java index de39760bf..c02fb7576 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCItem.java @@ -68,7 +68,7 @@ public class MUCItem implements NamedElement { /** * Creates a new item child. - * + * * @param affiliation the actor's affiliation to the room * @param role the privilege level of an occupant within a room. * @param actor @@ -90,7 +90,7 @@ public class MUCItem implements NamedElement { /** * Returns the actor (JID of an occupant in the room) that was kicked or banned. - * + * * @return the JID of an occupant in the room that was kicked or banned. */ public Jid getActor() { @@ -110,7 +110,7 @@ public class MUCItem implements NamedElement { /** * Returns the reason for the item child. The reason is optional and could be used to explain * the reason why a user (occupant) was kicked or banned. - * + * * @return the reason for the item child. */ public String getReason() { @@ -122,7 +122,7 @@ public class MUCItem implements NamedElement { * association or connection with a room. The possible affiliations are "owner", "admin", * "member", and "outcast" (naturally it is also possible to have no affiliation). An * affiliation lasts across a user's visits to a room. - * + * * @return the actor's affiliation to the room */ public MUCAffiliation getAffiliation() { @@ -132,7 +132,7 @@ public class MUCItem implements NamedElement { /** * Returns the <room@service/nick> by which an occupant is identified within the context of a * room. If the room is non-anonymous, the JID will be included in the item. - * + * * @return the room JID by which an occupant is identified within the room. */ public Jid getJid() { @@ -142,7 +142,7 @@ public class MUCItem implements NamedElement { /** * Returns the new nickname of an occupant that is changing his/her nickname. The new nickname * is sent as part of the unavailable presence. - * + * * @return the new nickname of an occupant that is changing his/her nickname. */ public Resourcepart getNick() { @@ -153,7 +153,7 @@ public class MUCItem implements NamedElement { * Returns the temporary position or privilege level of an occupant within a room. The possible * roles are "moderator", "participant", "visitor" and "none" (it is also possible to have no defined * role). A role lasts only for the duration of an occupant's visit to a room. - * + * * @return the privilege level of an occupant within a room. */ public MUCRole getRole() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java index 9a1c95224..92d70e0dc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCOwner.java @@ -23,10 +23,10 @@ import java.util.List; import org.jivesoftware.smack.packet.IQ; /** - * IQ stanza that serves for granting and revoking ownership privileges, granting - * and revoking administrative privileges and destroying a room. All these operations + * IQ stanza that serves for granting and revoking ownership privileges, granting + * and revoking administrative privileges and destroying a room. All these operations * are scoped by the 'http://jabber.org/protocol/muc#owner' namespace. - * + * * @author Gaston Dombiak */ public class MUCOwner extends IQ { @@ -44,7 +44,7 @@ public class MUCOwner extends IQ { /** * Returns a List of item children that holds information about affiliation, * jids and nicks. - * + * * @return a List of item children that holds information about affiliation, * jids and nicks. */ @@ -58,7 +58,7 @@ public class MUCOwner extends IQ { * Returns a request to the server to destroy a room. The sender of the request * should be the room's owner. If the sender of the destroy request is not the room's owner * then the server will answer a "Forbidden" error. - * + * * @return a request to the server to destroy a room. */ public Destroy getDestroy() { @@ -69,7 +69,7 @@ public class MUCOwner extends IQ { * Sets a request to the server to destroy a room. The sender of the request * should be the room's owner. If the sender of the destroy request is not the room's owner * then the server will answer a "Forbidden" error. - * + * * @param destroy the request to the server to destroy a room. */ public void setDestroy(Destroy destroy) { @@ -78,7 +78,7 @@ public class MUCOwner extends IQ { /** * Adds an item child that holds information about affiliation, jids and nicks. - * + * * @param item the item child that holds information about affiliation, jids and nicks. */ public void addItem(MUCItem item) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCAdminProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCAdminProvider.java index a14576de1..8b450e71d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCAdminProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCAdminProvider.java @@ -28,7 +28,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * The MUCAdminProvider parses MUCAdmin packets. (@see MUCAdmin) - * + * * @author Gaston Dombiak */ public class MUCAdminProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCOwnerProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCOwnerProvider.java index 92202054c..d53a244d1 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCOwnerProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCOwnerProvider.java @@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser; /** * The MUCOwnerProvider parses MUCOwner packets. (@see MUCOwner) - * + * * @author Gaston Dombiak */ public class MUCOwnerProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java index 1c33e1e61..8de4387e6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java @@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * The MUCUserProvider parses packets with extended presence information about + * The MUCUserProvider parses packets with extended presence information about * roles and affiliations. * * @author Gaston Dombiak @@ -42,8 +42,8 @@ public class MUCUserProvider extends ExtensionElementProvider { * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ @Override public MUCUser parse(XmlPullParser parser, int initialDepth) throws XmlPullParserException, IOException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java index 25fde6317..9c030c021 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java @@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * A minimalistic implementation of a {@link ExtensionElement} for nicknames. - * + * * @author Guus der Kinderen, guus.der.kinderen@gmail.com * @see XEP-0172: User Nickname */ @@ -44,7 +44,7 @@ public class Nick implements ExtensionElement { /** * The value of this nickname. - * + * * @return the nickname */ public String getName() { @@ -53,7 +53,7 @@ public class Nick implements ExtensionElement { /** * Sets the value of this nickname. - * + * * @param name * the name to set */ @@ -63,7 +63,7 @@ public class Nick implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#getElementName() */ @Override @@ -73,7 +73,7 @@ public class Nick implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#getNamespace() */ @Override @@ -83,7 +83,7 @@ public class Nick implements ExtensionElement { /* * (non-Javadoc) - * + * * @see org.jivesoftware.smack.packet.PacketExtension#toXML() */ @Override diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java index 08ff858d1..9616df194 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java @@ -81,8 +81,8 @@ public class OfflineMessageManager { * @return a boolean indicating if the server supports Flexible Offline Message Retrieval. * @throws XMPPErrorException If the user is not allowed to make this request. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean supportsFlexibleRetrieval() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection).serverSupportsFeature(namespace); @@ -95,8 +95,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public int getMessageCount() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { DiscoverInfo info = ServiceDiscoveryManager.getInstanceFor(connection).discoverInfo(null, @@ -119,8 +119,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getHeaders() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { List answer = new ArrayList<>(); @@ -144,8 +144,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getMessages(final List nodes) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { List messages = new ArrayList<>(nodes.size()); @@ -197,8 +197,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getMessages() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { OfflineMessageRequest request = new OfflineMessageRequest(); @@ -237,8 +237,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteMessages(List nodes) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { OfflineMessageRequest request = new OfflineMessageRequest(); @@ -257,8 +257,8 @@ public class OfflineMessageManager { * @throws XMPPErrorException If the user is not allowed to make this request or the server does * not support offline message retrieval. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteMessages() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { OfflineMessageRequest request = new OfflineMessageRequest(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java index 520b8c19c..6ce937cb5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java @@ -99,8 +99,8 @@ public class OfflineMessageInfo implements ExtensionElement { * * @param parser the XML parser, positioned at the starting element of the extension. * @return a PacketExtension. - * @throws IOException - * @throws XmlPullParserException + * @throws IOException + * @throws XmlPullParserException */ @Override public OfflineMessageInfo parse(XmlPullParser parser, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPListener.java index 95506ec34..52bd7d007 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPListener.java @@ -35,7 +35,7 @@ public interface PEPListener { /** * Called when PEP events are received as part of a presence subscribe or message filter. - * + * * @param from the user that sent the entries. * @param event the event contained in the message. * @param message the message stanza containing the PEP event. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPManager.java index bcade8cc3..6c3a70b63 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PEPManager.java @@ -53,9 +53,9 @@ import org.jxmpp.jid.EntityBareJid; * Manages Personal Event Publishing (XEP-163). A PEPManager provides a high level access to * PubSub personal events. It also provides an easy way * to hook up custom logic when events are received from another XMPP client through PEPListeners. - * + * * Use example: - * + * * 

      *   PEPManager pepManager = new PEPManager(smackConnection);
  *   pepManager.addPEPListener(new PEPListener() {
@@ -64,7 +64,7 @@ import org.jxmpp.jid.EntityBareJid;
  *       }
  *   });
  *
    - * + * * @author Jeff Williams * @author Florian Schmaus */ @@ -141,14 +141,14 @@ public final class PEPManager extends Manager { /** * Publish an event. - * + * * @param item the item to publish. * @param node the node to publish on. * @throws NotConnectedException * @throws InterruptedException * @throws XMPPErrorException * @throws NoResponseException - * @throws NotAPubSubNodeException + * @throws NotAPubSubNodeException */ public void publish(Item item, String node) throws NotConnectedException, InterruptedException, NoResponseException, XMPPErrorException, NotAPubSubNodeException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java index e60bea159..276f50fbc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java @@ -59,7 +59,7 @@ import org.jxmpp.jid.Jid; * The default server ping interval is 30 minutes and can be modified with * {@link #setDefaultPingInterval(int)} and {@link #setPingInterval(int)}. *

    - * + * * @author Florian Schmaus * @see XEP-0199:XMPP Ping */ @@ -80,7 +80,7 @@ public final class PingManager extends Manager { /** * Retrieves a {@link PingManager} for the specified {@link XMPPConnection}, creating one if it doesn't already * exist. - * + * * @param connection * The connection the manager is attached to. * @return The new or existing manager. @@ -214,19 +214,19 @@ public final class PingManager extends Manager { } /** - * Pings the given jid. This method will return false if an error occurs. The exception - * to this, is a server ping, which will always return true if the server is reachable, + * Pings the given jid. This method will return false if an error occurs. The exception + * to this, is a server ping, which will always return true if the server is reachable, * event if there is an error on the ping itself (i.e. ping not supported). *

    - * Use {@link #isPingSupported(Jid)} to determine if XMPP Ping is supported + * Use {@link #isPingSupported(Jid)} to determine if XMPP Ping is supported * by the entity. - * + * * @param jid The id of the entity the ping is being sent to * @param pingTimeout The time to wait for a reply in milliseconds * @return true if a reply was received from the entity, false otherwise. * @throws NoResponseException if there was no response from the jid. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean ping(Jid jid, long pingTimeout) throws NotConnectedException, NoResponseException, InterruptedException { final XMPPConnection connection = connection(); @@ -246,14 +246,14 @@ public final class PingManager extends Manager { } /** - * Same as calling {@link #ping(Jid, long)} with the defaultpacket reply + * Same as calling {@link #ping(Jid, long)} with the defaultpacket reply * timeout. - * + * * @param jid The id of the entity the ping is being sent to * @return true if a reply was received from the entity, false otherwise. * @throws NotConnectedException * @throws NoResponseException if there was no response from the jid. - * @throws InterruptedException + * @throws InterruptedException */ public boolean ping(Jid jid) throws NotConnectedException, NoResponseException, InterruptedException { return ping(jid, connection().getReplyTimeout()); @@ -261,13 +261,13 @@ public final class PingManager extends Manager { /** * Query the specified entity to see if it supports the Ping protocol (XEP-0199). - * + * * @param jid The id of the entity the query is being sent to * @return true if it supports ping, false otherwise. - * @throws XMPPErrorException An XMPP related error occurred during the request + * @throws XMPPErrorException An XMPP related error occurred during the request * @throws NoResponseException if there was no response from the jid. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean isPingSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, Ping.NAMESPACE); @@ -277,12 +277,12 @@ public final class PingManager extends Manager { * Pings the server. This method will return true if the server is reachable. It * is the equivalent of calling ping with the XMPP domain. *

    - * Unlike the {@link #ping(Jid)} case, this method will return true even if + * Unlike the {@link #ping(Jid)} case, this method will return true even if * {@link #isPingSupported(Jid)} is false. - * + * * @return true if a reply was received from the server, false otherwise. * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public boolean pingMyServer() throws NotConnectedException, InterruptedException { return pingMyServer(true); @@ -298,7 +298,7 @@ public final class PingManager extends Manager { * @param notifyListeners Notify the PingFailedListener in case of error if true * @return true if the user's server could be pinged. * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public boolean pingMyServer(boolean notifyListeners) throws NotConnectedException, InterruptedException { return pingMyServer(notifyListeners, connection().getReplyTimeout()); @@ -315,7 +315,7 @@ public final class PingManager extends Manager { * @param pingTimeout The time to wait for a reply in milliseconds * @return true if the user's server could be pinged. * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public boolean pingMyServer(boolean notifyListeners, long pingTimeout) throws NotConnectedException, InterruptedException { boolean res; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java index e59c73083..65d7186fa 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java @@ -38,7 +38,7 @@ public class Ping extends SimpleIQ { /** * Create an XMPP Pong for this Ping. - * + * * @return the Pong */ public IQ getPong() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyList.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyList.java index eee6de877..120c4d341 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyList.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyList.java @@ -21,7 +21,7 @@ import java.util.List; import org.jivesoftware.smackx.privacy.packet.PrivacyItem; /** - * A privacy list represents a list of contacts that is a read only class used to represent a set of allowed or blocked communications. + * A privacy list represents a list of contacts that is a read only class used to represent a set of allowed or blocked communications. * Basically it can:

      * *
    • Handle many {@link org.jivesoftware.smackx.privacy.packet.PrivacyItem}.
      • @@ -31,7 +31,7 @@ import org.jivesoftware.smackx.privacy.packet.PrivacyItem; * * {@link PrivacyItem Privacy Items} can handle different kind of blocking communications based on JID, group, * subscription type or globally. - * + * * @author Francisco Vives */ public class PrivacyList { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListListener.java index f9ea149aa..d1d7b5bd7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListListener.java @@ -21,11 +21,11 @@ import java.util.List; import org.jivesoftware.smackx.privacy.packet.PrivacyItem; /** - * Interface to implement classes to listen for server events about privacy communication. + * Interface to implement classes to listen for server events about privacy communication. * Listeners are registered with the {@link PrivacyListManager}. * * @see PrivacyListManager#addListener - * + * * @author Francisco Vives */ public interface PrivacyListListener { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java index 04903b9b8..b18e5b882 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java @@ -58,9 +58,9 @@ import org.jivesoftware.smackx.privacy.packet.PrivacyItem; *
    • Set, change, or decline active lists. *
    • Set, change, or decline the default list (i.e., the list that is active by default). *
    - * Privacy Items can handle different kind of permission communications based on JID, group, + * Privacy Items can handle different kind of permission communications based on JID, group, * subscription type or globally (see {@link PrivacyItem}). - * + * * @author Francisco Vives * @see XEP-16: Privacy Lists */ @@ -92,7 +92,7 @@ public final class PrivacyListManager extends Manager { /** * Creates a new privacy manager to maintain the communication privacy. Note: no - * information is sent to or received from the server until you attempt to + * information is sent to or received from the server until you attempt to * get or set the privacy communication.

    * * @param connection the XMPP connection. @@ -203,7 +203,7 @@ public final class PrivacyListManager extends Manager { /** * Returns the PrivacyListManager instance associated with a given XMPPConnection. - * + * * @param connection the connection used to look for the proper PrivacyListManager. * @return the PrivacyListManager associated with a given XMPPConnection. */ @@ -218,17 +218,17 @@ public final class PrivacyListManager extends Manager { } /** - * Send the {@link Privacy} stanza to the server in order to know some privacy content and then + * Send the {@link Privacy} stanza to the server in order to know some privacy content and then * waits for the answer. - * + * * @param requestPrivacy is the {@link Privacy} stanza configured properly whose XML * will be sent to the server. * @return a new {@link Privacy} with the data received from the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ private Privacy getRequest(Privacy requestPrivacy) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request is a get iq type requestPrivacy.setType(Privacy.Type.get); @@ -239,14 +239,14 @@ public final class PrivacyListManager extends Manager { /** * Send the {@link Privacy} stanza to the server in order to modify the server privacy and waits * for the answer. - * + * * @param requestPrivacy is the {@link Privacy} stanza configured properly whose xml will be * sent to the server. * @return a new {@link Privacy} with the data received from the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ private Stanza setRequest(Privacy requestPrivacy) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request is a get iq type @@ -257,13 +257,13 @@ public final class PrivacyListManager extends Manager { /** * Answer a privacy containing the list structure without {@link PrivacyItem}. - * + * * @return a Privacy with the list names. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ private Privacy getPrivacyWithListNames() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an empty privacy message Privacy request = new Privacy(); @@ -274,13 +274,13 @@ public final class PrivacyListManager extends Manager { /** * Answer the active privacy list. Returns null if there is no active list. - * + * * @return the privacy list of the active list. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public PrivacyList getActiveList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Privacy privacyAnswer = this.getPrivacyWithListNames(); String listName = privacyAnswer.getActiveName(); @@ -293,12 +293,12 @@ public final class PrivacyListManager extends Manager { /** * Get the name of the active list. - * + * * @return the name of the active list or null if there is none set. * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @since 4.1 */ public String getActiveListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -310,13 +310,13 @@ public final class PrivacyListManager extends Manager { /** * Answer the default privacy list. Returns null if there is no default list. - * + * * @return the privacy list of the default list. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public PrivacyList getDefaultList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Privacy privacyAnswer = this.getPrivacyWithListNames(); String listName = privacyAnswer.getDefaultName(); @@ -334,7 +334,7 @@ public final class PrivacyListManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @since 4.1 */ public String getDefaultListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -355,7 +355,7 @@ public final class PrivacyListManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @since 4.1 */ public String getEffectiveListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -368,14 +368,14 @@ public final class PrivacyListManager extends Manager { /** * Answer the privacy list items under listName with the allowed and blocked permissions. - * + * * @param listName the name of the list to get the allowed and blocked permissions. * @return a list of privacy items under the list listName. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ private List getPrivacyListItems(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { assert StringUtils.isNotEmpty(listName); // The request of the list is an privacy message with an empty list @@ -390,14 +390,14 @@ public final class PrivacyListManager extends Manager { /** * Answer the privacy list items under listName with the allowed and blocked permissions. - * + * * @param listName the name of the list to get the allowed and blocked permissions. * @return a privacy list under the list listName. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public PrivacyList getPrivacyList(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { listName = StringUtils.requireNotNullOrEmpty(listName, "List name must not be null"); return new PrivacyList(false, false, listName, getPrivacyListItems(listName)); @@ -405,13 +405,13 @@ public final class PrivacyListManager extends Manager { /** * Answer every privacy list with the allowed and blocked permissions. - * + * * @return an array of privacy lists. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public List getPrivacyLists() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Privacy privacyAnswer = getPrivacyWithListNames(); Set names = privacyAnswer.getPrivacyListNames(); @@ -427,13 +427,13 @@ public final class PrivacyListManager extends Manager { /** * Set or change the active list to listName. - * + * * @param listName the list name to set as the active one. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void setActiveListName(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an privacy message with an empty list Privacy request = new Privacy(); @@ -445,11 +445,11 @@ public final class PrivacyListManager extends Manager { /** * Client declines the use of active lists. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void declineActiveList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an privacy message with an empty list Privacy request = new Privacy(); @@ -461,13 +461,13 @@ public final class PrivacyListManager extends Manager { /** * Set or change the default list to listName. - * + * * @param listName the list name to set as the default one. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void setDefaultListName(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an privacy message with an empty list Privacy request = new Privacy(); @@ -479,11 +479,11 @@ public final class PrivacyListManager extends Manager { /** * Client declines the use of default lists. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void declineDefaultList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an privacy message with an empty list Privacy request = new Privacy(); @@ -495,30 +495,30 @@ public final class PrivacyListManager extends Manager { /** * The client has created a new list. It send the new one to the server. - * + * * @param listName the list that has changed its content. * @param privacyItems a List with every privacy item in the list. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void createPrivacyList(String listName, List privacyItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { updatePrivacyList(listName, privacyItems); } /** - * The client has edited an existing list. It updates the server content with the resulting - * list of privacy items. The {@link PrivacyItem} list MUST contain all elements in the + * The client has edited an existing list. It updates the server content with the resulting + * list of privacy items. The {@link PrivacyItem} list MUST contain all elements in the * list (not the "delta"). - * + * * @param listName the list that has changed its content. * @param privacyItems a List with every privacy item in the list. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void updatePrivacyList(String listName, List privacyItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Build the privacy package to add or update the new list Privacy request = new Privacy(); @@ -530,13 +530,13 @@ public final class PrivacyListManager extends Manager { /** * Remove a privacy list. - * + * * @param listName the list that has changed its content. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - */ + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + */ public void deletePrivacyList(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // The request of the list is an privacy message with an empty list Privacy request = new Privacy(); @@ -569,12 +569,12 @@ public final class PrivacyListManager extends Manager { /** * Check if the user's server supports privacy lists. - * + * * @return true, if the server supports privacy lists, false otherwise. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean isSupported() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(NAMESPACE); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java index 659c6d35f..bbabb9f58 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java @@ -31,14 +31,14 @@ import org.jivesoftware.smack.packet.IQ; * user-defined privacy lists. Different configured Privacy packages are used in the * server and manager communication in order to: *

      - *
    • Retrieving one's privacy lists. - *
    • Adding, removing, and editing one's privacy lists. - *
    • Setting, changing, or declining active lists. - *
    • Setting, changing, or declining the default list (i.e., the list that is active by default). + *
    • Retrieving one's privacy lists. + *
    • Adding, removing, and editing one's privacy lists. + *
    • Setting, changing, or declining active lists. + *
    • Setting, changing, or declining the default list (i.e., the list that is active by default). *
    - * Privacy Items can handle different kind of blocking communications based on JID, group, + * Privacy Items can handle different kind of blocking communications based on JID, group, * subscription type or globally {@link PrivacyItem} - * + * * @author Francisco Vives */ public class Privacy extends IQ { @@ -53,7 +53,7 @@ public class Privacy extends IQ { private boolean declineDefaultList = false; /** defaultName is the name of the default list that applies to the user as a whole **/ private String defaultName; - /** itemLists holds the set of privacy items classified in lists. It is a map where the + /** itemLists holds the set of privacy items classified in lists. It is a map where the * key is the name of the list and the value a collection with privacy items. **/ private final Map> itemLists = new HashMap<>(); @@ -85,8 +85,8 @@ public class Privacy extends IQ { } /** - * Deletes an existing privacy list. If the privacy list being deleted was the default list - * then the user will end up with no default list. Therefore, the user will have to set a new + * Deletes an existing privacy list. If the privacy list being deleted was the default list + * then the user will end up with no default list. Therefore, the user will have to set a new * default list. * * @param listName the name of the list being deleted. @@ -180,7 +180,7 @@ public class Privacy extends IQ { return true; } else { // CHECKSTYLE:OFF - return false; + return false; // CHECKSTYLE:ON } } @@ -211,7 +211,7 @@ public class Privacy extends IQ { /** * Sets the name associated with the active list set for the session. Communications * will be verified against the active list. - * + * * @param activeName is the name of the active list. */ // CHECKSTYLE:OFF @@ -221,10 +221,10 @@ public class Privacy extends IQ { // CHECKSTYLE:ON /** - * Returns the name of the default list that applies to the user as a whole. Default list is - * processed if there is no active list set for the target session/resource to which a stanza + * Returns the name of the default list that applies to the user as a whole. Default list is + * processed if there is no active list set for the target session/resource to which a stanza * is addressed, or if there are no current sessions for the user. - * + * * @return the name of the default list. */ // CHECKSTYLE:OFF @@ -234,12 +234,12 @@ public class Privacy extends IQ { // CHECKSTYLE:ON /** - * Sets the name of the default list that applies to the user as a whole. Default list is - * processed if there is no active list set for the target session/resource to which a stanza + * Sets the name of the default list that applies to the user as a whole. Default list is + * processed if there is no active list set for the target session/resource to which a stanza * is addressed, or if there are no current sessions for the user. - * + * * If there is no default list set, then all Privacy Items are processed. - * + * * @param defaultName is the name of the default list. */ // CHECKSTYLE:OFF @@ -249,11 +249,11 @@ public class Privacy extends IQ { // CHECKSTYLE:ON /** - * Returns the collection of privacy list that the user holds. A Privacy List contains a set of - * rules that define if communication with the list owner is allowed or denied. + * Returns the collection of privacy list that the user holds. A Privacy List contains a set of + * rules that define if communication with the list owner is allowed or denied. * Users may have zero, one or more privacy items. - * - * @return a map where the key is the name of the list and the value the + * + * @return a map where the key is the name of the list and the value the * collection of privacy items. */ // CHECKSTYLE:OFF @@ -262,9 +262,9 @@ public class Privacy extends IQ { } // CHECKSTYLE:ON - /** + /** * Returns whether the receiver allows or declines the use of an active list. - * + * * @return the decline status of the list. */ // CHECKSTYLE:OFF @@ -273,9 +273,9 @@ public class Privacy extends IQ { } // CHECKSTYLE:ON - /** + /** * Sets whether the receiver allows or declines the use of an active list. - * + * * @param declineActiveList indicates if the receiver declines the use of an active list. */ // CHECKSTYLE:OFF @@ -284,9 +284,9 @@ public class Privacy extends IQ { } // CHECKSTYLE:ON - /** + /** * Returns whether the receiver allows or declines the use of a default list. - * + * * @return the decline status of the list. */ // CHECKSTYLE:OFF @@ -295,9 +295,9 @@ public class Privacy extends IQ { } // CHECKSTYLE:ON - /** + /** * Sets whether the receiver allows or declines the use of a default list. - * + * * @param declineDefaultList indicates if the receiver declines the use of a default list. */ // CHECKSTYLE:OFF @@ -305,9 +305,9 @@ public class Privacy extends IQ { this.declineDefaultList = declineDefaultList; } - /** + /** * Returns all the list names the user has defined to group restrictions. - * + * * @return a Set with Strings containing every list names. */ public Set getPrivacyListNames() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java index 88981bdc4..41f845a68 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java @@ -32,9 +32,9 @@ import org.xmlpull.v1.XmlPullParserException; /** * The PrivacyProvider parses {@link Privacy} packets. {@link Privacy} * Parses the query sub-document and creates an instance of {@link Privacy}. - * For each item in the list element, it creates an instance + * For each item in the list element, it creates an instance * of {@link PrivacyItem}. - * + * * @author Francisco Vives */ public class PrivacyProvider extends IQProvider { @@ -115,8 +115,8 @@ public class PrivacyProvider extends IQProvider { // If type is not set, then it's the fall-through case String type = parser.getAttributeValue("", "type"); - /* - * According the action value it sets the allow status. The fall-through action is assumed + /* + * According the action value it sets the allow status. The fall-through action is assumed * to be "allow" */ boolean allow; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java index 772446d38..df6cd903b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; /** * This enumeration represents the access models for the PubSub node * as defined in the PubSub specification section 16.4.3. - * + * * @author Robin Collier */ public enum AccessModel { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Affiliation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Affiliation.java index 7a02e1263..b6c9a501c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Affiliation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Affiliation.java @@ -29,11 +29,11 @@ import org.jxmpp.jid.BareJid; /** * Represents a affiliation between a user and a node, where the {@link Type} defines * the type of affiliation. - * - * Affiliations are retrieved from the {@link PubSubManager#getAffiliations()} method, which - * gets affiliations for the calling user, based on the identity that is associated with + * + * Affiliations are retrieved from the {@link PubSubManager#getAffiliations()} method, which + * gets affiliations for the calling user, based on the identity that is associated with * the {@link XMPPConnection}. - * + * * @author Robin Collier */ public class Affiliation implements ExtensionElement { @@ -70,7 +70,7 @@ public class Affiliation implements ExtensionElement { /** * Constructs an affiliation. - * + * * @param node The node the user is affiliated with. * @param affiliation the optional affiliation. */ @@ -80,7 +80,7 @@ public class Affiliation implements ExtensionElement { /** * Constructs an affiliation. - * + * * @param node The node the user is affiliated with. * @param affiliation the optional affiliation. * @param namespace the affiliation's namespace. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AffiliationsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AffiliationsExtension.java index 2dc6ea11b..fcda5b2f2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AffiliationsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AffiliationsExtension.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.pubsub.Affiliation.AffiliationNamespace; * Represents the affiliations element of the reply to a request for affiliations. * It is defined in the specification in section 5.7 Retrieve Affiliations and * 8.9 Manage Affiliations. - * + * * @author Robin Collier */ public class AffiliationsExtension extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java index 217b554e0..f2e9ad0cd 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; /** * This enumeration represents the children association policy for associating leaf nodes * with collection nodes as defined in the PubSub specification section 16.4.3. - * + * * @author Robin Collier */ public enum ChildrenAssociationPolicy { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigurationEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigurationEvent.java index d45561146..821b207aa 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigurationEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigurationEvent.java @@ -24,9 +24,9 @@ import org.jivesoftware.smack.packet.ExtensionElement; /** * Represents the configuration element of a PubSub message event which - * associates a configuration form to the node which was configured. The form + * associates a configuration form to the node which was configured. The form * contains the current node configuration. - * + * * @author Robin Collier */ public class ConfigurationEvent extends NodeExtension implements EmbeddedPacketExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java index 4f8f65f54..d9cc09e92 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java @@ -26,18 +26,18 @@ import org.jivesoftware.smackx.xdata.packet.DataForm; /** * A decorator for a {@link Form} to easily enable reading and updating * of node configuration. All operations read or update the underlying {@link DataForm}. - * + * *

    Unlike the {@link Form}.setAnswer(XXX)} methods, which throw an exception if the field does not * exist, all ConfigureForm.setXXX methods will create the field in the wrapped form - * if it does not already exist. - * + * if it does not already exist. + * * @author Robin Collier */ public class ConfigureForm extends Form { /** * Create a decorator from an existing {@link DataForm} that has been * retrieved from parsing a node configuration request. - * + * * @param configDataForm */ public ConfigureForm(DataForm configDataForm) { @@ -48,7 +48,7 @@ public class ConfigureForm extends Form { * Create a decorator from an existing {@link Form} for node configuration. * Typically, this can be used to create a decorator for an answer form * by using the result of {@link #createAnswerForm()} as the input parameter. - * + * * @param nodeConfigForm */ public ConfigureForm(Form nodeConfigForm) { @@ -56,8 +56,8 @@ public class ConfigureForm extends Form { } /** - * Create a new form for configuring a node. This would typically only be used - * when creating and configuring a node at the same time via {@link PubSubManager#createNode(String, Form)}, since + * Create a new form for configuring a node. This would typically only be used + * when creating and configuring a node at the same time via {@link PubSubManager#createNode(String, Form)}, since * configuration of an existing node is typically accomplished by calling {@link LeafNode#getNodeConfiguration()} and * using the resulting form to create a answer form. See {@link #ConfigureForm(Form)}. * @param formType @@ -68,7 +68,7 @@ public class ConfigureForm extends Form { /** * Get the currently configured {@link AccessModel}, null if it is not set. - * + * * @return The current {@link AccessModel} */ public AccessModel getAccessModel() { @@ -82,7 +82,7 @@ public class ConfigureForm extends Form { /** * Sets the value of access model. - * + * * @param accessModel */ public void setAccessModel(AccessModel accessModel) { @@ -91,9 +91,9 @@ public class ConfigureForm extends Form { } /** - * Returns the URL of an XSL transformation which can be applied to payloads in order to + * Returns the URL of an XSL transformation which can be applied to payloads in order to * generate an appropriate message body element. - * + * * @return URL to an XSL */ public String getBodyXSLT() { @@ -101,9 +101,9 @@ public class ConfigureForm extends Form { } /** - * Set the URL of an XSL transformation which can be applied to payloads in order to + * Set the URL of an XSL transformation which can be applied to payloads in order to * generate an appropriate message body element. - * + * * @param bodyXslt The URL of an XSL */ public void setBodyXSLT(String bodyXslt) { @@ -113,7 +113,7 @@ public class ConfigureForm extends Form { /** * The id's of the child nodes associated with a collection node (both leaf and collection). - * + * * @return list of child nodes. */ public List getChildren() { @@ -122,7 +122,7 @@ public class ConfigureForm extends Form { /** * Set the list of child node ids that are associated with a collection node. - * + * * @param children */ public void setChildren(List children) { @@ -132,7 +132,7 @@ public class ConfigureForm extends Form { /** * Returns the policy that determines who may associate children with the node. - * + * * @return The current policy */ public ChildrenAssociationPolicy getChildrenAssociationPolicy() { @@ -146,7 +146,7 @@ public class ConfigureForm extends Form { /** * Sets the policy that determines who may associate children with the node. - * + * * @param policy The policy being set */ public void setChildrenAssociationPolicy(ChildrenAssociationPolicy policy) { @@ -157,10 +157,10 @@ public class ConfigureForm extends Form { } /** - * List of JID's that are on the whitelist that determines who can associate child nodes + * List of JID's that are on the whitelist that determines who can associate child nodes * with the collection node. This is only relevant if {@link #getChildrenAssociationPolicy()} is set to * {@link ChildrenAssociationPolicy#whitelist}. - * + * * @return List of the whitelist */ public List getChildrenAssociationWhitelist() { @@ -168,10 +168,10 @@ public class ConfigureForm extends Form { } /** - * Set the JID's in the whitelist of users that can associate child nodes with the collection + * Set the JID's in the whitelist of users that can associate child nodes with the collection * node. This is only relevant if {@link #getChildrenAssociationPolicy()} is set to * {@link ChildrenAssociationPolicy#whitelist}. - * + * * @param whitelist The list of JID's */ public void setChildrenAssociationWhitelist(List whitelist) { @@ -181,7 +181,7 @@ public class ConfigureForm extends Form { /** * Gets the maximum number of child nodes that can be associated with the collection node. - * + * * @return The maximum number of child nodes */ public int getChildrenMax() { @@ -190,7 +190,7 @@ public class ConfigureForm extends Form { /** * Set the maximum number of child nodes that can be associated with a collection node. - * + * * @param max The maximum number of child nodes. */ public void setChildrenMax(int max) { @@ -200,7 +200,7 @@ public class ConfigureForm extends Form { /** * Gets the collection node which the node is affiliated with. - * + * * @return The collection node id */ public String getCollection() { @@ -209,7 +209,7 @@ public class ConfigureForm extends Form { /** * Sets the collection node which the node is affiliated with. - * + * * @param collection The node id of the collection node */ public void setCollection(String collection) { @@ -221,7 +221,7 @@ public class ConfigureForm extends Form { * Gets the URL of an XSL transformation which can be applied to the payload * format in order to generate a valid Data Forms result that the client could * display using a generic Data Forms rendering engine. - * + * * @return The URL of an XSL transformation */ public String getDataformXSLT() { @@ -232,7 +232,7 @@ public class ConfigureForm extends Form { * Sets the URL of an XSL transformation which can be applied to the payload * format in order to generate a valid Data Forms result that the client could * display using a generic Data Forms rendering engine. - * + * * @param url The URL of an XSL transformation */ public void setDataformXSLT(String url) { @@ -242,7 +242,7 @@ public class ConfigureForm extends Form { /** * Does the node deliver payloads with event notifications. - * + * * @return true if it does, false otherwise */ public boolean isDeliverPayloads() { @@ -251,7 +251,7 @@ public class ConfigureForm extends Form { /** * Sets whether the node will deliver payloads with event notifications. - * + * * @param deliver true if the payload will be delivered, false otherwise */ public void setDeliverPayloads(boolean deliver) { @@ -261,7 +261,7 @@ public class ConfigureForm extends Form { /** * Determines who should get replies to items. - * + * * @return Who should get the reply */ public ItemReply getItemReply() { @@ -275,7 +275,7 @@ public class ConfigureForm extends Form { /** * Sets who should get the replies to items. - * + * * @param reply Defines who should get the reply */ public void setItemReply(ItemReply reply) { @@ -286,7 +286,7 @@ public class ConfigureForm extends Form { /** * Gets the maximum number of items to persisted to this node if {@link #isPersistItems()} is * true. - * + * * @return The maximum number of items to persist */ public int getMaxItems() { @@ -296,7 +296,7 @@ public class ConfigureForm extends Form { /** * Set the maximum number of items to persisted to this node if {@link #isPersistItems()} is * true. - * + * * @param max The maximum number of items to persist */ public void setMaxItems(int max) { @@ -306,7 +306,7 @@ public class ConfigureForm extends Form { /** * Gets the maximum payload size in bytes. - * + * * @return The maximum payload size */ public int getMaxPayloadSize() { @@ -315,7 +315,7 @@ public class ConfigureForm extends Form { /** * Sets the maximum payload size in bytes. - * + * * @param max The maximum payload size */ public void setMaxPayloadSize(int max) { @@ -325,7 +325,7 @@ public class ConfigureForm extends Form { /** * Gets the node type. - * + * * @return The node type */ public NodeType getNodeType() { @@ -339,7 +339,7 @@ public class ConfigureForm extends Form { /** * Sets the node type. - * + * * @param type The node type */ public void setNodeType(NodeType type) { @@ -349,7 +349,7 @@ public class ConfigureForm extends Form { /** * Determines if subscribers should be notified when the configuration changes. - * + * * @return true if they should be notified, false otherwise */ public boolean isNotifyConfig() { @@ -358,7 +358,7 @@ public class ConfigureForm extends Form { /** * Sets whether subscribers should be notified when the configuration changes. - * + * * @param notify true if subscribers should be notified, false otherwise */ public void setNotifyConfig(boolean notify) { @@ -368,7 +368,7 @@ public class ConfigureForm extends Form { /** * Determines whether subscribers should be notified when the node is deleted. - * + * * @return true if subscribers should be notified, false otherwise */ public boolean isNotifyDelete() { @@ -377,7 +377,7 @@ public class ConfigureForm extends Form { /** * Sets whether subscribers should be notified when the node is deleted. - * + * * @param notify true if subscribers should be notified, false otherwise */ public void setNotifyDelete(boolean notify) { @@ -386,9 +386,9 @@ public class ConfigureForm extends Form { } /** - * Determines whether subscribers should be notified when items are deleted + * Determines whether subscribers should be notified when items are deleted * from the node. - * + * * @return true if subscribers should be notified, false otherwise */ public boolean isNotifyRetract() { @@ -396,9 +396,9 @@ public class ConfigureForm extends Form { } /** - * Sets whether subscribers should be notified when items are deleted + * Sets whether subscribers should be notified when items are deleted * from the node. - * + * * @param notify true if subscribers should be notified, false otherwise */ public void setNotifyRetract(boolean notify) { @@ -432,7 +432,7 @@ public class ConfigureForm extends Form { /** * Determines whether items should be persisted in the node. - * + * * @return true if items are persisted */ public boolean isPersistItems() { @@ -441,7 +441,7 @@ public class ConfigureForm extends Form { /** * Sets whether items should be persisted in the node. - * + * * @param persist true if items should be persisted, false otherwise */ public void setPersistentItems(boolean persist) { @@ -451,7 +451,7 @@ public class ConfigureForm extends Form { /** * Determines whether to deliver notifications to available users only. - * + * * @return true if users must be available */ public boolean isPresenceBasedDelivery() { @@ -460,7 +460,7 @@ public class ConfigureForm extends Form { /** * Sets whether to deliver notifications to available users only. - * + * * @param presenceBased true if user must be available, false otherwise */ public void setPresenceBasedDelivery(boolean presenceBased) { @@ -470,7 +470,7 @@ public class ConfigureForm extends Form { /** * Gets the publishing model for the node, which determines who may publish to it. - * + * * @return The publishing model */ public PublishModel getPublishModel() { @@ -484,7 +484,7 @@ public class ConfigureForm extends Form { /** * Sets the publishing model for the node, which determines who may publish to it. - * + * * @param publish The enum representing the possible options for the publishing model */ public void setPublishModel(PublishModel publish) { @@ -494,7 +494,7 @@ public class ConfigureForm extends Form { /** * List of the multi user chat rooms that are specified as reply rooms. - * + * * @return The reply room JID's */ public List getReplyRoom() { @@ -503,7 +503,7 @@ public class ConfigureForm extends Form { /** * Sets the multi user chat rooms that are specified as reply rooms. - * + * * @param replyRooms The multi user chat room to use as reply rooms */ public void setReplyRoom(List replyRooms) { @@ -513,7 +513,7 @@ public class ConfigureForm extends Form { /** * Gets the specific JID's for reply to. - * + * * @return The JID's */ public List getReplyTo() { @@ -522,7 +522,7 @@ public class ConfigureForm extends Form { /** * Sets the specific JID's for reply to. - * + * * @param replyTos The JID's to reply to */ public void setReplyTo(List replyTos) { @@ -532,7 +532,7 @@ public class ConfigureForm extends Form { /** * Gets the roster groups that are allowed to subscribe and retrieve items. - * + * * @return The roster groups */ public List getRosterGroupsAllowed() { @@ -541,7 +541,7 @@ public class ConfigureForm extends Form { /** * Sets the roster groups that are allowed to subscribe and retrieve items. - * + * * @param groups The roster groups */ public void setRosterGroupsAllowed(List groups) { @@ -551,7 +551,7 @@ public class ConfigureForm extends Form { /** * Determines if subscriptions are allowed. - * + * * @return true if subscriptions are allowed, false otherwise * @deprecated use {@link #isSubscribe()} instead */ @@ -562,7 +562,7 @@ public class ConfigureForm extends Form { /** * Determines if subscriptions are allowed. - * + * * @return true if subscriptions are allowed, false otherwise */ public boolean isSubscribe() { @@ -571,7 +571,7 @@ public class ConfigureForm extends Form { /** * Sets whether subscriptions are allowed. - * + * * @param subscribe true if they are, false otherwise */ public void setSubscribe(boolean subscribe) { @@ -581,7 +581,7 @@ public class ConfigureForm extends Form { /** * Gets the human readable node title. - * + * * @return The node title */ @Override @@ -591,7 +591,7 @@ public class ConfigureForm extends Form { /** * Sets a human readable title for the node. - * + * * @param title The node title */ @Override @@ -602,7 +602,7 @@ public class ConfigureForm extends Form { /** * The type of node data, usually specified by the namespace of the payload (if any). - * + * * @return The type of node data */ public String getDataType() { @@ -611,7 +611,7 @@ public class ConfigureForm extends Form { /** * Sets the type of node data, usually specified by the namespace of the payload (if any). - * + * * @param type The type of node data */ public void setDataType(String type) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java index 8e0573fc1..c828f061b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java @@ -24,39 +24,39 @@ import org.jivesoftware.smackx.xdata.Form; * This enumeration represents all the fields of a node configuration form. This enumeration * is not required when using the {@link ConfigureForm} to configure nodes, but may be helpful * for generic UI's using only a {@link Form} for configuration. - * + * * @author Robin Collier */ public enum ConfigureNodeFields { /** * Determines who may subscribe and retrieve items. - * + * *

    Value: {@link AccessModel}

    */ access_model, /** - * The URL of an XSL transformation which can be applied to + * The URL of an XSL transformation which can be applied to * payloads in order to generate an appropriate message * body element. - * + * *

    Value: {@link URL}

    */ body_xslt, /** * The collection with which a node is affiliated. - * + * *

    Value: String

    */ collection, /** - * The URL of an XSL transformation which can be applied to - * payload format in order to generate a valid Data Forms result - * that the client could display using a generic Data Forms + * The URL of an XSL transformation which can be applied to + * payload format in order to generate a valid Data Forms result + * that the client could display using a generic Data Forms * rendering engine body element. - * + * *

    Value: {@link URL}

    */ dataform_xslt, @@ -77,72 +77,72 @@ public enum ConfigureNodeFields { /** * Who may associate leaf nodes with a collection. - * + * *

    Value: {@link ChildrenAssociationPolicy}

    */ children_association_policy, /** - * The list of JIDs that may associate leaf nodes with a + * The list of JIDs that may associate leaf nodes with a * collection. - * + * *

    Value: List of JIDs as Strings

    */ children_association_whitelist, /** * The child nodes (leaf or collection) associated with a collection. - * + * *

    Value: List of Strings

    */ children, /** - * The maximum number of child nodes that can be associated with a + * The maximum number of child nodes that can be associated with a * collection. - * + * *

    Value: int

    */ children_max, /** * The maximum number of items to persist. - * + * *

    Value: int

    */ max_items, /** * The maximum payload size in bytes. - * + * *

    Value: int

    */ max_payload_size, /** * Whether the node is a leaf (default) or collection. - * + * *

    Value: {@link NodeType}

    */ node_type, /** * Whether to notify subscribers when the node configuration changes. - * + * *

    Value: boolean

    */ notify_config, /** * Whether to notify subscribers when the node is deleted. - * + * *

    Value: boolean

    */ notify_delete, /** * Whether to notify subscribers when items are removed from the node. - * + * *

    Value: boolean

    */ notify_retract, @@ -155,67 +155,67 @@ public enum ConfigureNodeFields { notification_type, /** - * Whether to persist items to storage. This is required to have. multiple - * items in the node. - * + * Whether to persist items to storage. This is required to have. multiple + * items in the node. + * *

    Value: boolean

    */ persist_items, /** * Whether to deliver notifications to available users only. - * + * *

    Value: boolean

    */ presence_based_delivery, /** * Defines who can publish to the node. - * + * *

    Value: {@link PublishModel}

    */ publish_model, /** * The specific multi-user chat rooms to specify for replyroom. - * + * *

    Value: List of JIDs as Strings

    */ replyroom, /** * The specific JID(s) to specify for replyto. - * + * *

    Value: List of JIDs as Strings

    */ replyto, /** * The roster group(s) allowed to subscribe and retrieve items. - * + * *

    Value: List of strings

    */ roster_groups_allowed, /** * Whether to allow subscriptions. - * + * *

    Value: boolean

    */ subscribe, /** * A friendly name for the node. - * + * *

    Value: String

    */ title, /** * The type of node data, usually specified by the namespace - * of the payload(if any);MAY be a list-single rather than a + * of the payload(if any);MAY be a list-single rather than a * text single. - * + * *

    Value: String

    */ type; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EmbeddedPacketExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EmbeddedPacketExtension.java index efc4a7c38..ef3d52ec7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EmbeddedPacketExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EmbeddedPacketExtension.java @@ -24,23 +24,23 @@ import org.jivesoftware.smack.util.PacketParserUtils; /** * This interface defines {@link ExtensionElement} implementations that contain other - * extensions. This effectively extends the idea of an extension within one of the + * extensions. This effectively extends the idea of an extension within one of the * top level {@link Stanza} types to consider any embedded element to be an extension * of its parent. This more easily enables the usage of some of Smacks parsing * utilities such as {@link PacketParserUtils#parseExtensionElement(String, String, org.xmlpull.v1.XmlPullParser)} to be used * to parse any element of the XML being parsed. - * + * *

    Top level extensions have only one element, but they can have multiple children, or - * their children can have multiple children. This interface is a way of allowing extensions - * to be embedded within one another as a partial or complete one to one mapping of extension + * their children can have multiple children. This interface is a way of allowing extensions + * to be embedded within one another as a partial or complete one to one mapping of extension * to element. - * + * * @author Robin Collier */ public interface EmbeddedPacketExtension extends ExtensionElement { /** * Get the list of embedded {@link ExtensionElement} objects. - * + * * @return List of embedded {@link ExtensionElement} */ List getExtensions(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElement.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElement.java index 8cd1f7c82..48449db56 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElement.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElement.java @@ -27,10 +27,10 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; /** * Represents the top level element of a PubSub event extension. All types of PubSub events are - * represented by this class. The specific type can be found by {@link #getEventType()}. The + * represented by this class. The specific type can be found by {@link #getEventType()}. The * embedded event information, which is specific to the event type, can be retrieved by the {@link #getEvent()} * method. - * + * * @author Robin Collier */ public class EventElement implements EmbeddedPacketExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java index 1c00797c7..2d2637f17 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; /** * This enumeration defines the possible event types that are supported within PubSub * event messages. - * + * * @author Robin Collier */ public enum EventElementType { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java index bff5956be..91db0fa56 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java @@ -21,9 +21,9 @@ import org.jivesoftware.smackx.xdata.Form; /** * Generic stanza extension which represents any PubSub form that is * parsed from the incoming stream or being sent out to the server. - * + * * Form types are defined in {@link FormNodeType}. - * + * * @author Robin Collier */ public class FormNode extends NodeExtension { @@ -31,7 +31,7 @@ public class FormNode extends NodeExtension { /** * Create a {@link FormNode} which contains the specified form. - * + * * @param formType The type of form being sent * @param submitForm The form */ @@ -44,9 +44,9 @@ public class FormNode extends NodeExtension { } /** - * Create a {@link FormNode} which contains the specified form, which is + * Create a {@link FormNode} which contains the specified form, which is * associated with the specified node. - * + * * @param formType The type of form being sent * @param nodeId The node the form is associated with * @param submitForm The form @@ -61,7 +61,7 @@ public class FormNode extends NodeExtension { /** * Get the Form that is to be sent, or was retrieved from the server. - * + * * @return The form */ public Form getForm() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java index a4e3f9bb9..262fca021 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java @@ -22,7 +22,7 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; /** * The types of forms supported by the PubSub specification. - * + * * @author Robin Collier */ public enum FormNodeType { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/GetItemsRequest.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/GetItemsRequest.java index 5c55d844d..a6b274f93 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/GetItemsRequest.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/GetItemsRequest.java @@ -20,7 +20,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Represents a request to subscribe to a node. - * + * * @author Robin Collier */ public class GetItemsRequest extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java index af87f1e49..c9e12df7a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java @@ -25,29 +25,29 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider; * This class represents an item that has been, or will be published to a * PubSub node. An Item has several properties that are dependent * on the configuration of the node to which it has been or will be published. - * + * *

    An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}

    *
      *
    • Will always have an id (either user or server generated) unless node configuration has both * {@link ConfigureForm#isPersistItems()} and {@link ConfigureForm#isDeliverPayloads()}set to false. - *
    • Will have a payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set + *
    • Will have a payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set * to true, otherwise it will be null. *
    - * + * *

    An Item created to send to a node (via {@link LeafNode#publish()} or {@link LeafNode#publish()}

    *
      - *
    • The id is optional, since the server will generate one if necessary, but should be used if it is + *
    • The id is optional, since the server will generate one if necessary, but should be used if it is * meaningful in the context of the node. This value must be unique within the node that it is sent to, since * resending an item with the same id will overwrite the one that already exists if the items are persisted. *
    • Will require payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set * to true. *
    - * + * *

    * To customise the payload object being returned from the {@link PayloadItem#getPayload()} method, you can * add a custom parser as explained in {@link ItemProvider}. *

    - * + * * @author Robin Collier */ public class Item extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java index 8634c7b55..ada69c2bd 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java @@ -21,7 +21,7 @@ import java.util.List; /** * Represents an event in which items have been deleted from the node. - * + * * @author Robin Collier */ public class ItemDeleteEvent extends SubscriptionEvent { @@ -30,9 +30,9 @@ public class ItemDeleteEvent extends SubscriptionEvent { /** * Constructs an ItemDeleteEvent that indicates the the supplied * items (by id) have been deleted, and that the event matches the listed - * subscriptions. The subscriptions would have been created by calling + * subscriptions. The subscriptions would have been created by calling * {@link LeafNode#subscribe(String)}. - * + * * @param nodeId The id of the node the event came from * @param deletedItemIds The item ids of the items that were deleted. * @param subscriptionIds The subscriptions that match the event. @@ -47,7 +47,7 @@ public class ItemDeleteEvent extends SubscriptionEvent { /** * Get the item id's of the items that have been deleted. - * + * * @return List of item id's */ public List getItemIds() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java index 454cef3f7..a61e36324 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java @@ -22,7 +22,7 @@ import java.util.List; /** * Represents an event generated by an item(s) being published to a node. - * + * * @author Robin Collier */ public class ItemPublishEvent extends SubscriptionEvent { @@ -32,9 +32,9 @@ public class ItemPublishEvent extends SubscriptionEvent { /** * Constructs an ItemPublishEvent with the provided list * of {@link Item} that were published. - * + * * @param nodeId The id of the node the event came from - * @param eventItems The list of {@link Item} that were published + * @param eventItems The list of {@link Item} that were published */ public ItemPublishEvent(String nodeId, List eventItems) { super(nodeId); @@ -44,11 +44,11 @@ public class ItemPublishEvent extends SubscriptionEvent { /** * Constructs an ItemPublishEvent with the provided list * of {@link Item} that were published. The list of subscription ids - * represents the subscriptions that matched the event, in the case + * represents the subscriptions that matched the event, in the case * of the user having multiple subscriptions. - * + * * @param nodeId The id of the node the event came from - * @param eventItems The list of {@link Item} that were published + * @param eventItems The list of {@link Item} that were published * @param subscriptionIds The list of subscriptionIds */ public ItemPublishEvent(String nodeId, List eventItems, List subscriptionIds) { @@ -60,11 +60,11 @@ public class ItemPublishEvent extends SubscriptionEvent { * Constructs an ItemPublishEvent with the provided list * of {@link Item} that were published in the past. The published * date signifies that this is delayed event. The list of subscription ids - * represents the subscriptions that matched the event, in the case - * of the user having multiple subscriptions. + * represents the subscriptions that matched the event, in the case + * of the user having multiple subscriptions. * * @param nodeId The id of the node the event came from - * @param eventItems The list of {@link Item} that were published + * @param eventItems The list of {@link Item} that were published * @param subscriptionIds The list of subscriptionIds * @param publishedDate date of publication. */ @@ -78,7 +78,7 @@ public class ItemPublishEvent extends SubscriptionEvent { /** * Get the list of {@link Item} that were published. - * + * * @return The list of published {@link Item} */ public List getItems() { @@ -87,12 +87,12 @@ public class ItemPublishEvent extends SubscriptionEvent { /** * Indicates whether this event was delayed. That is, the items - * were published to the node at some time in the past. This will + * were published to the node at some time in the past. This will * typically happen if there is an item already published to the node - * before a user subscribes to it. In this case, when the user + * before a user subscribes to it. In this case, when the user * subscribes, the server may send the last item published to the node * with a delay date showing its time of original publication. - * + * * @return true if the items are delayed, false otherwise. */ public boolean isDelayed() { @@ -100,7 +100,7 @@ public class ItemPublishEvent extends SubscriptionEvent { } /** - * Gets the original date the items were published. This is only + * Gets the original date the items were published. This is only * valid if {@link #isDelayed()} is true. * * @return date of publication. @@ -111,7 +111,7 @@ public class ItemPublishEvent extends SubscriptionEvent { @Override public String toString() { - return getClass().getName() + " [subscriptions: " + getSubscriptions() + "], [Delayed: " + + return getClass().getName() + " [subscriptions: " + getSubscriptions() + "], [Delayed: " + (isDelayed() ? originalDate.toString() : "false") + ']'; } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java index 1c4e01c8e..67051349d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; /** * These are the options for the node configuration setting {@link ConfigureForm#setItemReply(ItemReply)}, * which defines who should receive replies to items. - * + * * @author Robin Collier */ public enum ItemReply { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java index b6a6ee98d..b545cbb14 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java @@ -29,10 +29,10 @@ import org.jivesoftware.smack.packet.NamedElement; *
  • It can represent a request to delete a list of items. *
  • It can represent a request to get existing items. * - * - *

    Please note, this class is used for internal purposes, and is not required for usage of + * + *

    Please note, this class is used for internal purposes, and is not required for usage of * pubsub functionality.

    - * + * * @author Robin Collier */ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExtension { @@ -66,19 +66,19 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Construct an instance with a list representing items that have been published or deleted. - * + * *

    Valid scenarios are:

    *
      *
    • Request items from node - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and an * optional value for the max_items attribute. *
    • Request to delete items - itemsType = {@link ItemsElementType#retract}, items = list of {@link Item} containing * only id's and an optional value for the notify attribute. - *
    • Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and + *
    • Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and + * attributeValue = null + *
    • Items deleted event - itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and * attributeValue = null - *
    • Items deleted event - itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and - * attributeValue = null *
    - * + * * @param itemsType Type of representation * @param nodeId The node to which the items are being sent or deleted * @param items The list of {@link Item} or {@link RetractItem} @@ -91,19 +91,19 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Construct an instance with a list representing items that have been published or deleted. - * + * *

    Valid scenarios are:

    *
      *
    • Request items from node - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and an * optional value for the max_items attribute. *
    • Request to delete items - itemsType = {@link ItemsElementType#retract}, items = list of {@link Item} containing * only id's and an optional value for the notify attribute. - *
    • Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and + *
    • Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and * attributeValue = null - *
    • Items deleted event - itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and + *
    • Items deleted event - itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and * attributeValue = null *
    - * + * * @param nodeId The node to which the items are being sent or deleted * @param items The list of {@link Item} or {@link RetractItem} * @param notify @@ -111,13 +111,13 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten public ItemsExtension(String nodeId, List items, boolean notify) { super(ItemsElementType.retract.getNodeElement(), nodeId); type = ItemsElementType.retract; - this.items = items; + this.items = items; this.notify = notify; } /** * Get the type of element. - * + * * @return The element type */ public ItemsElementType getItemsElementType() { @@ -132,7 +132,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Gets the items related to the type of request or event. - * + * * @return List of {@link Item}, {@link RetractItem}, or null */ public List getItems() { @@ -141,7 +141,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Gets the value of the optional attribute related to the {@link ItemsElementType}. - * + * * @return The attribute value */ public boolean getNotify() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java index 1bd204970..22b4701dc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java @@ -34,7 +34,7 @@ import org.jivesoftware.smackx.pubsub.packet.PubSub; * almost all PubSub capabilities are related to the concept of a node. * All items are published to a node, and typically subscribed to by other * users. These users then retrieve events based on this subscription. - * + * * @author Robin Collier */ public class LeafNode extends Node { @@ -45,12 +45,12 @@ public class LeafNode extends Node { /** * Get information on the items in the node in standard * {@link DiscoverItems} format. - * + * * @return The item details in {@link DiscoverItems} format - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverItems discoverItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { DiscoverItems items = new DiscoverItems(); @@ -66,8 +66,8 @@ public class LeafNode extends Node { * @return List of {@link Item} in the node * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getItems((List) null, null); @@ -75,18 +75,18 @@ public class LeafNode extends Node { /** * Get the current items stored in the node based - * on the subscription associated with the provided + * on the subscription associated with the provided * subscription id. - * - * @param subscriptionId - The subscription id for the + * + * @param subscriptionId - The subscription id for the * associated subscription. * @param type of the items. * * @return List of {@link Item} in the node * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getItems(String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), subscriptionId)); @@ -95,19 +95,19 @@ public class LeafNode extends Node { /** * Get the items specified from the node. This would typically be - * used when the server does not return the payload due to size - * constraints. The user would be required to retrieve the payload + * used when the server does not return the payload due to size + * constraints. The user would be required to retrieve the payload * after the items have been retrieved via {@link #getItems()} or an * event, that did not include the payload. - * + * * @param ids Item ids of the items to retrieve * @param type of the items. * * @return The list of {@link Item} with payload - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getItems(Collection ids) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { List itemList = new ArrayList<>(ids.size()); @@ -121,15 +121,15 @@ public class LeafNode extends Node { /** * Get items persisted on the node, limited to the specified number. - * + * * @param maxItems Maximum number of items to return * @param type of the items. * * @return List of {@link Item} * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getItems(int maxItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), maxItems)); @@ -139,18 +139,18 @@ public class LeafNode extends Node { /** * Get items persisted on the node, limited to the specified number * based on the subscription associated with the provided subscriptionId. - * + * * @param maxItems Maximum number of items to return * @param subscriptionId The subscription which the retrieval is based * on. - * + * * @return List of {@link Item} * @param type of the items. * * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public List getItems(int maxItems, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), subscriptionId, maxItems)); @@ -163,7 +163,7 @@ public class LeafNode extends Node { * {@code additionalExtensions} can be used e.g. to add a "Result Set Management" extension. * {@code returnedExtensions} will be filled with the stanza extensions found in the answer. *

    - * + * * @param additionalExtensions additional {@code PacketExtensions} to be added to the request. * This is an optional argument, if provided as null no extensions will be added. * @param returnedExtensions a collection that will be filled with the returned packet @@ -174,7 +174,7 @@ public class LeafNode extends Node { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getItems(List additionalExtensions, List returnedExtensions) throws NoResponseException, @@ -204,12 +204,12 @@ public class LeafNode extends Node { /** * Publishes an event to the node. This is an empty event * with no item. - * + * * This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false * and {@link ConfigureForm#isDeliverPayloads()}=false. - * - * @throws NotConnectedException - * @throws InterruptedException + * + * @throws NotConnectedException + * @throws InterruptedException * @throws XMPPErrorException * @throws NoResponseException * @deprecated use {@link #publish()} instead. @@ -222,16 +222,16 @@ public class LeafNode extends Node { /** * Publishes an event to the node. This is a simple item * with no payload. - * + * * If the id is null, an empty item (one without an id) will be sent. * Please note that this is not the same as {@link #send()}, which * publishes an event with NO item. - * + * * @param item - The item being sent * @param type of the items. * - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @throws XMPPErrorException * @throws NoResponseException * @deprecated use {@link #publish(Item)} instead. @@ -244,15 +244,15 @@ public class LeafNode extends Node { /** * Publishes multiple events to the node. Same rules apply as in {@link #publish(Item)}. - * + * * In addition, if {@link ConfigureForm#isPersistItems()}=false, only the last item in the input * list will get stored on the node, assuming it stores the last sent item. - * + * * @param items - The collection of items being sent * @param type of the items. * - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @throws XMPPErrorException * @throws NoResponseException * @deprecated use {@link #publish(Collection)} instead. @@ -265,15 +265,15 @@ public class LeafNode extends Node { /** * Publishes an event to the node. This is an empty event * with no item. - * + * * This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false * and {@link ConfigureForm#isDeliverPayloads()}=false. - * - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public void publish() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub packet = createPubsubPacket(Type.set, new NodeExtension(PubSubElementType.PUBLISH, getId())); @@ -285,22 +285,22 @@ public class LeafNode extends Node { * Publishes an event to the node. This can be either a simple item * with no payload, or one with it. This is determined by the Node * configuration. - * + * * If the node has deliver_payload=false, the Item must not * have a payload. - * + * * If the id is null, an empty item (one without an id) will be sent. * Please note that this is not the same as {@link #send()}, which * publishes an event with NO item. - * + * * @param item - The item being sent * @param type of the items. * - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ @SuppressWarnings("unchecked") public void publish(T item) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -311,18 +311,18 @@ public class LeafNode extends Node { /** * Publishes multiple events to the node. Same rules apply as in {@link #send(Item)}. - * + * * In addition, if {@link ConfigureForm#isPersistItems()}=false, only the last item in the input * list will get stored on the node, assuming it stores the last sent item. - * + * * @param items - The collection of {@link Item} objects being sent * @param type of the items. * - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public void publish(Collection items) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub packet = createPubsubPacket(Type.set, new PublishItem<>(getId(), items)); @@ -332,13 +332,13 @@ public class LeafNode extends Node { /** * Purges the node of all items. - * + * *

    Note: Some implementations may keep the last item * sent. - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteAllItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = createPubsubPacket(Type.set, new NodeExtension(PubSubElementType.PURGE_OWNER, getId())); @@ -348,12 +348,12 @@ public class LeafNode extends Node { /** * Delete the item with the specified id from the node. - * + * * @param itemId The id of the item - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteItem(String itemId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Collection items = new ArrayList<>(1); @@ -363,12 +363,12 @@ public class LeafNode extends Node { /** * Delete the items with the specified id's from the node. - * + * * @param itemIds The list of id's of items to delete * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteItem(Collection itemIds) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { List items = new ArrayList<>(itemIds.size()); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java index 3d35e5d25..879abb640 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java @@ -55,9 +55,9 @@ public abstract class Node { protected ConcurrentHashMap configEventToListenerMap = new ConcurrentHashMap<>(); /** - * Construct a node associated to the supplied connection with the specified + * Construct a node associated to the supplied connection with the specified * node id. - * + * * @param pubSubManager The PubSubManager for the connection the node is associated with * @param nodeId The node id */ @@ -68,7 +68,7 @@ public abstract class Node { /** * Get the NodeId. - * + * * @return the node id */ public String getId() { @@ -77,12 +77,12 @@ public abstract class Node { /** * Returns a configuration form, from which you can create an answer form to be submitted * via the {@link #sendConfigurationForm(Form)}. - * + * * @return the configuration form - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public ConfigureForm getNodeConfiguration() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub pubSub = createPubsubPacket(Type.get, new NodeExtension( @@ -93,12 +93,12 @@ public abstract class Node { /** * Update the configuration with the contents of the new {@link Form}. - * + * * @param submitForm - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendConfigurationForm(Form submitForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub packet = createPubsubPacket(Type.set, new FormNode(FormNodeType.CONFIGURE_OWNER, @@ -108,12 +108,12 @@ public abstract class Node { /** * Discover node information in standard {@link DiscoverInfo} format. - * + * * @return The discovery information about the node. - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverInfo discoverInfo() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { DiscoverInfo info = new DiscoverInfo(); @@ -124,13 +124,13 @@ public abstract class Node { /** * Get the subscriptions currently associated with this node. - * + * * @return List of {@link Subscription} - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public List getSubscriptions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getSubscriptions(null, null); @@ -150,7 +150,7 @@ public abstract class Node { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getSubscriptions(List additionalExtensions, Collection returnedExtensions) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -164,7 +164,7 @@ public abstract class Node { * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @see #getSubscriptionsAsOwner(List, Collection) * @since 4.1 */ @@ -191,7 +191,7 @@ public abstract class Node { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @see XEP-60 § 8.8.1 - * Retrieve Subscriptions List * @since 4.1 @@ -252,7 +252,7 @@ public abstract class Node { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getAffiliations() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -273,7 +273,7 @@ public abstract class Node { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException */ public List getAffiliations(List additionalExtensions, Collection returnedExtensions) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { @@ -346,7 +346,7 @@ public abstract class Node { *

    * Note that this is an optional PubSub feature ('pubsub#modify-affiliations'). *

    - * + * * @param affiliations * @return null or a PubSub stanza with additional information on success. * @throws NoResponseException @@ -371,20 +371,20 @@ public abstract class Node { /** * The user subscribes to the node using the supplied jid. The * bare jid portion of this one must match the jid for the connection. - * - * Please note that the {@link Subscription.State} should be checked + * + * Please note that the {@link Subscription.State} should be checked * on return since more actions may be required by the caller. - * {@link Subscription.State#pending} - The owner must approve the subscription + * {@link Subscription.State#pending} - The owner must approve the subscription * request before messages will be received. - * {@link Subscription.State#unconfigured} - If the {@link Subscription#isConfigRequired()} is true, + * {@link Subscription.State#unconfigured} - If the {@link Subscription#isConfigRequired()} is true, * the caller must configure the subscription before messages will be received. If it is false * the caller can configure it but is not required to do so. * @param jid The jid to subscribe as. * @return The subscription - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Subscription subscribe(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub pubSub = createPubsubPacket(Type.set, new SubscribeExtension(jid, getId())); @@ -394,14 +394,14 @@ public abstract class Node { /** * The user subscribes to the node using the supplied jid and subscription - * options. The bare jid portion of this one must match the jid for the + * options. The bare jid portion of this one must match the jid for the * connection. - * - * Please note that the {@link Subscription.State} should be checked + * + * Please note that the {@link Subscription.State} should be checked * on return since more actions may be required by the caller. - * {@link Subscription.State#pending} - The owner must approve the subscription + * {@link Subscription.State#pending} - The owner must approve the subscription * request before messages will be received. - * {@link Subscription.State#unconfigured} - If the {@link Subscription#isConfigRequired()} is true, + * {@link Subscription.State#unconfigured} - If the {@link Subscription#isConfigRequired()} is true, * the caller must configure the subscription before messages will be received. If it is false * the caller can configure it but is not required to do so. * @@ -409,10 +409,10 @@ public abstract class Node { * @param subForm * * @return The subscription - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Subscription subscribe(String jid, SubscribeForm subForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = createPubsubPacket(Type.set, new SubscribeExtension(jid, getId())); @@ -422,16 +422,16 @@ public abstract class Node { } /** - * Remove the subscription related to the specified JID. This will only + * Remove the subscription related to the specified JID. This will only * work if there is only 1 subscription. If there are multiple subscriptions, * use {@link #unsubscribe(String, String)}. - * + * * @param jid The JID used to subscribe to the node - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public void unsubscribe(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { unsubscribe(jid, null); @@ -439,13 +439,13 @@ public abstract class Node { /** * Remove the specific subscription related to the specified JID. - * + * * @param jid The JID used to subscribe to the node * @param subscriptionId The id of the subscription being removed - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void unsubscribe(String jid, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { sendPubsubPacket(createPubsubPacket(Type.set, new UnsubscribeExtension(jid, getId(), subscriptionId))); @@ -458,10 +458,10 @@ public abstract class Node { * @param jid * * @return A subscription options form - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public SubscribeForm getSubscriptionOptions(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return getSubscriptionOptions(jid, null); @@ -470,16 +470,16 @@ public abstract class Node { /** * Get the options for configuring the specified subscription. - * + * * @param jid JID the subscription is registered under * @param subscriptionId The subscription id - * + * * @return The subscription option form - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public SubscribeForm getSubscriptionOptions(String jid, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub packet = sendPubsubPacket(createPubsubPacket(Type.get, new OptionsExtension(jid, getId(), subscriptionId))); @@ -488,22 +488,22 @@ public abstract class Node { } /** - * Register a listener for item publication events. This - * listener will get called whenever an item is published to + * Register a listener for item publication events. This + * listener will get called whenever an item is published to * this node. - * + * * @param listener The handler for the event */ @SuppressWarnings("unchecked") public void addItemEventListener(@SuppressWarnings("rawtypes") ItemEventListener listener) { - StanzaListener conListener = new ItemEventTranslator(listener); + StanzaListener conListener = new ItemEventTranslator(listener); itemEventToListenerMap.put(listener, conListener); pubSubManager.getConnection().addSyncStanzaListener(conListener, new EventContentFilter(EventElementType.items.toString(), "item")); } /** * Unregister a listener for publication events. - * + * * @param listener The handler to unregister */ public void removeItemEventListener(@SuppressWarnings("rawtypes") ItemEventListener listener) { @@ -516,18 +516,18 @@ public abstract class Node { /** * Register a listener for configuration events. This listener * will get called whenever the node's configuration changes. - * + * * @param listener The handler for the event */ public void addConfigurationListener(NodeConfigListener listener) { - StanzaListener conListener = new NodeConfigTranslator(listener); + StanzaListener conListener = new NodeConfigTranslator(listener); configEventToListenerMap.put(listener, conListener); pubSubManager.getConnection().addSyncStanzaListener(conListener, new EventContentFilter(EventElementType.configuration.toString())); } /** * Unregister a listener for configuration events. - * + * * @param listener The handler to unregister */ public void removeConfigurationListener(NodeConfigListener listener) { @@ -540,11 +540,11 @@ public abstract class Node { /** * Register an listener for item delete events. This listener * gets called whenever an item is deleted from the node. - * + * * @param listener The handler for the event */ public void addItemDeleteListener(ItemDeleteListener listener) { - StanzaListener delListener = new ItemDeleteTranslator(listener); + StanzaListener delListener = new ItemDeleteTranslator(listener); itemDeleteToListenerMap.put(listener, delListener); EventContentFilter deleteItem = new EventContentFilter(EventElementType.items.toString(), "retract"); EventContentFilter purge = new EventContentFilter(EventElementType.purge.toString()); @@ -555,7 +555,7 @@ public abstract class Node { /** * Unregister a listener for item delete events. - * + * * @param listener The handler to unregister */ public void removeItemDeleteListener(ItemDeleteListener listener) { @@ -594,9 +594,9 @@ public abstract class Node { } /** - * This class translates low level item publication events into api level objects for + * This class translates low level item publication events into api level objects for * user consumption. - * + * * @author Robin Collier */ public static class ItemEventTranslator implements StanzaListener { @@ -619,9 +619,9 @@ public abstract class Node { } /** - * This class translates low level item deletion events into api level objects for + * This class translates low level item deletion events into api level objects for * user consumption. - * + * * @author Robin Collier */ public static class ItemDeleteTranslator implements StanzaListener { @@ -659,9 +659,9 @@ public abstract class Node { } /** - * This class translates low level node configuration events into api level objects for + * This class translates low level node configuration events into api level objects for * user consumption. - * + * * @author Robin Collier */ public static class NodeConfigTranslator implements StanzaListener { @@ -682,9 +682,9 @@ public abstract class Node { } /** - * Filter for {@link StanzaListener} to filter out events not specific to the + * Filter for {@link StanzaListener} to filter out events not specific to the * event type expected for this node. - * + * * @author Robin Collier */ class EventContentFilter extends FlexibleStanzaTypeFilter { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java index 619bfa8f6..23783e317 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java @@ -22,10 +22,10 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; /** * A class which represents a common element within the pubsub defined - * schemas. One which has a node as an attribute. This class is - * used on its own as well as a base class for many others, since the + * schemas. One which has a node as an attribute. This class is + * used on its own as well as a base class for many others, since the * node is a central concept to most pubsub functionality. - * + * * @author Robin Collier */ public class NodeExtension implements ExtensionElement { @@ -35,7 +35,7 @@ public class NodeExtension implements ExtensionElement { /** * Constructs a NodeExtension with an element name specified * by {@link PubSubElementType} and the specified node id. - * + * * @param elem Defines the element name and namespace * @param nodeId Specifies the id of the node */ @@ -47,7 +47,7 @@ public class NodeExtension implements ExtensionElement { /** * Constructs a NodeExtension with an element name specified * by {@link PubSubElementType}. - * + * * @param elem Defines the element name and namespace */ public NodeExtension(PubSubElementType elem) { @@ -56,7 +56,7 @@ public class NodeExtension implements ExtensionElement { /** * Gets the node id. - * + * * @return The node id */ public String getNode() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java index ff5f8a936..93b796b8a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java @@ -18,7 +18,7 @@ package org.jivesoftware.smackx.pubsub; /** * Defines the available types of nodes. - * + * * @author Robin Collier */ public enum NodeType { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NotificationType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NotificationType.java index ab311dd2b..812f56b21 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NotificationType.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NotificationType.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub; /** * Specify the delivery style for event notifications. Denotes possible values * for {@link ConfigureForm#setNotificationType(NotificationType)}. - * + * * @author Timothy Pitt */ public enum NotificationType { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java index 32c571b21..4ff697d6f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java @@ -19,8 +19,8 @@ package org.jivesoftware.smackx.pubsub; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * A stanza extension representing the options element. - * + * A stanza extension representing the options element. + * * @author Robin Collier */ public class OptionsExtension extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java index 12cc6fb0a..841a55868 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java @@ -26,35 +26,35 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider; * This class represents an item that has been, or will be published to a * pubsub node. An Item has several properties that are dependent * on the configuration of the node to which it has been or will be published. - * + * *

    An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}

    *
      *
    • Will always have an id (either user or server generated) unless node configuration has both * {@link ConfigureForm#isPersistItems()} and {@link ConfigureForm#isDeliverPayloads()}set to false.
      • - *
    • Will have a payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set + *
    • Will have a payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set * to true, otherwise it will be null.
      • *
    - * + * *

    An Item created to send to a node (via {@link LeafNode#publish()}

    *
      - *
    • The id is optional, since the server will generate one if necessary, but should be used if it is + *
    • The id is optional, since the server will generate one if necessary, but should be used if it is * meaningful in the context of the node. This value must be unique within the node that it is sent to, since * resending an item with the same id will overwrite the one that already exists if the items are persisted.
      • *
    • Will require payload if the node configuration has {@link ConfigureForm#isDeliverPayloads()} set * to true.
      • *
    - * + * *

    To customise the payload object being returned from the {@link #getPayload()} method, you can * add a custom parser as explained in {@link ItemProvider}.

    - * + * * @author Robin Collier */ public class PayloadItem extends Item { private final E payload; /** - * Create an Item with no id and a payload The id will be set by the server. - * + * Create an Item with no id and a payload The id will be set by the server. + * * @param payloadExt A {@link ExtensionElement} which represents the payload data. */ public PayloadItem(E payloadExt) { @@ -66,8 +66,8 @@ public class PayloadItem extends Item { } /** - * Create an Item with an id and payload. - * + * Create an Item with an id and payload. + * * @param itemId The id of this item. It can be null if we want the server to set the id. * @param payloadExt A {@link ExtensionElement} which represents the payload data. */ @@ -80,15 +80,15 @@ public class PayloadItem extends Item { } /** - * Create an Item with an id, node id and payload. - * + * Create an Item with an id, node id and payload. + * *

    - * Note: This is not valid for publishing an item to a node, only receiving from - * one as part of {@link Message}. If used to create an Item to publish + * Note: This is not valid for publishing an item to a node, only receiving from + * one as part of {@link Message}. If used to create an Item to publish * (via {@link LeafNode#publish(Item)}, the server may return an * error for an invalid packet. *

    - * + * * @param itemId The id of this item. * @param nodeId The id of the node the item was published to. * @param payloadExt A {@link ExtensionElement} which represents the payload data. @@ -122,7 +122,7 @@ public class PayloadItem extends Item { /** * Get the payload associated with this Item. Customising the payload * parsing from the server can be accomplished as described in {@link ItemProvider}. - * + * * @return The payload as a {@link ExtensionElement}. */ public E getPayload() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PresenceState.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PresenceState.java index f05e92cab..e4fee0d65 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PresenceState.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PresenceState.java @@ -16,10 +16,10 @@ */ package org.jivesoftware.smackx.pubsub; -/** +/** * Defines the possible valid presence states for node subscription via * {@link SubscribeForm#getShowValues()}. - * + * * @author Robin Collier */ public enum PresenceState { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubElementType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubElementType.java index 63a114d96..9aa1f3d5a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubElementType.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubElementType.java @@ -23,7 +23,7 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; /** * Defines all the possible element types as defined for all the pubsub * schemas in all 3 namespaces. - * + * * @author Robin Collier */ public enum PubSubElementType { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubException.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubException.java index 5deac4931..a6c4b5470 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubException.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubException.java @@ -25,7 +25,7 @@ import org.jxmpp.jid.BareJid; public abstract class PubSubException extends SmackException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -42,7 +42,7 @@ public abstract class PubSubException extends SmackException { public static class NotALeafNodeException extends PubSubException { /** - * + * */ private static final long serialVersionUID = 1L; @@ -62,7 +62,7 @@ public abstract class PubSubException extends SmackException { public static class NotAPubSubNodeException extends PubSubException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java index 89c791bce..1a1dd2783 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java @@ -58,10 +58,10 @@ import org.jxmpp.stringprep.XmppStringprepException; /** * This is the starting point for access to the pubsub service. It * will provide access to general information about the service, as - * well as create or retrieve pubsub {@link LeafNode} instances. These - * instances provide the bulk of the functionality as defined in the + * well as create or retrieve pubsub {@link LeafNode} instances. These + * instances provide the bulk of the functionality as defined in the * pubsub specification XEP-0060. - * + * * @author Robin Collier */ public final class PubSubManager extends Manager { @@ -84,7 +84,7 @@ public final class PubSubManager extends Manager { /** * Get a PubSub manager for the default PubSub service of the connection. - * + * * @param connection * @return the default PubSub manager. */ @@ -115,7 +115,7 @@ public final class PubSubManager extends Manager { /** * Get the PubSub manager for the given connection and PubSub service. - * + * * @param connection the XMPP connection. * @param pubSubService the PubSub service. * @return a PubSub manager for the connection and service. @@ -137,7 +137,7 @@ public final class PubSubManager extends Manager { /** * Create a pubsub manager associated to the specified connection where * the pubsub requests require a specific to address for packets. - * + * * @param connection The XMPP connection * @param toAddress The pubsub specific to address (required for some servers) */ @@ -148,12 +148,12 @@ public final class PubSubManager extends Manager { /** * Creates an instant node, if supported. - * + * * @return The node that was created - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public LeafNode createNode() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub reply = sendPubsubPacket(Type.set, new NodeExtension(PubSubElementType.CREATE), null); @@ -167,14 +167,14 @@ public final class PubSubManager extends Manager { /** * Creates a node with default configuration. - * - * @param nodeId The id of the node, which must be unique within the + * + * @param nodeId The id of the node, which must be unique within the * pubsub service * @return The node that was created - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public LeafNode createNode(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return (LeafNode) createNode(nodeId, null); @@ -182,17 +182,17 @@ public final class PubSubManager extends Manager { /** * Creates a node with specified configuration. - * + * * Note: This is the only way to create a collection node. - * - * @param nodeId The name of the node, which must be unique within the + * + * @param nodeId The name of the node, which must be unique within the * pubsub service * @param config The configuration for the node * @return The node that was created - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Node createNode(String nodeId, Form config) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub request = PubSub.createPubsubPacket(pubSubService, Type.set, new NodeExtension(PubSubElementType.CREATE, nodeId)); @@ -216,18 +216,18 @@ public final class PubSubManager extends Manager { } /** - * Retrieves the requested node, if it exists. It will throw an + * Retrieves the requested node, if it exists. It will throw an * exception if it does not. - * + * * @param id - The unique id of the node * @param type of the node. * * @return the node * @throws XMPPErrorException The node does not exist * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException - * @throws NotAPubSubNodeException + * @throws NotConnectedException + * @throws InterruptedException + * @throws NotAPubSubNodeException */ public T getNode(String id) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotAPubSubNodeException { Node node = nodeMap.get(id); @@ -316,7 +316,7 @@ public final class PubSubManager extends Manager { * @throws NotConnectedException * @throws InterruptedException * @throws XMPPErrorException - * @throws NotAPubSubNodeException + * @throws NotAPubSubNodeException * @since 4.2.1 */ public LeafNode getLeafNode(String id) throws NotALeafNodeException, NoResponseException, NotConnectedException, @@ -410,17 +410,17 @@ public final class PubSubManager extends Manager { * Get all the nodes that currently exist as a child of the specified * collection node. If the service does not support collection nodes * then all nodes will be returned. - * - * To retrieve contents of the root collection node (if it exists), + * + * To retrieve contents of the root collection node (if it exists), * or there is no root collection node, pass null as the nodeId. - * - * @param nodeId - The id of the collection node for which the child - * nodes will be returned. + * + * @param nodeId - The id of the collection node for which the child + * nodes will be returned. * @return {@link DiscoverItems} representing the existing nodes - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverItems discoverNodes(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { DiscoverItems items = new DiscoverItems(); @@ -434,12 +434,12 @@ public final class PubSubManager extends Manager { /** * Gets the subscriptions on the root node. - * + * * @return List of exceptions - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public List getSubscriptions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { Stanza reply = sendPubsubPacket(Type.get, new NodeExtension(PubSubElementType.SUBSCRIPTIONS), null); @@ -449,13 +449,13 @@ public final class PubSubManager extends Manager { /** * Gets the affiliations on the root node. - * + * * @return List of affiliations - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException - * + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException + * */ public List getAffiliations() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { PubSub reply = sendPubsubPacket(Type.get, new NodeExtension(PubSubElementType.AFFILIATIONS), null); @@ -465,12 +465,12 @@ public final class PubSubManager extends Manager { /** * Delete the specified node. - * + * * @param nodeId - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public void deleteNode(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { sendPubsubPacket(Type.set, new NodeExtension(PubSubElementType.DELETE, nodeId), PubSubElementType.DELETE.getNamespace()); @@ -479,12 +479,12 @@ public final class PubSubManager extends Manager { /** * Returns the default settings for Node configuration. - * + * * @return configuration form containing the default settings. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public ConfigureForm getDefaultConfiguration() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Errors will cause exceptions in getReply, so it only returns @@ -505,12 +505,12 @@ public final class PubSubManager extends Manager { /** * Gets the supported features of the servers pubsub implementation * as a standard {@link DiscoverInfo} instance. - * + * * @return The supported features - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public DiscoverInfo getSupportedFeatures() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { ServiceDiscoveryManager mgr = ServiceDiscoveryManager.getInstanceFor(connection()); @@ -602,7 +602,7 @@ public final class PubSubManager extends Manager { * Get the "default" PubSub service for a given XMPP connection. The default PubSub service is * simply an arbitrary XMPP service with the PubSub feature and an identity of category "pubsub" * and type "service". - * + * * @param connection * @return the default PubSub service or null. * @throws NoResponseException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishItem.java index 0f0d26cc8..b282f28af 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishItem.java @@ -21,7 +21,7 @@ import java.util.Collection; /** * Represents a request to publish an item(s) to a specific node. - * + * * @author Robin Collier */ public class PublishItem extends NodeExtension { @@ -29,7 +29,7 @@ public class PublishItem extends NodeExtension { /** * Construct a request to publish an item to a node. - * + * * @param nodeId The node to publish to * @param toPublish The {@link Item} to publish */ @@ -41,7 +41,7 @@ public class PublishItem extends NodeExtension { /** * Construct a request to publish multiple items to a node. - * + * * @param nodeId The node to publish to * @param toPublish The list of {@link Item} to publish */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java index b5da5c30b..f92ff24b3 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java @@ -17,9 +17,9 @@ package org.jivesoftware.smackx.pubsub; /** - * Determines who may publish to a node. Denotes possible values + * Determines who may publish to a node. Denotes possible values * for {@link ConfigureForm#setPublishModel(PublishModel)}. - * + * * @author Robin Collier */ public enum PublishModel { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java index 39e60fc3f..ff37bebc8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java @@ -22,7 +22,7 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace; /** * Represents and item that has been deleted from a node. - * + * * @author Robin Collier */ public class RetractItem implements ExtensionElement { @@ -30,7 +30,7 @@ public class RetractItem implements ExtensionElement { /** * Construct a RetractItem with the specified id. - * + * * @param itemId The id if the item deleted */ public RetractItem(String itemId) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java index 9e0ebf8b5..13af9fca4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java @@ -29,9 +29,9 @@ import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** - * The default payload representation for {@link PayloadItem#getPayload()}. It simply + * The default payload representation for {@link PayloadItem#getPayload()}. It simply * stores the XML payload as a string. - * + * * @author Robin Collier */ public class SimplePayload implements ExtensionElement { @@ -62,9 +62,9 @@ public class SimplePayload implements ExtensionElement { } /** - * Construct a SimplePayload object with the specified element name, + * Construct a SimplePayload object with the specified element name, * namespace and content. The content must be well formed XML. - * + * * @param elementName The root element name (of the payload) * @param namespace The namespace of the payload, null if there is none * @param xmlPayload The payload data diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeExtension.java index 5ddba2738..1ce28aadb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeExtension.java @@ -18,7 +18,7 @@ package org.jivesoftware.smackx.pubsub; /** * Represents a request to subscribe to a node. - * + * * @author Robin Collier */ public class SubscribeExtension extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java index 31628a7f5..ddd095b3a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java @@ -32,11 +32,11 @@ import org.jxmpp.util.XmppDateTime; /** * A decorator for a {@link Form} to easily enable reading and updating * of subscription options. All operations read or update the underlying {@link DataForm}. - * + * *

    Unlike the {@link Form}.setAnswer(XXX)} methods, which throw an exception if the field does not * exist, all SubscribeForm.setXXX methods will create the field in the wrapped form * if it does not already exist. - * + * * @author Robin Collier */ public class SubscribeForm extends Form { @@ -54,7 +54,7 @@ public class SubscribeForm extends Form { /** * Determines if an entity wants to receive notifications. - * + * * @return true if want to receive, false otherwise */ public boolean isDeliverOn() { @@ -73,7 +73,7 @@ public class SubscribeForm extends Form { /** * Determines if notifications should be delivered as aggregations or not. - * + * * @return true to aggregate, false otherwise */ public boolean isDigestOn() { @@ -82,8 +82,8 @@ public class SubscribeForm extends Form { /** * Sets whether notifications should be delivered as aggregations or not. - * - * @param digestOn true to aggregate, false otherwise + * + * @param digestOn true to aggregate, false otherwise */ public void setDigestOn(boolean digestOn) { addField(SubscribeOptionFields.deliver, FormField.Type.bool); @@ -92,7 +92,7 @@ public class SubscribeForm extends Form { /** * Gets the minimum number of milliseconds between sending notification digests. - * + * * @return The frequency in milliseconds */ public int getDigestFrequency() { @@ -101,7 +101,7 @@ public class SubscribeForm extends Form { /** * Sets the minimum number of milliseconds between sending notification digests. - * + * * @param frequency The frequency in milliseconds */ public void setDigestFrequency(int frequency) { @@ -111,7 +111,7 @@ public class SubscribeForm extends Form { /** * Get the time at which the leased subscription will expire, or has expired. - * + * * @return The expiry date */ public Date getExpiry() { @@ -128,7 +128,7 @@ public class SubscribeForm extends Form { /** * Sets the time at which the leased subscription will expire, or has expired. - * + * * @param expire The expiry date */ public void setExpiry(Date expire) { @@ -137,9 +137,9 @@ public class SubscribeForm extends Form { } /** - * Determines whether the entity wants to receive an XMPP message body in + * Determines whether the entity wants to receive an XMPP message body in * addition to the payload format. - * + * * @return true to receive the message body, false otherwise */ public boolean isIncludeBody() { @@ -147,9 +147,9 @@ public class SubscribeForm extends Form { } /** - * Sets whether the entity wants to receive an XMPP message body in + * Sets whether the entity wants to receive an XMPP message body in * addition to the payload format. - * + * * @param include true to receive the message body, false otherwise */ public void setIncludeBody(boolean include) { @@ -158,9 +158,9 @@ public class SubscribeForm extends Form { } /** - * Gets the {@link PresenceState} for which an entity wants to receive + * Gets the {@link PresenceState} for which an entity wants to receive * notifications. - * + * * @return the list of states */ public List getShowValues() { @@ -175,7 +175,7 @@ public class SubscribeForm extends Form { /** * Sets the list of {@link PresenceState} for which an entity wants * to receive notifications. - * + * * @param stateValues The list of states */ public void setShowValues(Collection stateValues) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java index 2bbec515e..0a067418c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java @@ -19,30 +19,30 @@ package org.jivesoftware.smackx.pubsub; import java.util.Calendar; /** - * Defines the possible field options for a subscribe options form as defined + * Defines the possible field options for a subscribe options form as defined * by Section 16.4.2. - * + * * @author Robin Collier */ public enum SubscribeOptionFields { /** * Whether an entity wants to receive or disable notifications. - * + * *

    Value: boolean

    */ deliver, /** - * Whether an entity wants to receive digests (aggregations) of + * Whether an entity wants to receive digests (aggregations) of * notifications or all notifications individually. - * + * *

    Value: boolean

    */ digest, /** * The minimum number of seconds between sending any two notifications digests. - * + * *

    Value: int

    */ digest_frequency, @@ -54,7 +54,7 @@ public enum SubscribeOptionFields { expire, /** - * Whether an entity wants to receive an XMPP message body in addition to + * Whether an entity wants to receive an XMPP message body in addition to * the payload format. * *

    Value: boolean

    @@ -70,7 +70,7 @@ public enum SubscribeOptionFields { /** * Subscription type. - * + * *

    Value:

    */ subscription_type, diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java index 6f0b882da..e1a8c188c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java @@ -22,7 +22,7 @@ import org.jxmpp.jid.Jid; /** * Represents a subscription to node for both requests and replies. - * + * * @author Robin Collier */ public class Subscription extends NodeExtension { @@ -32,13 +32,13 @@ public class Subscription extends NodeExtension { protected boolean configRequired = false; public enum State { - subscribed, unconfigured, pending, none + subscribed, unconfigured, pending, none } /** * Used to constructs a subscription request to the root node with the specified * JID. - * + * * @param subscriptionJid The subscriber JID */ public Subscription(Jid subscriptionJid) { @@ -48,7 +48,7 @@ public class Subscription extends NodeExtension { /** * Used to constructs a subscription request to the specified node with the specified * JID. - * + * * @param subscriptionJid The subscriber JID * @param nodeId The node id */ @@ -67,9 +67,9 @@ public class Subscription extends NodeExtension { } /** - * Constructs a representation of a subscription reply to the specified node + * Constructs a representation of a subscription reply to the specified node * and JID. The server will have supplied the subscription id and current state. - * + * * @param jid The JID the request was made under * @param nodeId The node subscribed to * @param subscriptionId The id of this subscription @@ -83,15 +83,15 @@ public class Subscription extends NodeExtension { } /** - * Constructs a representation of a subscription reply to the specified node + * Constructs a representation of a subscription reply to the specified node * and JID. The server will have supplied the subscription id and current state * and whether the subscription need to be configured. - * + * * @param jid The JID the request was made under * @param nodeId The node subscribed to * @param subscriptionId The id of this subscription * @param state The current state of the subscription - * @param configRequired Is configuration required to complete the subscription + * @param configRequired Is configuration required to complete the subscription */ public Subscription(Jid jid, String nodeId, String subscriptionId, State state, boolean configRequired) { super(PubSubElementType.SUBSCRIPTION, nodeId); @@ -103,7 +103,7 @@ public class Subscription extends NodeExtension { /** * Gets the JID the subscription is created for. - * + * * @return The JID */ public Jid getJid() { @@ -112,7 +112,7 @@ public class Subscription extends NodeExtension { /** * Gets the subscription id. - * + * * @return The subscription id */ public String getId() { @@ -121,7 +121,7 @@ public class Subscription extends NodeExtension { /** * Gets the current subscription state. - * + * * @return Current subscription state */ public State getState() { @@ -130,7 +130,7 @@ public class Subscription extends NodeExtension { /** * This value is only relevant when the {@link #getState()} is {@link State#unconfigured}. - * + * * @return true if configuration is required, false otherwise */ public boolean isConfigRequired() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionEvent.java index c00f0db35..204df6443 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionEvent.java @@ -21,18 +21,18 @@ import java.util.List; /** * Base class to represents events that are associated to subscriptions. - * + * * @author Robin Collier */ public abstract class SubscriptionEvent extends NodeEvent { private List subIds = Collections.emptyList(); /** - * Construct an event with no subscription id's. This can + * Construct an event with no subscription id's. This can * occur when there is only one subscription to a node. The - * event may or may not report the subscription id along + * event may or may not report the subscription id along * with the event. - * + * * @param nodeId The id of the node the event came from */ protected SubscriptionEvent(String nodeId) { @@ -41,7 +41,7 @@ public abstract class SubscriptionEvent extends NodeEvent { /** * Construct an event with multiple subscriptions. - * + * * @param nodeId The id of the node the event came from * @param subscriptionIds The list of subscription id's */ @@ -52,9 +52,9 @@ public abstract class SubscriptionEvent extends NodeEvent { subIds = subscriptionIds; } - /** + /** * Get the subscriptions this event is associated with. - * + * * @return List of subscription id's */ public List getSubscriptions() { @@ -63,7 +63,7 @@ public abstract class SubscriptionEvent extends NodeEvent { /** * Set the list of subscription id's for this event. - * + * * @param subscriptionIds The list of subscription id's */ protected void setSubscriptions(List subscriptionIds) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java index 3180f048f..0071c5562 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java @@ -21,7 +21,7 @@ import java.util.List; /** * Represents the element holding the list of subscription elements. - * + * * @author Robin Collier */ public class SubscriptionsExtension extends NodeExtension { @@ -49,7 +49,7 @@ public class SubscriptionsExtension extends NodeExtension { /** * Subscriptions to the root node. - * + * * @param subList The list of subscriptions */ public SubscriptionsExtension(List subList) { @@ -58,7 +58,7 @@ public class SubscriptionsExtension extends NodeExtension { /** * Subscriptions to the specified node. - * + * * @param nodeId The node subscribed to * @param subList The list of subscriptions */ @@ -68,7 +68,7 @@ public class SubscriptionsExtension extends NodeExtension { /** * Subscriptions to the specified node. - * + * * @param subscriptionsNamespace the namespace used by this element * @param nodeId The node subscribed to * @param subList The list of subscriptions @@ -83,7 +83,7 @@ public class SubscriptionsExtension extends NodeExtension { /** * Gets the list of subscriptions. - * + * * @return List of subscriptions */ public List getSubscriptions() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/UnsubscribeExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/UnsubscribeExtension.java index 05fbded4a..9840c9b58 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/UnsubscribeExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/UnsubscribeExtension.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Represents an unsubscribe element. - * + * * @author Robin Collier */ public class UnsubscribeExtension extends NodeExtension { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemDeleteListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemDeleteListener.java index 43879f38f..af3da8b87 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemDeleteListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemDeleteListener.java @@ -21,23 +21,23 @@ import org.jivesoftware.smackx.pubsub.LeafNode; /** * Defines the listener for item deletion events from a node. - * + * * @see LeafNode#addItemDeleteListener(ItemDeleteListener) - * + * * @author Robin Collier */ public interface ItemDeleteListener { /** - * Called when items are deleted from a node the listener is + * Called when items are deleted from a node the listener is * registered with. - * + * * @param items The event with item deletion details */ void handleDeletedItems(ItemDeleteEvent items); /** - * Called when all items are deleted from a node the listener is - * registered with. + * Called when all items are deleted from a node the listener is + * registered with. */ void handlePurge(); } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemEventListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemEventListener.java index 4e4c3aae7..dbe1507c6 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemEventListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/ItemEventListener.java @@ -22,7 +22,7 @@ import org.jivesoftware.smackx.pubsub.LeafNode; /** * Defines the listener for items being published to a node. - * + * * @see LeafNode#addItemEventListener(ItemEventListener) * * @author Robin Collier @@ -31,7 +31,7 @@ public interface ItemEventListener { /** * Called whenever an item is published to the node the listener * is registered with. - * + * * @param items The publishing details. */ void handlePublishedItems(ItemPublishEvent items); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/NodeConfigListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/NodeConfigListener.java index c9fa39be7..301d6eda3 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/NodeConfigListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/listener/NodeConfigListener.java @@ -21,7 +21,7 @@ import org.jivesoftware.smackx.pubsub.LeafNode; /** * Defines the listener for a node being configured. - * + * * @see LeafNode#addConfigurationListener(NodeConfigListener) * * @author Robin Collier @@ -30,7 +30,7 @@ public interface NodeConfigListener { /** * Called whenever the node the listener * is registered with is configured. - * + * * @param config The configuration details. */ void handleNodeConfiguration(ConfigurationEvent config); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java index 730fcbc56..e8a6f4749 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSub.java @@ -26,9 +26,9 @@ import org.jxmpp.jid.Jid; /** * The standard PubSub extension of an {@link IQ} packet. This is the topmost - * element of all pubsub requests and replies as defined in the Publish-Subscribe + * element of all pubsub requests and replies as defined in the Publish-Subscribe * specification. - * + * * @author Robin Collier */ public class PubSub extends IQ { @@ -56,7 +56,7 @@ public class PubSub extends IQ { /** * Returns the XML representation of a pubsub element according the specification. - * + * * The XML representation will be inside of an iq stanza like * in the following example: * 
    @@ -68,7 +68,7 @@ public class PubSub extends IQ {
      *     </pubsub>
      * </iq>
      *
    - * + * */ @Override protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSubNamespace.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSubNamespace.java index ca6ad5747..9bd744393 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSubNamespace.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/packet/PubSubNamespace.java @@ -19,7 +19,7 @@ package org.jivesoftware.smackx.pubsub.packet; /** * Defines all the valid namespaces that are used with the {@link PubSub} packet * as defined by the specification. - * + * * @author Robin Collier */ public enum PubSubNamespace { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationProvider.java index cee29f7b3..6b6d83a64 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationProvider.java @@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Parses the affiliation element out of the reply stanza from the server * as specified in the affiliation schema. - * + * * @author Robin Collier */ public class AffiliationProvider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationsProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationsProvider.java index 3a2df7c5c..6e77025d2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationsProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/AffiliationsProvider.java @@ -29,7 +29,7 @@ import org.jivesoftware.smackx.pubsub.AffiliationsExtension; /** * Parses the affiliations element out of the reply stanza from the server * as specified in the affiliation schema. - * + * * @author Robin Collier */public class AffiliationsProvider extends EmbeddedExtensionProvider { @SuppressWarnings("unchecked") diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ConfigEventProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ConfigEventProvider.java index 55119989b..f13bd1621 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ConfigEventProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ConfigEventProvider.java @@ -27,9 +27,9 @@ import org.jivesoftware.smackx.pubsub.ConfigureForm; import org.jivesoftware.smackx.xdata.packet.DataForm; /** - * Parses the node configuration element out of the message event stanza from + * Parses the node configuration element out of the message event stanza from * the server as specified in the configuration schema. - * + * * @author Robin Collier */ public class ConfigEventProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/EventProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/EventProvider.java index 48a7dade5..33915ef50 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/EventProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/EventProvider.java @@ -27,9 +27,9 @@ import org.jivesoftware.smackx.pubsub.EventElementType; import org.jivesoftware.smackx.pubsub.NodeExtension; /** - * Parses the event element out of the message stanza from + * Parses the event element out of the message stanza from * the server as specified in the event schema. - * + * * @author Robin Collier */ public class EventProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/FormNodeProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/FormNodeProvider.java index 955df1022..f1a3f000d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/FormNodeProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/FormNodeProvider.java @@ -30,7 +30,7 @@ import org.jivesoftware.smackx.xdata.packet.DataForm; /** * Parses one of several elements used in PubSub that contain a form of some kind as a child element. The * elements and namespaces supported is defined in {@link FormNodeType}. - * + * * @author Robin Collier */ public class FormNodeProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemProvider.java index 1850a302d..932b91837 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemProvider.java @@ -34,7 +34,7 @@ import org.xmlpull.v1.XmlPullParser; * {@link PubSubNamespace#event} namespaces. To parse the item contents, it will use whatever * {@link ExtensionElementProvider} is registered in smack.providers for its element name and namespace. If no * provider is registered, it will return a {@link SimplePayload}. - * + * * @author Robin Collier */ public class ItemProvider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemsProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemsProvider.java index 69e7c6fec..dffdea7b2 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemsProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/ItemsProvider.java @@ -25,9 +25,9 @@ import org.jivesoftware.smack.provider.EmbeddedExtensionProvider; import org.jivesoftware.smackx.pubsub.ItemsExtension; /** - * Parses the items element out of the message event stanza from + * Parses the items element out of the message event stanza from * the server as specified in the items schema. - * + * * @author Robin Collier */ public class ItemsProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java index f646bec77..72c6bb2b0 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/PubSubProvider.java @@ -28,7 +28,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Parses the root PubSub stanza extensions of the {@link IQ} stanza and returns * a {@link PubSub} instance. - * + * * @author Robin Collier */ public class PubSubProvider extends IQProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/RetractEventProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/RetractEventProvider.java index d4780af49..134036cba 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/RetractEventProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/RetractEventProvider.java @@ -25,10 +25,10 @@ import org.jivesoftware.smack.provider.EmbeddedExtensionProvider; import org.jivesoftware.smackx.pubsub.RetractItem; /** - * Parses the retract element out of the message event stanza from + * Parses the retract element out of the message event stanza from * the server as specified in the retract schema. * This element is a child of the items element. - * + * * @author Robin Collier */ public class RetractEventProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SimpleNodeProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SimpleNodeProvider.java index 719e0720e..830b62bcc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SimpleNodeProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SimpleNodeProvider.java @@ -28,7 +28,7 @@ import org.jivesoftware.smackx.pubsub.PubSubElementType; /** * Parses simple elements that only contain a node attribute. This is common amongst many of the * elements defined in the PubSub specification. For this common case a {@link NodeExtension} is returned. - * + * * @author Robin Collier */ public class SimpleNodeProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionProvider.java index bb64474fd..65ec2606a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionProvider.java @@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * Parses the subscription element out of the PubSub IQ message from * the server as specified in the subscription schema. - * + * * @author Robin Collier */ public class SubscriptionProvider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionsProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionsProvider.java index 9e132c066..1d032a1e0 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionsProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/provider/SubscriptionsProvider.java @@ -29,7 +29,7 @@ import org.jivesoftware.smackx.pubsub.SubscriptionsExtension.SubscriptionsNamesp /** * Parses the subscriptions element out of the PubSub IQ message from * the server as specified in the subscriptions schema. - * + * * @author Robin Collier */ public class SubscriptionsProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/util/NodeUtils.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/util/NodeUtils.java index d33520677..43a2ee002 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/util/NodeUtils.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/util/NodeUtils.java @@ -25,13 +25,13 @@ import org.jivesoftware.smackx.xdata.Form; /** * Utility for extracting information from packets. - * + * * @author Robin Collier */ public class NodeUtils { - /** + /** * Get a {@link ConfigureForm} from a packet. - * + * * @param packet * @param elem * @return The configuration form diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java index 692d56446..dbfd61436 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java @@ -120,7 +120,7 @@ public final class DeliveryReceiptManager extends Manager { /** * Set the default automatic receipt mode for new connections. - * + * * @param autoReceiptMode the default automatic receipt mode. */ public static void setDefaultAutoReceiptMode(AutoReceiptMode autoReceiptMode) { @@ -198,12 +198,12 @@ public final class DeliveryReceiptManager extends Manager { /** * Returns true if Delivery Receipts are supported by a given JID. - * + * * @param jid * @return true if supported * @throws SmackException if there was no response from the server. - * @throws XMPPException - * @throws InterruptedException + * @throws XMPPException + * @throws InterruptedException */ public boolean isSupported(Jid jid) throws SmackException, XMPPException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, @@ -223,7 +223,7 @@ public final class DeliveryReceiptManager extends Manager { /** * Get the currently active auto receipt mode. - * + * * @return the currently active auto receipt mode. */ public AutoReceiptMode getAutoReceiptMode() { @@ -232,7 +232,7 @@ public final class DeliveryReceiptManager extends Manager { /** * Get informed about incoming delivery receipts with a {@link ReceiptReceivedListener}. - * + * * @param listener the listener to be informed about new receipts */ public void addReceiptReceivedListener(ReceiptReceivedListener listener) { @@ -241,7 +241,7 @@ public final class DeliveryReceiptManager extends Manager { /** * Stop getting informed about incoming delivery receipts. - * + * * @param listener the listener to be removed */ public void removeReceiptReceivedListener(ReceiptReceivedListener listener) { @@ -274,7 +274,7 @@ public final class DeliveryReceiptManager extends Manager { * Enables automatic requests of delivery receipts for outgoing messages of * {@link org.jivesoftware.smack.packet.Message.Type#normal}, {@link org.jivesoftware.smack.packet.Message.Type#chat} or {@link org.jivesoftware.smack.packet.Message.Type#headline}, and * with a {@link org.jivesoftware.smack.packet.Message.Body} extension. - * + * * @since 4.1 * @see #dontAutoAddDeliveryReceiptRequests() */ @@ -285,7 +285,7 @@ public final class DeliveryReceiptManager extends Manager { /** * Disables automatically requests of delivery receipts for outgoing messages. - * + * * @since 4.1 * @see #autoAddDeliveryReceiptRequests() */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java index 1f48910d7..ed324bc34 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/ReceiptReceivedListener.java @@ -22,8 +22,8 @@ import org.jxmpp.jid.Jid; /** * Interface for received receipt notifications. - * - * Implement this and add a listener to get notified. + * + * Implement this and add a listener to get notified. */ public interface ReceiptReceivedListener { /** @@ -32,7 +32,7 @@ public interface ReceiptReceivedListener { * {@code receiptId} correspondents to the message ID, which can be obtained with * {@link org.jivesoftware.smack.packet.Stanza#getStanzaId()}. *

    - * + * * @param fromJid the jid that send this receipt * @param toJid the jid which received this receipt * @param receiptId the message ID of the stanza which has been received and this receipt is for. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java index 90926b317..80c701e48 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java @@ -27,9 +27,9 @@ import org.jivesoftware.smackx.xdata.packet.DataForm; import org.jivesoftware.smackx.xdata.packet.DataForm.Item; /** - * Represents a set of data results returned as part of a search. The report is structured + * Represents a set of data results returned as part of a search. The report is structured * in columns and rows. - * + * * @author Gaston Dombiak */ public class ReportedData { @@ -39,9 +39,9 @@ public class ReportedData { private String title = ""; /** - * Returns a new ReportedData if the stanza is used for reporting data and includes an + * Returns a new ReportedData if the stanza is used for reporting data and includes an * extension that matches the elementName and namespace "x","jabber:x:data". - * + * * @param packet the stanza used for reporting data. * @return ReportedData from the packet if present, otherwise null. */ @@ -235,7 +235,7 @@ public class ReportedData { /** * Returns the variable name that the field represents. - * + * * @return the variable name of the field. */ public String getVariable() { @@ -244,7 +244,7 @@ public class ReportedData { /** * Returns a List of the values reported as part of the search. - * + * * @return the returned values of the search. */ public List getValues() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java index ccf35357d..1aef0575a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java @@ -60,10 +60,10 @@ public class UserSearch extends SimpleIQ { * @param con the current XMPPConnection. * @param searchService the search service to use. (ex. search.jivesoftware.com) * @return the search form received by the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Form getSearchForm(XMPPConnection con, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { UserSearch search = new UserSearch(); @@ -81,10 +81,10 @@ public class UserSearch extends SimpleIQ { * @param searchForm the Form to send for querying. * @param searchService the search service to use. (ex. search.jivesoftware.com) * @return ReportedData the data found from the query. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public ReportedData sendSearchForm(XMPPConnection con, Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { UserSearch search = new UserSearch(); @@ -103,10 +103,10 @@ public class UserSearch extends SimpleIQ { * @param searchForm the Form to send for querying. * @param searchService the search service to use. (ex. search.jivesoftware.com) * @return ReportedData the data found from the query. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public ReportedData sendSimpleSearchForm(XMPPConnection con, Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { SimpleUserSearch search = new SimpleUserSearch(); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java index 35d09f8c9..2566a548e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java @@ -66,10 +66,10 @@ public class UserSearchManager { * * @param searchService the search service to query. * @return the form to fill out to perform a search. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public Form getSearchForm(DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return userSearch.getSearchForm(con, searchService); @@ -82,10 +82,10 @@ public class UserSearchManager { * @param searchForm the Form to submit for searching. * @param searchService the name of the search service to use. * @return the ReportedData returned by the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public ReportedData getSearchResults(Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return userSearch.sendSearchForm(con, searchForm, searchService); @@ -96,10 +96,10 @@ public class UserSearchManager { * Returns a collection of search services found on the server. * * @return a Collection of search services found on the server. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public List getSearchServices() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(con); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/SharedGroupManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/SharedGroupManager.java index 14a959018..21d500a96 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/SharedGroupManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/SharedGroupManager.java @@ -42,10 +42,10 @@ public class SharedGroupManager { * * @param connection connection to use to get the user's shared groups. * @return collection with the shared groups' name of the logged user. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static List getSharedGroups(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Discover the shared groups of the logged user diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java index b70bf1620..aeedc741f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java @@ -25,9 +25,9 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * Extension representing a list of headers as specified in Stanza Headers and Internet Metadata (SHIM). - * + * * @see Header - * + * * @author Robin Collier */ public class HeadersExtension implements ExtensionElement { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeaderProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeaderProvider.java index 8b9c30e28..5f1c5367d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeaderProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeaderProvider.java @@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * Parses the header element as defined in Stanza Headers and Internet Metadata (SHIM). - * + * * @author Robin Collier */ public class HeaderProvider extends ExtensionElementProvider
    { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeadersProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeadersProvider.java index 467d12666..7f140af14 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeadersProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/provider/HeadersProvider.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.shim.packet.HeadersExtension; /** * Parses the headers element as defined in Stanza Headers and Internet Metadata (SHIM). - * + * * @author Robin Collier */ public class HeadersProvider extends EmbeddedExtensionProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/si/provider/StreamInitiationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/si/provider/StreamInitiationProvider.java index acadd12a2..10caea879 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/si/provider/StreamInitiationProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/si/provider/StreamInitiationProvider.java @@ -33,9 +33,9 @@ import org.xmlpull.v1.XmlPullParser; /** * The StreamInitiationProvider parses StreamInitiation packets. - * + * * @author Alexander Wenckus - * + * */ public class StreamInitiationProvider extends IQProvider { private static final Logger LOGGER = Logger.getLogger(StreamInitiationProvider.class.getName()); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java index b10eee628..01579f09e 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java @@ -53,7 +53,7 @@ public final class VCardManager extends Manager { /** * Retrieves a {@link VCardManager} for the specified {@link XMPPConnection}, creating one if it doesn't already * exist. - * + * * @param connection the connection the manager is attached to. * @return The new or existing manager. */ @@ -68,14 +68,14 @@ public final class VCardManager extends Manager { /** * Returns true if the given entity understands the vCard-XML format and allows the exchange of such. - * + * * @param jid * @param connection * @return true if the given entity understands the vCard-XML format and exchange. - * @throws XMPPErrorException - * @throws NoResponseException + * @throws XMPPErrorException + * @throws NoResponseException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @deprecated use {@link #isSupported(Jid)} instead. */ @Deprecated @@ -96,8 +96,8 @@ public final class VCardManager extends Manager { * * @throws XMPPErrorException thrown if there was an issue setting the VCard in the server. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void saveVCard(VCard vcard) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // XEP-54 § 3.2 "A user may publish or update his or her vCard by sending an IQ of type "set" with no 'to' address…" @@ -113,10 +113,10 @@ public final class VCardManager extends Manager { * Load the VCard of the current user. * * @return VCard. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public VCard loadVCard() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return loadVCard(null); @@ -128,10 +128,10 @@ public final class VCardManager extends Manager { * @param bareJid bareJid of the user. * * @return VCard. - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public VCard loadVCard(EntityBareJid bareJid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { VCard vcardRequest = new VCard(); @@ -142,13 +142,13 @@ public final class VCardManager extends Manager { /** * Returns true if the given entity understands the vCard-XML format and allows the exchange of such. - * + * * @param jid * @return true if the given entity understands the vCard-XML format and exchange. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public boolean isSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, NAMESPACE); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java index d264be306..34a95b1fc 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java @@ -554,8 +554,8 @@ public class VCard extends IQ { * @param connection the XMPPConnection to use. * @throws XMPPErrorException thrown if there was an issue setting the VCard in the server. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated use {@link VCardManager#saveVCard(VCard)} instead. */ @Deprecated @@ -568,10 +568,10 @@ public class VCard extends IQ { * and not anonymous. * * @param connection connection. - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated use {@link VCardManager#loadVCard()} instead. */ @Deprecated @@ -585,10 +585,10 @@ public class VCard extends IQ { * @param connection connection. * @param user user whos information we want to load. * - * @throws XMPPErrorException + * @throws XMPPErrorException * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException * @deprecated use {@link VCardManager#loadVCard(EntityBareJid)} instead. */ @Deprecated diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java index 670840808..f73c1c2c8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java @@ -29,17 +29,17 @@ import org.jivesoftware.smackx.xdata.packet.DataForm; * Represents a Form for gathering data. The form could be of the following types: *
      *
    • form → Indicates a form to fill out.
      • - *
    • submit → The form is filled out, and this is the data that is being returned from + *
    • submit → The form is filled out, and this is the data that is being returned from * the form.
      • *
    • cancel → The form was cancelled. Tell the asker that piece of information.
      • *
    • result → Data results being returned from a search, or some other query.
      • *
    - * + * * Depending of the form's type different operations are available. For example, it's only possible * to set answers if the form is of type "submit". - * + * * @see XEP-0004 Data Forms - * + * * @author Gaston Dombiak */ public class Form { @@ -47,9 +47,9 @@ public class Form { private DataForm dataForm; /** - * Returns a new ReportedData if the stanza is used for gathering data and includes an - * extension that matches the elementName and namespace "x","jabber:x:data". - * + * Returns a new ReportedData if the stanza is used for gathering data and includes an + * extension that matches the elementName and namespace "x","jabber:x:data". + * * @param packet the stanza used for gathering data. * @return the data form parsed from the stanza or null if there was not * a form in the packet. @@ -67,9 +67,9 @@ public class Form { /** * Creates a new Form that will wrap an existing DataForm. The wrapped DataForm must be - * used for gathering data. - * - * @param dataForm the data form used for gathering data. + * used for gathering data. + * + * @param dataForm the data form used for gathering data. */ public Form(DataForm dataForm) { this.dataForm = dataForm; @@ -86,7 +86,7 @@ public class Form { /** * Adds a new field to complete as part of the form. - * + * * @param field the field to complete. */ public void addField(FormField field) { @@ -94,13 +94,13 @@ public class Form { } /** - * Sets a new String value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new String value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised.

    - * + * * If the value to set to the field is not a basic type (e.g. String, boolean, int, etc.) you - * can use this message where the String value is the String representation of the object. - * + * can use this message where the String value is the String representation of the object. + * * @param variable the variable name that was completed. * @param value the String value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -126,10 +126,10 @@ public class Form { } /** - * Sets a new int value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new int value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised. - * + * * @param variable the variable name that was completed. * @param value the int value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -146,10 +146,10 @@ public class Form { } /** - * Sets a new long value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new long value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised. - * + * * @param variable the variable name that was completed. * @param value the long value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -166,10 +166,10 @@ public class Form { } /** - * Sets a new float value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new float value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised. - * + * * @param variable the variable name that was completed. * @param value the float value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -186,10 +186,10 @@ public class Form { } /** - * Sets a new double value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new double value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised. - * + * * @param variable the variable name that was completed. * @param value the double value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -217,10 +217,10 @@ public class Form { } /** - * Sets a new boolean value to a given form's field. The field whose variable matches the - * requested variable will be completed with the specified value. If no field could be found + * Sets a new boolean value to a given form's field. The field whose variable matches the + * requested variable will be completed with the specified value. If no field could be found * for the specified variable then an exception will be raised. - * + * * @param variable the variable name that was completed. * @param value the boolean value that was answered. * @throws IllegalStateException if the form is not of type "submit". @@ -239,19 +239,19 @@ public class Form { } /** - * Sets a new Object value to a given form's field. In fact, the object representation + * Sets a new Object value to a given form's field. In fact, the object representation * (i.e. #toString) will be the actual value of the field.

    - * + * * If the value to set to the field is not a basic type (e.g. String, boolean, int, etc.) you - * will need to use {@link #setAnswer(String, String)} where the String value is the - * String representation of the object.

    - * - * Before setting the new value to the field we will check if the form is of type submit. If - * the form isn't of type submit means that it's not possible to complete the form and an + * will need to use {@link #setAnswer(String, String)} where the String value is the + * String representation of the object.

    + * + * Before setting the new value to the field we will check if the form is of type submit. If + * the form isn't of type submit means that it's not possible to complete the form and an * exception will be thrown. - * + * * @param field the form field that was completed. - * @param value the Object value that was answered. The object representation will be the + * @param value the Object value that was answered. The object representation will be the * actual value. * @throws IllegalStateException if the form is not of type "submit". */ @@ -265,13 +265,13 @@ public class Form { } /** - * Sets a new values to a given form's field. The field whose variable matches the requested - * variable will be completed with the specified values. If no field could be found for + * Sets a new values to a given form's field. The field whose variable matches the requested + * variable will be completed with the specified values. If no field could be found for * the specified variable then an exception will be raised.

    - * + * * The Objects contained in the List could be of any type. The String representation of them * (i.e. #toString) will be actually used when sending the answer to the server. - * + * * @param variable the variable that was completed. * @param values the values that were answered. * @throws IllegalStateException if the form is not of type "submit". @@ -295,7 +295,7 @@ public class Form { default: throw new IllegalArgumentException("This field only accept list of values."); } - // Clear the old values + // Clear the old values field.resetValues(); // Set the new values. The string representation of each value will be actually used. field.addValues(values); @@ -344,10 +344,10 @@ public class Form { /** * Returns the field of the form whose variable matches the specified variable. - * The fields of type FIXED will never be returned since they do not specify a - * variable. - * - * @param variable the variable to look for in the form fields. + * The fields of type FIXED will never be returned since they do not specify a + * variable. + * + * @param variable the variable to look for in the form fields. * @return the field of the form whose variable matches the specified variable. */ public FormField getField(String variable) { @@ -367,7 +367,7 @@ public class Form { /** * Returns the instructions that explain how to fill out the form and what the form is about. - * + * * @return instructions that explain how to fill out the form. */ public String getInstructions() { @@ -385,9 +385,9 @@ public class Form { /** - * Returns the description of the data. It is similar to the title on a web page or an X + * Returns the description of the data. It is similar to the title on a web page or an X * window. You can put a title on either a form to fill out, or a set of data results. - * + * * @return description of the data. */ public String getTitle() { @@ -398,17 +398,17 @@ public class Form { /** * Returns the meaning of the data within the context. The data could be part of a form * to fill out, a form submission or data results. - * + * * @return the form's type. */ public DataForm.Type getType() { - return dataForm.getType(); + return dataForm.getType(); } /** * Sets instructions that explain how to fill out the form and what the form is about. - * + * * @param instructions instructions that explain how to fill out the form. */ public void setInstructions(String instructions) { @@ -427,7 +427,7 @@ public class Form { /** * Sets the description of the data. It is similar to the title on a web page or an X window. * You can put a title on either a form to fill out, or a set of data results. - * + * * @param title description of the data. */ public void setTitle(String title) { @@ -435,15 +435,15 @@ public class Form { } /** - * Returns a DataForm that serves to send this Form to the server. If the form is of type - * submit, it may contain fields with no value. These fields will be removed since they only - * exist to assist the user while editing/completing the form in a UI. - * + * Returns a DataForm that serves to send this Form to the server. If the form is of type + * submit, it may contain fields with no value. These fields will be removed since they only + * exist to assist the user while editing/completing the form in a UI. + * * @return the wrapped DataForm. */ public DataForm getDataFormToSend() { if (isSubmitType()) { - // Create a new DataForm that contains only the answered fields + // Create a new DataForm that contains only the answered fields DataForm dataFormToSend = new DataForm(getType()); for (FormField field : getFields()) { if (!field.getValues().isEmpty()) { @@ -457,7 +457,7 @@ public class Form { /** * Returns true if the form is a form to fill out. - * + * * @return if the form is a form to fill out. */ private boolean isFormType() { @@ -466,7 +466,7 @@ public class Form { /** * Returns true if the form is a form to submit. - * + * * @return if the form is a form to submit. */ private boolean isSubmitType() { @@ -475,16 +475,16 @@ public class Form { /** * Returns a new Form to submit the completed values. The new Form will include all the fields - * of the original form except for the fields of type FIXED. Only the HIDDEN fields will - * include the same value of the original form. The other fields of the new form MUST be - * completed. If a field remains with no answer when sending the completed form, then it won't + * of the original form except for the fields of type FIXED. Only the HIDDEN fields will + * include the same value of the original form. The other fields of the new form MUST be + * completed. If a field remains with no answer when sending the completed form, then it won't * be included as part of the completed form.

    - * - * The reason why the fields with variables are included in the new form is to provide a model - * for binding with any UI. This means that the UIs will use the original form (of type + * + * The reason why the fields with variables are included in the new form is to provide a model + * for binding with any UI. This means that the UIs will use the original form (of type * "form") to learn how to render the form, but the UIs will bind the fields to the form of * type submit. - * + * * @return a Form to submit the completed values. */ public Form createAnswerForm() { @@ -500,9 +500,9 @@ public class Form { FormField newField = new FormField(field.getVariable()); newField.setType(field.getType()); form.addField(newField); - // Set the answer ONLY to the hidden fields + // Set the answer ONLY to the hidden fields if (field.getType() == FormField.Type.hidden) { - // Since a hidden field could have many values we need to collect them + // Since a hidden field could have many values we need to collect them // in a list List values = new ArrayList<>(); values.addAll(field.getValues()); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java index e785b7f7a..d2489b5c7 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java @@ -45,7 +45,7 @@ public class FormField implements NamedElement { /** * Form Field Types as defined in XEP-4 § 3.3. - * + * * @see XEP-4 § 3.3 Field Types */ public enum Type { @@ -273,7 +273,7 @@ public class FormField implements NamedElement { * "uniquely identifies the field in the context of the form" (if the field is not of type 'fixed', in which case * the field "MAY possess a 'var' attribute") *

    - * + * * @return the variable name of the question. */ public String getVariable() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/XDataManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/XDataManager.java index 2dd0287c2..622955435 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/XDataManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/XDataManager.java @@ -79,7 +79,7 @@ public final class XDataManager extends Manager { * @throws NoResponseException * @throws XMPPErrorException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @see XEP-0004: Data Forms § 6. Service Discovery * @since 4.1 */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java index dd2544c49..5315c6d49 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java @@ -84,17 +84,17 @@ public class DataForm implements ExtensionElement { /** * Returns the meaning of the data within the context. The data could be part of a form * to fill out, a form submission or data results. - * + * * @return the form's type. */ public Type getType() { - return type; + return type; } /** - * Returns the description of the data. It is similar to the title on a web page or an X + * Returns the description of the data. It is similar to the title on a web page or an X * window. You can put a <title/> on either a form to fill out, or a set of data results. - * + * * @return description of the data. */ public String getTitle() { @@ -102,11 +102,11 @@ public class DataForm implements ExtensionElement { } /** - * Returns a List of the list of instructions that explain how to fill out the form and - * what the form is about. The dataform could include multiple instructions since each - * instruction could not contain newlines characters. Join the instructions together in order + * Returns a List of the list of instructions that explain how to fill out the form and + * what the form is about. The dataform could include multiple instructions since each + * instruction could not contain newlines characters. Join the instructions together in order * to show them to the user. - * + * * @return a List of the list of instructions that explain how to fill out the form. */ public List getInstructions() { @@ -117,7 +117,7 @@ public class DataForm implements ExtensionElement { /** * Returns the fields that will be returned from a search. - * + * * @return fields that will be returned from a search. */ public ReportedData getReportedData() { @@ -185,7 +185,7 @@ public class DataForm implements ExtensionElement { /** * Sets the description of the data. It is similar to the title on a web page or an X window. * You can put a <title/> on either a form to fill out, or a set of data results. - * + * * @param title description of the data. */ public void setTitle(String title) { @@ -193,10 +193,10 @@ public class DataForm implements ExtensionElement { } /** - * Sets the list of instructions that explain how to fill out the form and what the form is - * about. The dataform could include multiple instructions since each instruction could not - * contain newlines characters. - * + * Sets the list of instructions that explain how to fill out the form and what the form is + * about. The dataform could include multiple instructions since each instruction could not + * contain newlines characters. + * * @param instructions list of instructions that explain how to fill out the form. */ public void setInstructions(List instructions) { @@ -208,7 +208,7 @@ public class DataForm implements ExtensionElement { /** * Sets the fields that will be returned from a search. - * + * * @param reportedData the fields that will be returned from a search. */ public void setReportedData(ReportedData reportedData) { @@ -217,7 +217,7 @@ public class DataForm implements ExtensionElement { /** * Adds a new field as part of the form. - * + * * @param field the field to add to the form. */ public void addField(FormField field) { @@ -235,10 +235,10 @@ public class DataForm implements ExtensionElement { } /** - * Adds a new instruction to the list of instructions that explain how to fill out the form - * and what the form is about. The dataform could include multiple instructions since each - * instruction could not contain newlines characters. - * + * Adds a new instruction to the list of instructions that explain how to fill out the form + * and what the form is about. The dataform could include multiple instructions since each + * instruction could not contain newlines characters. + * * @param instruction the new instruction that explain how to fill out the form. */ public void addInstruction(String instruction) { @@ -249,7 +249,7 @@ public class DataForm implements ExtensionElement { /** * Adds a new item returned from a search. - * + * * @param item the item returned from a search. */ public void addItem(Item item) { @@ -329,8 +329,8 @@ public class DataForm implements ExtensionElement { } /** - * - * Represents the fields that will be returned from a search. This information is useful when + * + * Represents the fields that will be returned from a search. This information is useful when * you try to use the jabber:iq:search namespace to return dynamic form information. * * @author Gaston Dombiak @@ -346,7 +346,7 @@ public class DataForm implements ExtensionElement { /** * Returns the fields returned from a search. - * + * * @return the fields returned from a search. */ public List getFields() { @@ -366,7 +366,7 @@ public class DataForm implements ExtensionElement { } /** - * + * * Represents items of reported data. * * @author Gaston Dombiak @@ -382,7 +382,7 @@ public class DataForm implements ExtensionElement { /** * Returns the fields that define the data that goes with the item. - * + * * @return the fields that define the data that goes with the item. */ public List getFields() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/provider/DataFormProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/provider/DataFormProvider.java index d884c4bfb..fcb3cb6a5 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/provider/DataFormProvider.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/provider/DataFormProvider.java @@ -37,7 +37,7 @@ import org.xmlpull.v1.XmlPullParserException; /** * The DataFormProvider parses DataForm packets. - * + * * @author Gaston Dombiak */ public class DataFormProvider extends ExtensionElementProvider { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java index 9507cd396..21edbce98 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java @@ -1,6 +1,6 @@ /** * - * Copyright 2014 Anno van Vliet + * Copyright 2014 Anno van Vliet * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,8 +25,8 @@ import org.jivesoftware.smack.util.XmlStringBuilder; /** * DataLayout Extension according to XEP-0141: Data Forms Layout. - * Defines a backwards-compatible extension to the XMPP Data Forms protocol that - * enables an application to specify form layouts, including the layout of + * Defines a backwards-compatible extension to the XMPP Data Forms protocol that + * enables an application to specify form layouts, including the layout of * form fields, sections within pages, and subsections within sections. * * @author Anno van Vliet @@ -61,7 +61,7 @@ public class DataLayout implements ExtensionElement { /** * Gets the value of the label property. - * + * * @return possible object is {@link String } */ public String getLabel() { @@ -136,7 +136,7 @@ public class DataLayout implements ExtensionElement { /** * Gets the value of the var property. - * + * * @return possible object is {@link String } */ public String getVar() { @@ -172,7 +172,7 @@ public class DataLayout implements ExtensionElement { * method for the sectionLayout property. *

    * For example, to add a new item, do as follows: - * + * * 

              * getSectionLayout().add(newItem);
          *
    @@ -199,7 +199,7 @@ public class DataLayout implements ExtensionElement { /** * Gets the value of the label property. - * + * * @return possible object is {@link String } */ public String getLabel() { @@ -252,7 +252,7 @@ public class DataLayout implements ExtensionElement { /** * Gets the value of the var property. - * + * * @return possible object is {@link String } */ public String getText() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java index e321901c8..3a0c8a33c 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java @@ -27,7 +27,7 @@ import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement; public class ValidationConsistencyException extends IllegalArgumentException { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java index 46c432355..d397c803d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java @@ -1,6 +1,6 @@ /** * - * Copyright 2014 Anno van Vliet + * Copyright 2014 Anno van Vliet * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,7 +47,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The 'datatype' attribute specifies the datatype. This attribute is OPTIONAL, and when not specified, defaults to * "xs:string". - * + * * @param datatype the data type of any value contained within the {@link FormField} element. */ private ValidateElement(String datatype) { @@ -65,7 +65,7 @@ public abstract class ValidateElement implements ExtensionElement { *
  • Start with "x:", and specify a user-defined datatype [4]
    • * - * + * * @return the datatype */ public String getDatatype() { @@ -116,7 +116,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * Check if this element is consistent according to the business rules in XEP=0122. - * + * * @param formField */ public abstract void checkConsistency(FormField formField); @@ -124,7 +124,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * Validation only against the datatype itself. Indicates that the value(s) should simply match the field type and * datatype constraints. - * + * * @see ValidateElement */ public static class BasicValidateElement extends ValidateElement { @@ -167,7 +167,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * For "list-single" or "list-multi", indicates that the user may enter a custom value (matching the datatype * constraints) or choose from the predefined values. - * + * * @see ValidateElement */ public static class OpenValidateElement extends ValidateElement { @@ -207,7 +207,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * Indicate that the value should fall within a certain range. - * + * * @see ValidateElement */ public static class RangeValidateElement extends ValidateElement { @@ -222,7 +222,7 @@ public abstract class ValidateElement implements ExtensionElement { * @param min the minimum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use. * @param max the maximum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use. * @see #getDatatype() - * + * */ public RangeValidateElement(String dataType, String min, String max) { super(dataType); @@ -240,7 +240,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The 'min' attribute specifies the minimum allowable value. - * + * * @return the minimum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use. */ public String getMin() { @@ -249,7 +249,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The 'max' attribute specifies the maximum allowable value. - * + * * @return the maximum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use. */ public String getMax() { @@ -273,7 +273,7 @@ public abstract class ValidateElement implements ExtensionElement { * defined for POSIX extended regular * expressions including support for Unicode. - * + * * @see ValidateElement */ public static class RegexValidateElement extends ValidateElement { @@ -294,7 +294,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * the expression is that defined for POSIX extended regular expressions, including support for Unicode. - * + * * @return the regex */ public String getRegex() { @@ -327,7 +327,7 @@ public abstract class ValidateElement implements ExtensionElement { * The 'max' attribute specifies the maximum allowable number of selected/entered values. The 'min' attribute * specifies the minimum allowable number of selected/entered values. Both attributes are optional, but at * least one must bet set, and the value must be within the range of a unsigned 32-bit integer. - * + * * @param min * @param max */ @@ -361,7 +361,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The minimum allowable number of selected/entered values. - * + * * @return a positive integer, can be null */ public Long getMin() { @@ -370,7 +370,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The maximum allowable number of selected/entered values. - * + * * @return a positive integer, can be null */ public Long getMax() { @@ -382,7 +382,7 @@ public abstract class ValidateElement implements ExtensionElement { /** * The >list-range/< element SHOULD be included only when the <field/> is of type "list-multi" and SHOULD be ignored * otherwise. - * + * * @param formField */ protected void checkListRangeConsistency(FormField formField) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLManager.java index b9518162a..665a10026 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLManager.java @@ -33,10 +33,10 @@ import org.jivesoftware.smackx.xhtmlim.packet.XHTMLExtension; import org.jxmpp.jid.Jid; /** - * Manages XHTML formatted texts within messages. A XHTMLManager provides a high level access to + * Manages XHTML formatted texts within messages. A XHTMLManager provides a high level access to * get and set XHTML bodies to messages, enable and disable XHTML support and check if remote XMPP - * clients support XHTML. - * + * clients support XHTML. + * * @author Gaston Dombiak */ public class XHTMLManager { @@ -51,7 +51,7 @@ public class XHTMLManager { } /** - * Returns an Iterator for the XHTML bodies in the message. Returns null if + * Returns an Iterator for the XHTML bodies in the message. Returns null if * the message does not contain an XHTML extension. * * @param message an XHTML message @@ -94,12 +94,12 @@ public class XHTMLManager { /** * Enables or disables the XHTML support on a given connection.

    - * + * * Before starting to send XHTML messages to a user, check that the user can handle XHTML - * messages. Enable the XHTML support to indicate that this client handles XHTML messages. + * messages. Enable the XHTML support to indicate that this client handles XHTML messages. * * @param connection the connection where the service will be enabled or disabled - * @param enabled indicates if the service will be enabled or disabled + * @param enabled indicates if the service will be enabled or disabled */ public static synchronized void setServiceEnabled(XMPPConnection connection, boolean enabled) { if (isServiceEnabled(connection) == enabled) @@ -129,10 +129,10 @@ public class XHTMLManager { * @param connection the connection to use to perform the service discovery * @param userID the user to check. A fully qualified xmpp ID, e.g. jdoe@example.com * @return a boolean indicating whether the specified user handles XHTML messages - * @throws XMPPErrorException - * @throws NoResponseException - * @throws NotConnectedException - * @throws InterruptedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws NotConnectedException + * @throws InterruptedException */ public static boolean isServiceEnabled(XMPPConnection connection, Jid userID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLText.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLText.java index cb37980ca..b08507ad0 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLText.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/XHTMLText.java @@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.Message; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * An XHTMLText represents formatted text. This class also helps to build valid + * An XHTMLText represents formatted text. This class also helps to build valid * XHTML tags. * * @author Gaston Dombiak @@ -34,7 +34,7 @@ public class XHTMLText { /** * Creates a new XHTMLText with body tag params. - * + * * @param style the XHTML style of the body * @param lang the language of the body */ @@ -48,7 +48,7 @@ public class XHTMLText { /** * Appends a tag that indicates that an anchor section begins. - * + * * @param href indicates the URL being linked to * @param style the XHTML style of the anchor * @return this. @@ -74,7 +74,7 @@ public class XHTMLText { public static final String BLOCKQUOTE = "blockquote"; /** * Appends a tag that indicates that a blockquote section begins. - * + * * @param style the XHTML style of the blockquote * @return this. */ @@ -97,7 +97,7 @@ public class XHTMLText { /** * Appends a tag that indicates that a body section begins. - * + * * @param style the XHTML style of the body * @param lang the language of the body * @return this. @@ -191,7 +191,7 @@ public class XHTMLText { /** * Appends a tag that indicates a header, a title of a section of the message. - * + * * @param level the level of the Header. It must be a value between 1 and 3 * @param style the XHTML style of the blockquote * @@ -209,7 +209,7 @@ public class XHTMLText { /** * Appends a tag that indicates that a header section ends. - * + * * @param level the level of the Header. It must be a value between 1 and 3 * @return this. */ @@ -225,7 +225,7 @@ public class XHTMLText { /** * Appends a tag that indicates an image. - * + * * @param align how text should flow around the picture * @param alt the text to show if you don't show the picture * @param height how tall is the picture @@ -250,7 +250,7 @@ public class XHTMLText { /** * Appends a tag that indicates the start of a new line item within a list. - * + * * @param style the style of the line item * * @return this. @@ -273,9 +273,9 @@ public class XHTMLText { } /** - * Appends a tag that creates an ordered list. "Ordered" means that the order of the items - * in the list is important. To show this, browsers automatically number the list. - * + * Appends a tag that creates an ordered list. "Ordered" means that the order of the items + * in the list is important. To show this, browsers automatically number the list. + * * @param style the style of the ordered list * * @return this. @@ -300,9 +300,9 @@ public class XHTMLText { public static final String UL = "ul"; /** - * Appends a tag that creates an unordered list. The unordered part means that the items + * Appends a tag that creates an unordered list. The unordered part means that the items * in the list are not in any particular order. - * + * * @param style the style of the unordered list * * @return this. @@ -327,9 +327,9 @@ public class XHTMLText { public static final String P = "p"; /** - * Appends a tag that indicates the start of a new paragraph. This is usually rendered + * Appends a tag that indicates the start of a new paragraph. This is usually rendered * with two carriage returns, producing a single blank line in between the two paragraphs. - * + * * @param style the style of the paragraph * * @return this. @@ -342,7 +342,7 @@ public class XHTMLText { } /** - * Appends a tag that indicates the end of a new paragraph. This is usually rendered + * Appends a tag that indicates the end of a new paragraph. This is usually rendered * with two carriage returns, producing a single blank line in between the two paragraphs. * * @return this. @@ -356,7 +356,7 @@ public class XHTMLText { /** * Appends a tag that indicates that an inlined quote section begins. - * + * * @param style the style of the inlined quote * * @return this. @@ -382,7 +382,7 @@ public class XHTMLText { /** * Appends a tag that allows to set the fonts for a span of text. - * + * * @param style the style for a span of text * * @return this. @@ -428,7 +428,7 @@ public class XHTMLText { /** * Appends a given text to the XHTMLText. - * + * * @param textToAppend the text to append * * @return this. @@ -440,8 +440,8 @@ public class XHTMLText { /** * Returns the text of the XHTMLText. - * - * @return the text of the XHTMLText + * + * @return the text of the XHTMLText */ @Override public String toString() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java index 059137b25..3653f56b1 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xhtmlim/packet/XHTMLExtension.java @@ -26,7 +26,7 @@ import org.jivesoftware.smack.packet.Message; import org.jivesoftware.smack.util.XmlStringBuilder; /** - * An XHTML sub-packet, which is used by XMPP clients to exchange formatted text. The XHTML + * An XHTML sub-packet, which is used by XMPP clients to exchange formatted text. The XHTML * extension is only a subset of XHTML 1.0. *

    * The following link summarizes the requirements of XHTML IM: @@ -53,7 +53,7 @@ public class XHTMLExtension implements ExtensionElement { return ELEMENT; } - /** + /** * Returns the XML namespace of the extension sub-packet root element. * According the specification the namespace is always "http://jabber.org/protocol/xhtml-im" * @@ -66,7 +66,7 @@ public class XHTMLExtension implements ExtensionElement { /** * Returns the XML representation of a XHTML extension according the specification. - * + * * Usually the XML representation will be inside of a Message XML representation like * in the following example: * 

    @@ -78,7 +78,7 @@ public class XHTMLExtension implements ExtensionElement {
      *     </html>
      * </message>
      *
    - * + * */ @Override public XmlStringBuilder toXML(String enclosingNamespace) { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListenerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListenerTest.java index c93d27a21..373619818 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListenerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/CloseListenerTest.java @@ -35,7 +35,7 @@ import org.powermock.reflect.Whitebox; /** * Test for the CloseListener class. - * + * * @author Henning Staib */ public class CloseListenerTest extends InitExtensions { @@ -46,7 +46,7 @@ public class CloseListenerTest extends InitExtensions { /** * If a close request to an unknown session is received it should be replied * with an <item-not-found/> error. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java index ebd52489c..36ca56058 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/DataListenerTest.java @@ -36,7 +36,7 @@ import org.powermock.reflect.Whitebox; /** * Test for the CloseListener class. - * + * * @author Henning Staib */ public class DataListenerTest extends InitExtensions { @@ -47,7 +47,7 @@ public class DataListenerTest extends InitExtensions { /** * If a data stanza of an unknown session is received it should be replied * with an <item-not-found/> error. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/IBBPacketUtils.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/IBBPacketUtils.java index 37a0e3f6d..28404544b 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/IBBPacketUtils.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/IBBPacketUtils.java @@ -25,14 +25,14 @@ import org.jxmpp.jid.Jid; /** * Utility methods to create packets. - * + * * @author Henning Staib */ public class IBBPacketUtils { /** * Returns an error IQ. - * + * * @param from the senders JID * @param to the recipients JID * @param condition the XMPP error condition @@ -49,7 +49,7 @@ public class IBBPacketUtils { /** * Returns a result IQ. - * + * * @param from the senders JID * @param to the recipients JID * @return a result IQ diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java index b130eddce..b707836c9 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java @@ -43,7 +43,7 @@ import org.jxmpp.jid.JidTestUtil; /** * Test for InBandBytestreamManager. - * + * * @author Henning Staib */ public class InBandBytestreamManagerTest extends InitExtensions { @@ -61,9 +61,9 @@ public class InBandBytestreamManagerTest extends InitExtensions { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -105,9 +105,9 @@ public class InBandBytestreamManagerTest extends InitExtensions { * Invoking {@link InBandBytestreamManager#establishSession(org.jxmpp.jid.Jid)} should * throw an exception if the given target does not support in-band * bytestream. - * @throws SmackException - * @throws XMPPException - * @throws InterruptedException + * @throws SmackException + * @throws XMPPException + * @throws InterruptedException */ @Test public void shouldFailIfTargetDoesNotSupportIBB() throws SmackException, XMPPException, InterruptedException { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java index 75a461e5f..44bbc0dd2 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java @@ -37,7 +37,7 @@ import org.mockito.ArgumentCaptor; /** * Test for InBandBytestreamRequest. - * + * * @author Henning Staib */ public class InBandBytestreamRequestTest extends InitExtensions { @@ -71,8 +71,8 @@ public class InBandBytestreamRequestTest extends InitExtensions { /** * Test reject() method. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ @Test public void shouldReplyWithErrorIfRequestIsRejected() throws NotConnectedException, InterruptedException { @@ -96,7 +96,7 @@ public class InBandBytestreamRequestTest extends InitExtensions { /** * Test accept() method. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java index 92863ed1c..5df280e0a 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java @@ -51,7 +51,7 @@ import org.powermock.reflect.Whitebox; * Test for InBandBytestreamSession. *

    * Tests sending data encapsulated in message stanzas. - * + * * @author Henning Staib */ public class InBandBytestreamSessionMessageTest extends InitExtensions { @@ -77,9 +77,9 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -115,7 +115,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the output stream write(byte[]) method. - * + * * @throws Exception should not happen */ @Test @@ -140,7 +140,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the output stream write(byte) method. - * + * * @throws Exception should not happen */ @Test @@ -167,7 +167,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the output stream write(byte[], int, int) method. - * + * * @throws Exception should not happen */ @Test @@ -196,7 +196,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the output stream flush() method. - * + * * @throws Exception should not happen */ @Test @@ -223,7 +223,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test successive calls to the output stream flush() method. - * + * * @throws Exception should not happen */ @Test @@ -252,7 +252,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * If a data stanza is received out of order the session should be closed. See XEP-0047 Section * 2.2. - * + * * @throws Exception should not happen */ @Test @@ -292,7 +292,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the input stream read(byte[], int, int) method. - * + * * @throws Exception should not happen */ @Test @@ -337,7 +337,7 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions { /** * Test the input stream read() method. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java index 425cffe2e..b19c9cc44 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java @@ -52,7 +52,7 @@ import org.powermock.reflect.Whitebox; *

    * Tests the basic behavior of an In-Band Bytestream session along with sending data encapsulated in * IQ stanzas. - * + * * @author Henning Staib */ public class InBandBytestreamSessionTest extends InitExtensions { @@ -78,9 +78,9 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -114,7 +114,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the output stream write(byte[]) method. - * + * * @throws Exception should not happen */ @Test @@ -140,7 +140,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the output stream write(byte) method. - * + * * @throws Exception should not happen */ @Test @@ -168,7 +168,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the output stream write(byte[], int, int) method. - * + * * @throws Exception should not happen */ @Test @@ -198,7 +198,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the output stream flush() method. - * + * * @throws Exception should not happen */ @Test @@ -226,7 +226,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test successive calls to the output stream flush() method. - * + * * @throws Exception should not happen */ @Test @@ -255,7 +255,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test that the data is correctly chunked. - * + * * @throws Exception should not happen */ @Test @@ -298,7 +298,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If the input stream is closed the output stream should not be closed as well. - * + * * @throws Exception should not happen */ @Test @@ -337,7 +337,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Valid data packets should be confirmed. - * + * * @throws Exception should not happen */ @Test @@ -363,7 +363,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If the data stanza has a sequence that is already used an 'unexpected-request' error should * be returned. See XEP-0047 Section 2.2. - * + * * @throws Exception should not happen */ @Test @@ -405,7 +405,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If the data stanza contains invalid Base64 encoding an 'bad-request' error should be * returned. See XEP-0047 Section 2.2. - * + * * @throws Exception should not happen */ @Test @@ -441,7 +441,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If a data stanza is received out of order the session should be closed. See XEP-0047 Section * 2.2. - * + * * @throws Exception should not happen */ @Test @@ -484,7 +484,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the input stream read(byte[], int, int) method. - * + * * @throws Exception should not happen */ @Test @@ -531,7 +531,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * Test the input stream read() method. - * + * * @throws Exception should not happen */ @Test @@ -575,7 +575,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If the output stream is closed the input stream should not be closed as well. - * + * * @throws Exception should not happen */ @Test @@ -618,7 +618,7 @@ public class InBandBytestreamSessionTest extends InitExtensions { /** * If the input stream is closed concurrently there should be no deadlock. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListenerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListenerTest.java index 7947f0a05..76c6647c6 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListenerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InitiationListenerTest.java @@ -39,7 +39,7 @@ import org.powermock.reflect.Whitebox; /** * Test for the InitiationListener class. - * + * * @author Henning Staib */ public class InitiationListenerTest extends InitExtensions { @@ -78,7 +78,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If no listeners are registered for incoming In-Band Bytestream requests, all request should * be rejected with an error. - * + * * @throws Exception should not happen */ @Test @@ -105,7 +105,7 @@ public class InitiationListenerTest extends InitExtensions { /** * Open request with a block size that exceeds the maximum block size should be replied with an * resource-constraint error. - * + * * @throws Exception should not happen */ @Test @@ -132,7 +132,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If a listener for all requests is registered it should be notified on incoming requests. - * + * * @throws Exception should not happen */ @Test @@ -160,7 +160,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If a listener for a specific user in registered it should be notified on incoming requests * for that user. - * + * * @throws Exception should not happen */ @Test @@ -188,7 +188,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If listener for a specific user is registered it should not be notified on incoming requests * from other users. - * + * * @throws Exception should not happen */ @Test @@ -222,7 +222,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If a user specific listener and an all requests listener is registered only the user specific * listener should be notified. - * + * * @throws Exception should not happen */ @Test @@ -255,7 +255,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If a user specific listener and an all requests listener is registered only the all requests * listener should be notified on an incoming request for another user. - * + * * @throws Exception should not happen */ @Test @@ -288,7 +288,7 @@ public class InitiationListenerTest extends InitExtensions { /** * If a request with a specific session ID should be ignored no listeners should be notified. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/CloseTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/CloseTest.java index d300046d3..4adb4857b 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/CloseTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/CloseTest.java @@ -32,7 +32,7 @@ import org.jxmpp.jid.impl.JidCreate; /** * Test for the Close class. - * + * * @author Henning Staib */ public class CloseTest extends InitExtensions { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtensionTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtensionTest.java index 45fd55835..f3c881aa6 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtensionTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtensionTest.java @@ -32,7 +32,7 @@ import org.junit.Test; /** * Test for the DataPacketExtension class. - * + * * @author Henning Staib */ public class DataPacketExtensionTest extends InitExtensions { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataTest.java index 3484686d7..ea53cf94c 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataTest.java @@ -34,7 +34,7 @@ import org.jxmpp.jid.impl.JidCreate; /** * Test for the Data class. - * + * * @author Henning Staib */ public class DataTest extends InitExtensions { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/OpenTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/OpenTest.java index dc15a5239..730035ced 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/OpenTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/packet/OpenTest.java @@ -33,7 +33,7 @@ import org.jxmpp.jid.impl.JidCreate; /** * Test for the Open class. - * + * * @author Henning Staib */ public class OpenTest extends InitExtensions { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProviderTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProviderTest.java index bcc22e1ee..ef0918c31 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProviderTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/provider/OpenIQProviderTest.java @@ -34,7 +34,7 @@ import org.xmlpull.v1.XmlPullParserFactory; /** * Test for the OpenIQProvider class. - * + * * @author Henning Staib */ public class OpenIQProviderTest extends InitExtensions { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListenerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListenerTest.java index bb6eb109d..5db3fd84d 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListenerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/InitiationListenerTest.java @@ -41,7 +41,7 @@ import org.powermock.reflect.Whitebox; /** * Test for the InitiationListener class. - * + * * @author Henning Staib */ public class InitiationListenerTest { @@ -88,7 +88,7 @@ public class InitiationListenerTest { /** * If no listeners are registered for incoming SOCKS5 Bytestream requests, all request should be * rejected with an error. - * + * * @throws Exception should not happen */ @Test @@ -111,7 +111,7 @@ public class InitiationListenerTest { /** * If a listener for all requests is registered it should be notified on incoming requests. - * + * * @throws Exception should not happen */ @Test @@ -136,7 +136,7 @@ public class InitiationListenerTest { /** * If a listener for a specific user in registered it should be notified on incoming requests * for that user. - * + * * @throws Exception should not happen */ @Test @@ -161,7 +161,7 @@ public class InitiationListenerTest { /** * If listener for a specific user is registered it should not be notified on incoming requests * from other users. - * + * * @throws Exception should not happen */ @Test @@ -192,7 +192,7 @@ public class InitiationListenerTest { /** * If a user specific listener and an all requests listener is registered only the user specific * listener should be notified. - * + * * @throws Exception should not happen */ @Test @@ -222,7 +222,7 @@ public class InitiationListenerTest { /** * If a user specific listener and an all requests listener is registered only the all requests * listener should be notified on an incoming request for another user. - * + * * @throws Exception should not happen */ @Test @@ -254,7 +254,7 @@ public class InitiationListenerTest { /** * If a request with a specific session ID should be ignored no listeners should be notified. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java index 6d96bcedc..251c4fa89 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java @@ -60,7 +60,7 @@ import org.jxmpp.stringprep.XmppStringprepException; /** * Test for Socks5BytestreamManager. - * + * * @author Henning Staib */ public class Socks5ByteStreamManagerTest { @@ -81,9 +81,9 @@ public class Socks5ByteStreamManagerTest { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -146,7 +146,7 @@ public class Socks5ByteStreamManagerTest { /** * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid)} should throw an exception * if the given target does not support SOCKS5 Bytestream. - * @throws XMPPException + * @throws XMPPException */ @Test public void shouldFailIfTargetDoesNotSupportSocks5() throws XMPPException { @@ -462,7 +462,7 @@ public class Socks5ByteStreamManagerTest { /** * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if the * proxy used by target is invalid. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void shouldFailIfTargetUsesInvalidSocks5Proxy() throws XmppStringprepException { @@ -638,7 +638,7 @@ public class Socks5ByteStreamManagerTest { /** * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should successfully * negotiate and return a SOCKS5 Bytestream connection. - * + * * @throws Exception should not happen */ @Test @@ -753,7 +753,7 @@ public class Socks5ByteStreamManagerTest { /** * If multiple network addresses are added to the local SOCKS5 proxy, all of them should be * contained in the SOCKS5 Bytestream request. - * + * * @throws Exception should not happen */ @Test @@ -852,7 +852,7 @@ public class Socks5ByteStreamManagerTest { * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} the first time * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy and should * prioritize this proxy for a second SOCKS5 Bytestream negotiation. - * + * * @throws Exception should not happen */ @Test @@ -937,7 +937,7 @@ public class Socks5ByteStreamManagerTest { * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} the first time * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy. The second * negotiation should run in the same manner if prioritization is disabled. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java index 371df7597..9811d5f39 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java @@ -49,7 +49,7 @@ import org.jxmpp.jid.impl.JidCreate; /** * Tests for the Socks5BytestreamRequest class. - * + * * @author Henning Staib */ public class Socks5ByteStreamRequestTest { @@ -67,9 +67,9 @@ public class Socks5ByteStreamRequestTest { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -85,7 +85,7 @@ public class Socks5ByteStreamRequestTest { /** * Accepting a SOCKS5 Bytestream request should fail if the request doesn't contain any Socks5 * proxies. - * + * * @throws Exception should not happen */ @Test @@ -127,7 +127,7 @@ public class Socks5ByteStreamRequestTest { /** * Accepting a SOCKS5 Bytestream request should fail if target is not able to connect to any of * the provided SOCKS5 proxies. - * + * * @throws Exception */ @Test @@ -170,7 +170,7 @@ public class Socks5ByteStreamRequestTest { /** * Target should not try to connect to SOCKS5 proxies that already failed twice. - * + * * @throws Exception should not happen */ @Test @@ -259,7 +259,7 @@ public class Socks5ByteStreamRequestTest { /** * Target should not not blacklist any SOCKS5 proxies regardless of failing connections. - * + * * @throws Exception should not happen */ @Test @@ -316,7 +316,7 @@ public class Socks5ByteStreamRequestTest { * If the SOCKS5 Bytestream request contains multiple SOCKS5 proxies and the first one doesn't * respond, the connection attempt to this proxy should not consume the whole timeout for * connecting to the proxies. - * + * * @throws Exception should not happen */ @Test @@ -381,7 +381,7 @@ public class Socks5ByteStreamRequestTest { /** * Accepting the SOCKS5 Bytestream request should be successfully. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiatorTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiatorTest.java index 744ffcd9e..393187fe5 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiatorTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiatorTest.java @@ -50,7 +50,7 @@ import org.jxmpp.jid.JidTestUtil; /** * Test for Socks5ClientForInitiator class. - * + * * @author Henning Staib */ public class Socks5ClientForInitiatorTest { @@ -74,9 +74,9 @@ public class Socks5ClientForInitiatorTest { /** * Initialize fields used in the tests. - * @throws XMPPException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws SmackException + * @throws InterruptedException */ @Before public void setup() throws XMPPException, SmackException, InterruptedException { @@ -90,7 +90,7 @@ public class Socks5ClientForInitiatorTest { /** * If the target is not connected to the local SOCKS5 proxy an exception should be thrown. - * + * * @throws Exception should not happen */ @Test @@ -128,7 +128,7 @@ public class Socks5ClientForInitiatorTest { /** * Initiator and target should successfully connect to the local SOCKS5 proxy. - * + * * @throws Exception should not happen */ @Test @@ -197,7 +197,7 @@ public class Socks5ClientForInitiatorTest { /** * If the initiator can connect to a SOCKS5 proxy but activating the stream fails an exception * should be thrown. - * + * * @throws Exception should not happen */ @Test @@ -241,7 +241,7 @@ public class Socks5ClientForInitiatorTest { /** * Target and initiator should successfully connect to a "remote" SOCKS5 proxy and the initiator * activates the bytestream. - * + * * @throws Exception should not happen */ @Test diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java index e836e5d4c..430b83f5b 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java @@ -40,7 +40,7 @@ import org.jxmpp.jid.JidTestUtil; /** * Test for Socks5Client class. - * + * * @author Henning Staib */ public class Socks5ClientTest { @@ -54,7 +54,7 @@ public class Socks5ClientTest { /** * Initialize fields used in the tests. - * + * * @throws Exception should not happen */ @Before @@ -68,7 +68,7 @@ public class Socks5ClientTest { /** * A SOCKS5 client MUST close connection if server doesn't accept any of the given * authentication methods. (See RFC1928 Section 3) - * + * * @throws Exception should not happen */ @Test @@ -126,7 +126,7 @@ public class Socks5ClientTest { /** * The SOCKS5 client should close connection if server replies in an unsupported way. - * + * * @throws Exception should not happen */ @Test @@ -188,7 +188,7 @@ public class Socks5ClientTest { /** * The SOCKS5 client should close connection if server replies with an error. - * + * * @throws Exception should not happen */ @Test @@ -254,7 +254,7 @@ public class Socks5ClientTest { /** * The SOCKS5 client should successfully connect to the SOCKS5 server. - * + * * @throws Exception should not happen */ @Test @@ -330,7 +330,7 @@ public class Socks5ClientTest { /** * Close fake SOCKS5 proxy. - * + * * @throws Exception should not happen */ @After diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java index f0c768e7a..d6e9ca3b1 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5PacketUtils.java @@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid; /** * A collection of utility methods to create XMPP packets. - * + * * @author Henning Staib */ public class Socks5PacketUtils { @@ -35,7 +35,7 @@ public class Socks5PacketUtils { /** * Returns a SOCKS5 Bytestream initialization request packet. The Request doesn't contain any * SOCKS5 proxies. - * + * * @param from the initiator * @param to the target * @param sessionID the session ID @@ -53,7 +53,7 @@ public class Socks5PacketUtils { /** * Returns a response to a SOCKS5 Bytestream initialization request. The stanza doesn't contain * the uses-host information. - * + * * @param from the target * @param to the initiator * @return response to a SOCKS5 Bytestream initialization request @@ -68,7 +68,7 @@ public class Socks5PacketUtils { /** * Returns a response to an item discovery request. The stanza doesn't contain any items. - * + * * @param from the XMPP server * @param to the XMPP client * @return response to an item discovery request @@ -83,7 +83,7 @@ public class Socks5PacketUtils { /** * Returns a response to an info discovery request. The stanza doesn't contain any infos. - * + * * @param from the target * @param to the initiator * @return response to an info discovery request @@ -98,7 +98,7 @@ public class Socks5PacketUtils { /** * Returns a response IQ for a activation request to the proxy. - * + * * @param from JID of the proxy * @param to JID of the client who wants to activate the SOCKS5 Bytestream * @return response IQ for a activation request to the proxy diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java index 208efeeef..180838e29 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java @@ -35,7 +35,7 @@ import org.jivesoftware.smack.util.StringUtils; /** * Simple SOCKS5 proxy for testing purposes. It is almost the same as the Socks5Proxy class but the * port can be configured more easy and it all connections are allowed. - * + * * @author Henning Staib */ public final class Socks5TestProxy { @@ -71,7 +71,7 @@ public final class Socks5TestProxy { /** * Returns the local SOCKS5 proxy server. - * + * * @param port of the test proxy * @return the local SOCKS5 proxy server */ @@ -144,7 +144,7 @@ public final class Socks5TestProxy { /** * Returns the host address of the local SOCKS5 proxy server. - * + * * @return the host address of the local SOCKS5 proxy server */ public static String getAddress() { @@ -158,7 +158,7 @@ public final class Socks5TestProxy { /** * Returns the port of the local SOCKS5 proxy server. If it is not running -1 will be returned. - * + * * @return the port of the local SOCKS5 proxy server or -1 if proxy is not running */ public int getPort() { @@ -170,7 +170,7 @@ public final class Socks5TestProxy { /** * Returns the socket for the given digest. - * + * * @param digest identifying the connection * @return socket or null if there is no socket for the given digest */ @@ -193,7 +193,7 @@ public final class Socks5TestProxy { /** * Returns true if the local SOCKS5 proxy server is running, otherwise false. - * + * * @return true if the local SOCKS5 proxy server is running, otherwise false */ public boolean isRunning() { @@ -202,7 +202,7 @@ public final class Socks5TestProxy { /** * Implementation of a simplified SOCKS5 proxy server. - * + * * @author Henning Staib */ class Socks5ServerProcess implements Runnable { @@ -248,7 +248,7 @@ public final class Socks5TestProxy { /** * Negotiates a SOCKS5 connection and stores it on success. - * + * * @param socket connection to the client * @throws SmackException if client requests a connection in an unsupported way * @throws IOException if a network error occurred diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java index 4c019c9a2..b912f8544 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java @@ -47,7 +47,7 @@ public class EntityCapsManagerTest extends InitExtensions { /** * XEP- * 0115 Complex Generation Example. - * @throws XmppStringprepException + * @throws XmppStringprepException */ @Test public void testComplexGenerationExample() throws XmppStringprepException { diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/delay/provider/DelayInformationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/delay/provider/DelayInformationTest.java index 692a225d1..7a4c6756c 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/delay/provider/DelayInformationTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/delay/provider/DelayInformationTest.java @@ -60,7 +60,7 @@ public class DelayInformationTest extends InitExtensions { String control; GregorianCalendar calendar = new GregorianCalendar(2002, 9 - 1, 10, 23, 8, 25); calendar.setTimeZone(TimeZone.getTimeZone("UTC")); - Date date = calendar.getTime(); + Date date = calendar.getTime(); control = XMLBuilder.create("x") .a("xmlns", "jabber:x:delay") @@ -112,7 +112,7 @@ public class DelayInformationTest extends InitExtensions { delayInfo = p.parse(PacketParserUtils.getParserFor(control)); - GregorianCalendar cal = (GregorianCalendar) calendar.clone(); + GregorianCalendar cal = (GregorianCalendar) calendar.clone(); cal.add(Calendar.MILLISECOND, 120); assertEquals(cal.getTime(), delayInfo.getStamp()); diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/packet/GeoLocationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/packet/GeoLocationTest.java index 1bb34b040..a80748377 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/packet/GeoLocationTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/packet/GeoLocationTest.java @@ -34,7 +34,7 @@ import org.jxmpp.util.XmppDateTime; /** * Unit tests for GeoLocation. - * + * * @author Ishan Khanna */ public class GeoLocationTest extends InitExtensions { @@ -84,7 +84,7 @@ public class GeoLocationTest extends InitExtensions { public void toXMLMethodTest() throws Exception { // @formatter:off - final String geoLocationMessageString = "" + "" + "23" diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/provider/GeoLocationProviderTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/provider/GeoLocationProviderTest.java index 5437e6dbc..4cf5b5f6a 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/provider/GeoLocationProviderTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/geoloc/provider/GeoLocationProviderTest.java @@ -36,7 +36,7 @@ public class GeoLocationProviderTest extends InitExtensions { @Test public void testGeoLocationProviderWithNoDatumSet() throws Exception { // @formatter:off - final String geoLocationString = "" + "" + "23" @@ -104,7 +104,7 @@ public class GeoLocationProviderTest extends InitExtensions { public void testGeoLocationWithDatumSet() throws Exception { // @formatter:off - final String geoLocationString = "" + "" + "23" @@ -173,7 +173,7 @@ public class GeoLocationProviderTest extends InitExtensions { public void testGeoLocationWithoutAccuracySetAndWithErrorSet() throws Exception { // @formatter:off - final String geoLocationString = "" + "" + "90" @@ -193,7 +193,7 @@ public class GeoLocationProviderTest extends InitExtensions { public void testGeoLocationWithAccuracySetAndWithoutErrorSet() throws Exception { // @formatter:off - final String geoLocationString = "" + "" + "90" @@ -213,7 +213,7 @@ public class GeoLocationProviderTest extends InitExtensions { public void testGeoLocationWithAccuracySetAndErrorSet() throws Exception { // @formatter:off - final String geoLocationString = "" + "" + "90" diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java index 33f836ba2..18a528d90 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java @@ -47,7 +47,7 @@ public class PingTest extends InitExtensions { public void checkProvider() throws Exception { // @formatter:off String control = "" - + "" + + "" + ""; // @formatter:on DummyConnection con = new DummyConnection(); @@ -98,10 +98,10 @@ public class PingTest extends InitExtensions { /** * DummyConnection will not reply so it will timeout. - * @throws SmackException - * @throws XMPPException - * @throws IOException - * @throws InterruptedException + * @throws SmackException + * @throws XMPPException + * @throws IOException + * @throws InterruptedException */ @Test public void checkFailedPingOnTimeout() throws SmackException, IOException, XMPPException, InterruptedException { @@ -125,12 +125,12 @@ public class PingTest extends InitExtensions { public void checkFailedPingToEntityError() throws Exception { ThreadedDummyConnection threadedCon = getAuthenticatedDummyConnection(); // @formatter:off - String reply = + String reply = "" + "" + "" + "" + - "" + + "" + ""; // @formatter:on IQ serviceUnavailable = PacketParserUtils.parseStanza(reply); @@ -161,12 +161,12 @@ public class PingTest extends InitExtensions { public void checkPingToServerError() throws Exception { ThreadedDummyConnection con = getAuthenticatedDummyConnection(); // @formatter:off - String reply = + String reply = "" + "" + "" + "" + - "" + + "" + ""; // @formatter:on IQ serviceUnavailable = PacketParserUtils.parseStanza(reply); @@ -195,7 +195,7 @@ public class PingTest extends InitExtensions { info.addFeature(Ping.NAMESPACE); // @formatter:off - String reply = + String reply = "" + "" + "" + @@ -217,7 +217,7 @@ public class PingTest extends InitExtensions { info.addFeature(Ping.NAMESPACE); // @formatter:off - String reply = + String reply = "" + "" + "" + @@ -241,12 +241,12 @@ public class PingTest extends InitExtensions { /** * The returned connection won't send replies to IQs - * + * * @return - * @throws XMPPException - * @throws IOException - * @throws SmackException - * @throws InterruptedException + * @throws XMPPException + * @throws IOException + * @throws SmackException + * @throws InterruptedException */ private static DummyConnection getAuthenticatedDummyConnectionWithoutIqReplies() throws SmackException, IOException, XMPPException, InterruptedException { DummyConnection con = new DummyConnection(); diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java index 4069d7a12..ab1b38aae 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java @@ -97,8 +97,8 @@ public class ItemValidationTest extends InitExtensions { "" + "" + "" + - "" + - "" + + "" + + "" + ""); Stanza message = PacketParserUtils.parseMessage(parser); @@ -126,9 +126,9 @@ public class ItemValidationTest extends InitExtensions { "" + "" + itemContent + - "" + - "" + - "" + + "" + + "" + + "" + ""); Stanza message = PacketParserUtils.parseMessage(parser); @@ -150,7 +150,7 @@ public class ItemValidationTest extends InitExtensions { @Test public void parseComplexItem() throws Exception { - String itemContent = + String itemContent = "" + "Soliloquy" + "

    " + @@ -172,9 +172,9 @@ public class ItemValidationTest extends InitExtensions { "" + "" + itemContent + - "" + - "" + - "" + + "" + + "" + + "" + ""); Stanza message = PacketParserUtils.parseMessage(parser); @@ -204,9 +204,9 @@ public class ItemValidationTest extends InitExtensions { "" + "" + itemContent + - "" + - "" + - "" + + "" + + "" + + "" + ""); Stanza message = PacketParserUtils.parseMessage(parser); diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/provider/PubSubProviderTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/provider/PubSubProviderTest.java index faa734d5e..865b185fb 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/provider/PubSubProviderTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/provider/PubSubProviderTest.java @@ -38,10 +38,10 @@ public class PubSubProviderTest { @Test public void subscriptionsOwnerResultTest() throws Exception { // @formatter:off - final String resultStanza = + final String resultStanza = "" + - "" + - "" + + "" + + "" + "" + "" + "" + diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/shim/provider/HeadersProviderTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/shim/provider/HeadersProviderTest.java index 3279c433f..ab9c66350 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/shim/provider/HeadersProviderTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/shim/provider/HeadersProviderTest.java @@ -33,9 +33,9 @@ public class HeadersProviderTest { @Test public void headersInMessageTest() throws Exception { // @formatter:off - final String messageStanza = + final String messageStanza = "" + - "Wherefore are thou?!?" + + "Wherefore are thou?!?" + "" + "
    high
    " + "    " + diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayoutTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayoutTest.java index 5b3d5018e..9dcc5e113 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayoutTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayoutTest.java @@ -1,6 +1,6 @@ /** * - * Copyright 2014 Anno van Vliet, All rights reserved. + * Copyright 2014 Anno van Vliet, All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java index 96a5369e9..92641d57e 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java +++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java @@ -171,8 +171,8 @@ public class DataValidationTest { /** * @param output * @return - * @throws XmlPullParserException - * @throws IOException + * @throws XmlPullParserException + * @throws IOException */ private static XmlPullParser getParser(String output) throws XmlPullParserException, IOException { return TestUtils.getParser(output, "validate"); diff --git a/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java b/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java index cc2f51391..79f0db915 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java +++ b/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java @@ -40,7 +40,7 @@ import org.mockito.stubbing.Answer; /** * A collection of utility methods to create mocked XMPP connections. - * + * * @author Henning Staib */ public class ConnectionUtils { @@ -52,7 +52,7 @@ public class ConnectionUtils { *

    * This mocked connection can used to collect packets that require a reply using a * StanzaCollector. - * + * * 

          * 
      *   StanzaCollector collector = connection.createStanzaCollector(new PacketFilter());
@@ -60,13 +60,13 @@ public class ConnectionUtils {
      *   Stanza reply = collector.nextResult();
      * 
      *
    - * + * * @param protocol protocol helper containing answer packets * @param initiatorJID the user associated to the XMPP connection * @return a mocked XMPP connection - * @throws SmackException - * @throws XMPPErrorException - * @throws InterruptedException + * @throws SmackException + * @throws XMPPErrorException + * @throws InterruptedException */ public static XMPPConnection createMockedConnection(final Protocol protocol, EntityFullJid initiatorJID) throws SmackException, XMPPErrorException, InterruptedException { diff --git a/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java b/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java index 3cb075bdc..2c9a3084a 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java +++ b/smack-extensions/src/test/java/org/jivesoftware/util/Protocol.java @@ -38,7 +38,7 @@ import org.jivesoftware.smack.util.XmlUtil; *
    • * * Example: - * + * * 
      * 
  * public void methodToTest() {
@@ -47,7 +47,7 @@ import org.jivesoftware.smack.util.XmlUtil;
  *   connection.sendStanza(packet);
  *   Stanza reply = collector.nextResult();
  * }
- * 
+ *
  * public void testMethod() {
  *   EntityFullJid userJid = JidCreate.entityFullFrom("user@xmpp-server.org");
  *   DomainBareJid serverJid = JidCreate.domainBareFrom("user-server.org");
@@ -55,20 +55,20 @@ import org.jivesoftware.smack.util.XmlUtil;
  *   Protocol protocol = new Protocol();
  *   // create mocked connection
  *   XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, userJid, serverJid);
- *   
+ *
  *   // add reply stanza to protocol
  *   Stanza reply = new Packet();
  *   protocol.add(reply);
- *   
+ *
  *   // call method to test
  *   methodToTest();
- *   
+ *
  *   // verify protocol
  *   protocol.verifyAll();
  * }
  * 
  *
    - * + * * Additionally to adding the response to the protocol instance you can pass * verifications that will be executed when {@link #verifyAll()} is invoked. * (See {@link Verification} for more details.) @@ -77,7 +77,7 @@ import org.jivesoftware.smack.util.XmlUtil; * also print out the XML messages in the order they are sent to the console. * This may be useful to inspect the whole protocol "by hand". *

    - * + * * @author Henning Staib */ public class Protocol { @@ -103,7 +103,7 @@ public class Protocol { /** * Adds a responses and all verifications for the request/response pair to * the protocol. - * + * * @param response the response for a request * @param verifications verifications for request/response pair */ @@ -155,7 +155,7 @@ public class Protocol { /** * Returns the responses queue. - * + * * @return the responses queue */ protected Queue getResponses() { @@ -164,7 +164,7 @@ public class Protocol { /** * Returns a list of all collected requests. - * + * * @return list of requests */ public List getRequests() { diff --git a/smack-extensions/src/test/java/org/jivesoftware/util/Verification.java b/smack-extensions/src/test/java/org/jivesoftware/util/Verification.java index bbf643fda..85b911a34 100644 --- a/smack-extensions/src/test/java/org/jivesoftware/util/Verification.java +++ b/smack-extensions/src/test/java/org/jivesoftware/util/Verification.java @@ -25,10 +25,10 @@ import org.jivesoftware.smack.packet.Stanza; * Implement this interface to verify a request/response pair. *

    * For convenience there are some useful predefined implementations. - * + * * @param class of the request * @param class of the response - * + * * @author Henning Staib */ public interface Verification { @@ -96,7 +96,7 @@ public interface Verification { /** * Implement this method to make assertions of the request/response pairs. - * + * * @param request the request collected by the mocked XMPP connection * @param response the response added to the protocol instance */ diff --git a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java index 29cfda5ca..8982b948e 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java @@ -35,7 +35,7 @@ import org.jxmpp.jid.EntityJid; * don't send thread IDs at all. Therefore, if a message without a thread ID * arrives it is routed to the most recently created Chat with the message * sender. - * + * * @author Matt Tucker * @deprecated use org.jivesoftware.smack.chat2.Chat from smack-extensions instead. */ @@ -94,8 +94,8 @@ public class Chat { * * * @param text the text to send. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendMessage(String text) throws NotConnectedException, InterruptedException { Message message = new Message(); @@ -108,8 +108,8 @@ public class Chat { * and message type of the message will automatically set to those of this chat. * * @param message the message to send. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void sendMessage(Message message) throws NotConnectedException, InterruptedException { // Force the recipient, message type, and thread ID since the user elected diff --git a/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatManager.java b/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatManager.java index d621713c4..a811fe1f3 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatManager.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatManager.java @@ -96,7 +96,7 @@ public final class ChatManager extends Manager{ */ NONE, /** - * Will match on the JID in the from field of the message. + * Will match on the JID in the from field of the message. */ SUPPLIED_JID, /** @@ -116,7 +116,7 @@ public final class ChatManager extends Manager{ }); /** - * Determines whether incoming messages of type normal can create chats. + * Determines whether incoming messages of type normal can create chats. */ private boolean normalIncluded = defaultIsNormalInclude; @@ -180,7 +180,7 @@ public final class ChatManager extends Manager{ /** * Determines whether incoming messages of type normal will be used for creating new chats or matching * a message to existing ones. - * + * * @return true if normal is allowed, false otherwise. */ public boolean isNormalIncluded() { @@ -190,7 +190,7 @@ public final class ChatManager extends Manager{ /** * Sets whether to allow incoming messages of type normal to be used for creating new chats or matching * a message to an existing one. - * + * * @param normalIncluded true to allow normal, false otherwise. */ public void setNormalIncluded(boolean normalIncluded) { @@ -199,7 +199,7 @@ public final class ChatManager extends Manager{ /** * Gets the current mode for matching messages with NO thread id to existing chats. - * + * * @return The current mode. */ public MatchMode getMatchMode() { @@ -208,7 +208,7 @@ public final class ChatManager extends Manager{ /** * Sets the mode for matching messages with NO thread id to existing chats. - * + * * @param matchMode The mode to set. */ public void setMatchMode(MatchMode matchMode) { @@ -238,7 +238,7 @@ public final class ChatManager extends Manager{ /** * Creates a new chat using the specified thread ID, then returns it. - * + * * @param userJID the jid of the user this chat is with * @param thread the thread of the created chat. * @param listener the optional listener to add to the chat @@ -309,8 +309,8 @@ public final class ChatManager extends Manager{ * Try to get a matching chat for the given user JID, based on the {@link MatchMode}. *

  • NONE - return null *
  • SUPPLIED_JID - match the jid in the from field of the message exactly. - *
  • BARE_JID - if not match for from field, try the bare jid. - * + *
  • BARE_JID - if not match for from field, try the bare jid. + * * @param userJID jid in the from field of message. * @return Matching chat, or null if no match found. */ @@ -383,7 +383,7 @@ public final class ChatManager extends Manager{ } StanzaCollector createStanzaCollector(Chat chat) { - return connection().createStanzaCollector(new AndFilter(new ThreadFilter(chat.getThreadID()), + return connection().createStanzaCollector(new AndFilter(new ThreadFilter(chat.getThreadID()), FromMatchesFilter.create(chat.getParticipant()))); } diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java index 7163dcbaa..c4e7a0cf2 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java @@ -115,7 +115,7 @@ public final class Roster extends Manager { * {@link Roster#removeEntry(RosterEntry)} , etc. except adding or removing * {@link RosterListener}s will throw an IllegalStateException. *

    - * + * * @param connection the connection the roster should be retrieved for. * @return the user's roster. */ @@ -201,7 +201,7 @@ public final class Roster extends Manager { private final PresencePacketListener presencePacketListener = new PresencePacketListener(); /** - * + * */ private boolean rosterLoadedAtLogin = rosterLoadedAtLoginDefault; @@ -437,8 +437,8 @@ public final class Roster extends Manager { * which means the method will return immediately, and the roster will be * reloaded at a later point when the server responds to the reload request. * @throws NotLoggedInException If not logged in. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void reload() throws NotLoggedInException, NotConnectedException, InterruptedException { final XMPPConnection connection = getAuthenticatedConnectionOrThrow(); @@ -476,7 +476,7 @@ public final class Roster extends Manager { * * @throws NotLoggedInException * @throws NotConnectedException - * @throws InterruptedException + * @throws InterruptedException * @since 4.1 */ public void reloadAndWait() throws NotLoggedInException, NotConnectedException, InterruptedException { @@ -627,8 +627,8 @@ public final class Roster extends Manager { * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException if an XMPP exception occurs. * @throws NotLoggedInException If not logged in. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void createEntry(BareJid user, String name, String[] groups) throws NotLoggedInException, NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { final XMPPConnection connection = getAuthenticatedConnectionOrThrow(); @@ -717,7 +717,7 @@ public final class Roster extends Manager { * Add a subscribe listener, which is invoked on incoming subscription requests and if * {@link SubscriptionMode} is set to {@link SubscriptionMode#manual}. This also sets subscription * mode to {@link SubscriptionMode#manual}. - * + * * @param subscribeListener the subscribe listener to add. * @return true if the listener was not already added. * @since 4.2 @@ -758,8 +758,8 @@ public final class Roster extends Manager { * @throws XMPPErrorException if an XMPP error occurs. * @throws NotLoggedInException if not logged in. * @throws NoResponseException SmackException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void removeEntry(RosterEntry entry) throws NotLoggedInException, NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { final XMPPConnection connection = getAuthenticatedConnectionOrThrow(); @@ -1124,7 +1124,7 @@ public final class Roster extends Manager { * having an implicit subscription to the users presence. *

    * Note that if the roster is not loaded, then this method will always return false. - * + * * @param jid * @return true if the given JID is allowed to see the users presence. * @since 4.1 diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterEntry.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterEntry.java index fd4c7def6..df59e379a 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterEntry.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterEntry.java @@ -93,10 +93,10 @@ public final class RosterEntry extends Manager { * Sets the name associated with this entry. * * @param name the name. - * @throws NotConnectedException - * @throws XMPPErrorException - * @throws NoResponseException - * @throws InterruptedException + * @throws NotConnectedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws InterruptedException */ public synchronized void setName(String name) throws NotConnectedException, NoResponseException, XMPPErrorException, InterruptedException { // Do nothing if the name hasn't changed. @@ -211,7 +211,7 @@ public final class RosterEntry extends Manager { /** * Cancel the presence subscription the XMPP entity representing this roster entry has with us. - * + * * @throws NotConnectedException * @throws InterruptedException * @since 4.2 @@ -266,7 +266,7 @@ public final class RosterEntry extends Manager { * Indicates whether some other object is "equal to" this by comparing all members. *

    * The {@link #equals(Object)} method returns true if the user JIDs are equal. - * + * * @param obj the reference object with which to compare. * @return true if this object is the same as the obj argument; false * otherwise. diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java index 9af55baf9..c23343487 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java @@ -66,15 +66,15 @@ public class RosterGroup extends Manager { /** * Sets the name of the group. Changing the group's name is like moving all the group entries - * of the group to a new group specified by the new name. Since this group won't have entries - * it will be removed from the roster. This means that all the references to this object will + * of the group to a new group specified by the new name. Since this group won't have entries + * it will be removed from the roster. This means that all the references to this object will * be invalid and will need to be updated to the new group specified by the new name. * * @param name the name of the group. - * @throws NotConnectedException - * @throws XMPPErrorException - * @throws NoResponseException - * @throws InterruptedException + * @throws NotConnectedException + * @throws XMPPErrorException + * @throws NoResponseException + * @throws InterruptedException */ public void setName(String name) throws NotConnectedException, NoResponseException, XMPPErrorException, InterruptedException { synchronized (entries) { @@ -159,7 +159,7 @@ public class RosterGroup extends Manager { } /** - * Adds a roster entry to this group. If the entry was unfiled then it will be removed from + * Adds a roster entry to this group. If the entry was unfiled then it will be removed from * the unfiled list and will be added to this group. * Note that this is a synchronous call -- Smack must wait for the server * to receive the updated roster. @@ -167,8 +167,8 @@ public class RosterGroup extends Manager { * @param entry a roster entry. * @throws XMPPErrorException if an error occured while trying to add the entry to the group. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void addEntry(RosterEntry entry) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Only add the entry if it isn't already in the list. @@ -186,22 +186,22 @@ public class RosterGroup extends Manager { } /** - * Removes a roster entry from this group. If the entry does not belong to any other group - * then it will be considered as unfiled, therefore it will be added to the list of unfiled + * Removes a roster entry from this group. If the entry does not belong to any other group + * then it will be considered as unfiled, therefore it will be added to the list of unfiled * entries. * Note that this is a synchronous call -- Smack must wait for the server * to receive the updated roster. * * @param entry a roster entry. - * @throws XMPPErrorException if an error occurred while trying to remove the entry from the group. + * @throws XMPPErrorException if an error occurred while trying to remove the entry from the group. * @throws NoResponseException if there was no response from the server. - * @throws NotConnectedException - * @throws InterruptedException + * @throws NotConnectedException + * @throws InterruptedException */ public void removeEntry(RosterEntry entry) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { // Only remove the entry if it's in the entry list. // Remove the entry locally, if we wait for RosterPacketListenerProcess>>Packet(Packet) - // to take place the entry will exist in the group until a packet is received from the + // to take place the entry will exist in the group until a packet is received from the // server. synchronized (entries) { if (entries.contains(entry)) { diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterListener.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterListener.java index 80dcb986a..005b703e9 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterListener.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterListener.java @@ -26,7 +26,7 @@ import org.jxmpp.jid.Jid; /** * A listener that is fired any time a roster is changed or the presence of * a user in the roster is changed. - * + * * @see Roster#addRosterListener(RosterListener) * @author Matt Tucker */ diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java index 248fe4028..64ba4f713 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java @@ -126,7 +126,7 @@ public class RosterPacket extends IQ { */ private boolean subscriptionPending; - // TODO Make immutable. + // TODO Make immutable. private String name; private ItemType itemType = ItemType.none; private boolean approved; @@ -399,7 +399,7 @@ public class RosterPacket extends IQ { * point in the direction presence messages are sent. For example, if there is only a head * pointing to the big dot, then the local user will receive presence information from the * remote entity. - * + * * @return the symbolic representation of this item type. */ public String asSymbol() { diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterOfflineTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterOfflineTest.java index e5ee1334f..931981c59 100644 --- a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterOfflineTest.java +++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterOfflineTest.java @@ -27,7 +27,7 @@ import org.junit.Test; /** * Tests the behavior of the roster if the connection is not authenticated yet. - * + * * @author Henning Staib */ public class RosterOfflineTest { 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 a85246082..4d26b20c6 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 @@ -57,7 +57,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Tests that verifies the correct behavior of the {@link Roster} implementation. - * + * * @see Roster * @see Roster Management * @author Guenther Niess @@ -369,7 +369,7 @@ public class RosterTest extends InitSmackIm { /** * Tests that roster pushes with invalid from are ignored. - * @throws XmppStringprepException + * @throws XmppStringprepException * * @see RFC 6121, Section 2.1.6 */ @@ -397,7 +397,7 @@ public class RosterTest extends InitSmackIm { /** * Test if adding an user with an empty group is equivalent with providing * no group. - * + * * @see SMACK-294 */ @Test(timeout = 5000) @@ -465,7 +465,7 @@ public class RosterTest extends InitSmackIm { /** * Test processing a roster push with an empty group is equivalent with providing * no group. - * + * * @see SMACK-294 */ @Test @@ -512,7 +512,7 @@ public class RosterTest extends InitSmackIm { /** * Remove all roster entries by iterating trough {@link Roster#getEntries()} * and simulating receiving roster pushes from the server. - * + * * @param connection the dummy connection of which the provided roster belongs to. * @param roster the roster (or buddy list) which should be initialized. */ @@ -538,8 +538,8 @@ public class RosterTest extends InitSmackIm { * RFC3921: Retrieving One's Roster on Login. * - * @throws SmackException - * @throws XmppStringprepException + * @throws SmackException + * @throws XmppStringprepException */ private void initRoster() throws InterruptedException, SmackException, XmppStringprepException { roster.reload(); @@ -587,7 +587,7 @@ public class RosterTest extends InitSmackIm { * Check Romeo's roster entry according to the example in * RFC3921: Retrieving One's Roster on Login. - * + * * @param romeo the roster entry which should be verified. */ public static void verifyRomeosEntry(final RosterEntry romeo) { @@ -610,7 +610,7 @@ public class RosterTest extends InitSmackIm { * Check Mercutio's roster entry according to the example in * RFC3921: Retrieving One's Roster on Login. - * + * * @param mercutio the roster entry which should be verified. */ public static void verifyMercutiosEntry(final RosterEntry mercutio) { @@ -629,7 +629,7 @@ public class RosterTest extends InitSmackIm { * Check Benvolio's roster entry according to the example in * RFC3921: Retrieving One's Roster on Login. - * + * * @param benvolio the roster entry which should be verified. */ public static void verifyBenvoliosEntry(final RosterEntry benvolio) { @@ -654,7 +654,7 @@ public class RosterTest extends InitSmackIm { /** * Overwrite this method to check if the received update request is valid. - * + * * @param updateRequest the request which would be sent to the server. */ abstract void verifyUpdateRequest(RosterPacket updateRequest); @@ -699,7 +699,7 @@ public class RosterTest extends InitSmackIm { /** * Returns the exception or error if something went wrong. - * + * * @return the Throwable exception or error that occurred. */ public Throwable getException() { @@ -741,7 +741,7 @@ public class RosterTest extends InitSmackIm { /** * Get a collection of JIDs of the added roster items. - * + * * @return the collection of addresses which were added. */ public Collection getAddedAddresses() { @@ -750,7 +750,7 @@ public class RosterTest extends InitSmackIm { /** * Get a collection of JIDs of the deleted roster items. - * + * * @return the collection of addresses which were deleted. */ public Collection getDeletedAddresses() { @@ -759,7 +759,7 @@ public class RosterTest extends InitSmackIm { /** * Get a collection of JIDs of the updated roster items. - * + * * @return the collection of addresses which were updated. */ public Collection getUpdatedAddresses() { 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 f840dba96..aaf717122 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,8 +97,8 @@ public class RosterVersioningTest { /** * Tests that receiving an empty roster result causes the roster to be populated * by all entries of the roster store. - * @throws SmackException - * @throws XMPPException + * @throws SmackException + * @throws XMPPException */ @Test(timeout = 300000) public void testEqualVersionStored() throws InterruptedException, IOException, XMPPException, SmackException { @@ -131,9 +131,9 @@ public class RosterVersioningTest { /** * Tests that a non-empty roster result empties the store. - * @throws SmackException - * @throws XMPPException - * @throws XmppStringprepException + * @throws SmackException + * @throws XMPPException + * @throws XmppStringprepException */ @Test(timeout = 5000) public void testOtherVersionStored() throws XMPPException, SmackException, XmppStringprepException { diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/SubscriptionPreApprovalTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/SubscriptionPreApprovalTest.java index c434460b1..7ab89a899 100644 --- a/smack-im/src/test/java/org/jivesoftware/smack/roster/SubscriptionPreApprovalTest.java +++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/SubscriptionPreApprovalTest.java @@ -44,7 +44,7 @@ import org.jxmpp.jid.impl.JidCreate; /** * Tests that verifies the correct behavior of the pre-approval implementation. - * + * * @see Pre-Approving a Subscription Request * @author Tomáš Havlas */ @@ -145,7 +145,7 @@ public class SubscriptionPreApprovalTest extends InitSmackIm { /** * Overwrite this method to check if the received roster update request is valid. - * + * * @param updateRequest the request which would be sent to the server. */ abstract void verifyRosterUpdateRequest(RosterPacket updateRequest); @@ -200,7 +200,7 @@ public class SubscriptionPreApprovalTest extends InitSmackIm { /** * Returns the exception or error if something went wrong. - * + * * @return the Throwable exception or error that occurred. */ public Throwable getException() { diff --git a/smack-integration-test/src/main/java/org/igniterealtime/smack/inttest/TestNotPossibleException.java b/smack-integration-test/src/main/java/org/igniterealtime/smack/inttest/TestNotPossibleException.java index 2d5a03585..843726ca8 100644 --- a/smack-integration-test/src/main/java/org/igniterealtime/smack/inttest/TestNotPossibleException.java +++ b/smack-integration-test/src/main/java/org/igniterealtime/smack/inttest/TestNotPossibleException.java @@ -19,7 +19,7 @@ package org.igniterealtime.smack.inttest; public class TestNotPossibleException extends Exception { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smack/ChatTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smack/ChatTest.java index 48cc5457a..43fc3db14 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smack/ChatTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smack/ChatTest.java @@ -38,7 +38,7 @@ import org.junit.BeforeClass; /** * Tests for Chat Manager and for Chat Manager Listener. - * + * * @author Stawicki Adam */ public class ChatTest extends AbstractSmackIntegrationTest { @@ -87,28 +87,28 @@ public class ChatTest extends AbstractSmackIntegrationTest { assertEquals("Subjects are different", msg.getSubject(), msg2.getSubject()); assertEquals("Bodies are different", msg.getBody(), msg2.getBody()); assertEquals( - "favoriteColors are different", + "favoriteColors are different", getProperty(msg, "favoriteColor"), getProperty(msg2, "favoriteColor")); assertEquals( - "ages are different", - getProperty(msg, "age"), + "ages are different", + getProperty(msg, "age"), getProperty(msg2, "age")); assertEquals( - "distances are different", - getProperty(msg, "distance"), + "distances are different", + getProperty(msg, "distance"), getProperty(msg2, "distance")); assertEquals( - "weights are different", - getProperty(msg, "weight"), + "weights are different", + getProperty(msg, "weight"), getProperty(msg2, "weight")); assertEquals( - "males are different", - getProperty(msg, "male"), + "males are different", + getProperty(msg, "male"), getProperty(msg2, "male")); assertEquals( - "birthdates are different", - getProperty(msg, "birthdate"), + "birthdates are different", + getProperty(msg, "birthdate"), getProperty(msg2, "birthdate")); } diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smack/LoginIntegrationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smack/LoginIntegrationTest.java index f70061997..f7a91b0c0 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smack/LoginIntegrationTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smack/LoginIntegrationTest.java @@ -43,12 +43,12 @@ public class LoginIntegrationTest extends AbstractSmackLowLevelIntegrationTest { * Check that the server is returning the correct error when trying to login using an invalid * (i.e. non-existent) user. * - * @throws InterruptedException - * @throws XMPPException - * @throws IOException - * @throws SmackException - * @throws NoSuchAlgorithmException - * @throws KeyManagementException + * @throws InterruptedException + * @throws XMPPException + * @throws IOException + * @throws SmackException + * @throws NoSuchAlgorithmException + * @throws KeyManagementException */ @SmackIntegrationTest public void testInvalidLogin() throws SmackException, IOException, XMPPException, 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 08d403a11..ab10c45c3 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 @@ -124,12 +124,12 @@ public class EntityCapsTest extends AbstractSmackIntegrationTest { /** * Test if entity caps actually prevent a disco info request and reply. - * + * * @throws XMPPException - * @throws InterruptedException - * @throws NotConnectedException - * @throws NoResponseException - * + * @throws InterruptedException + * @throws NotConnectedException + * @throws NoResponseException + * */ @SmackIntegrationTest public void testPreventDiscoInfo() throws Exception { diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTControlIntegrationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTControlIntegrationTest.java index 17490629a..f88a910dd 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTControlIntegrationTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTControlIntegrationTest.java @@ -52,8 +52,8 @@ public class IoTControlIntegrationTest extends AbstractSmackIntegrationTest { /** * Connection one provides a thing, which is controlled by connection two. * - * @throws Exception - * @throws TimeoutException + * @throws Exception + * @throws TimeoutException */ @SmackIntegrationTest // @SmackSerialIntegrationTest diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTDataIntegrationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTDataIntegrationTest.java index 067367131..3da896b65 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTDataIntegrationTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/iot/IoTDataIntegrationTest.java @@ -54,8 +54,8 @@ public class IoTDataIntegrationTest extends AbstractSmackIntegrationTest { /** * Connection one provides a thing, which momentary value is read out by connection two. * - * @throws Exception - * @throws TimeoutException + * @throws Exception + * @throws TimeoutException */ @SmackIntegrationTest public void dataTest() throws Exception { diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/mam/package-info.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/mam/package-info.java index 16b8b2b7b..c195b658a 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/mam/package-info.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/mam/package-info.java @@ -17,9 +17,9 @@ /** * XEP-0313: Message Archive Management. - * + * * @see XEP-0313: Message * Archive Management - * + * */ package org.jivesoftware.smackx.mam; diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoInitializationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoInitializationTest.java index 4409a449e..8dc3b7915 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoInitializationTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoInitializationTest.java @@ -53,7 +53,7 @@ public class OmemoInitializationTest extends AbstractOmemoIntegrationTest { /** * Tests, if the initialization is done properly. - * @throws NotAPubSubNodeException + * @throws NotAPubSubNodeException */ @SmackIntegrationTest public void initializationTest() throws XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException, SmackException.NotConnectedException, InterruptedException, SmackException.NoResponseException, SmackException.NotLoggedInException, CorruptedOmemoKeyException, NotAPubSubNodeException { diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoMessageSendingTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoMessageSendingTest.java index 01fe16bd3..e7b3011bf 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoMessageSendingTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/OmemoMessageSendingTest.java @@ -86,7 +86,7 @@ public class OmemoMessageSendingTest extends AbstractOmemoIntegrationTest { * @throws UndecidedOmemoIdentityException * @throws NoSuchAlgorithmException * @throws CryptoFailedException - * @throws NotAPubSubNodeException + * @throws NotAPubSubNodeException */ @SmackIntegrationTest public void messageSendingTest() diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/package-info.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/package-info.java index 737ea40e6..50bca9449 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/package-info.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/package-info.java @@ -19,7 +19,7 @@ * XMPP logic and some abstract crypto classes that have to be implemented * using concrete crypto libraries (like signal-protocol-java or olm). * See smack-omemo-signal for a concrete implementation (GPL licensed). - * + * * @author Paul Schaub * @see XEP-0384: OMEMO */ diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/xdata/FormTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/xdata/FormTest.java index fd8097f87..4c2f0aa17 100644 --- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/xdata/FormTest.java +++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/xdata/FormTest.java @@ -34,7 +34,7 @@ import org.igniterealtime.smack.inttest.SmackIntegrationTestEnvironment; /** * Tests the DataForms extensions. - * + * * @author Gaston Dombiak */ public class FormTest extends AbstractSmackIntegrationTest { @@ -48,8 +48,8 @@ public class FormTest extends AbstractSmackIntegrationTest { * 2. Retrieve the form to fill out, complete it and return it to the requestor * 3. Retrieve the completed form and check that everything is OK * - * @throws InterruptedException - * @throws NotConnectedException + * @throws InterruptedException + * @throws NotConnectedException */ @SuppressWarnings("deprecation") @SmackIntegrationTest diff --git a/smack-integration-test/src/test/java/org/igniterealtime/smack/inttest/util/ResultSyncPointTest.java b/smack-integration-test/src/test/java/org/igniterealtime/smack/inttest/util/ResultSyncPointTest.java index 37c80af26..414a66fe7 100644 --- a/smack-integration-test/src/test/java/org/igniterealtime/smack/inttest/util/ResultSyncPointTest.java +++ b/smack-integration-test/src/test/java/org/igniterealtime/smack/inttest/util/ResultSyncPointTest.java @@ -62,7 +62,7 @@ public class ResultSyncPointTest { private static class TestException extends Exception { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Java7Base64UrlSafeEncoder.java b/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Java7Base64UrlSafeEncoder.java index 201c3a000..b266fb09f 100644 --- a/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Java7Base64UrlSafeEncoder.java +++ b/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Java7Base64UrlSafeEncoder.java @@ -24,13 +24,13 @@ import org.jivesoftware.smack.util.stringencoder.StringEncoder; /** * A Base 64 encoding implementation that generates filename and Url safe encodings. - * + * *

    - * Note: This does NOT produce standard Base 64 encodings, but a variant as defined in + * Note: This does NOT produce standard Base 64 encodings, but a variant as defined in * Section 4 of RFC3548: * http://www.faqs.org/rfcs/rfc3548.html. *

    - * + * * @author Robin Collier */ public final class Java7Base64UrlSafeEncoder implements StringEncoder { diff --git a/smack-jingle-old/src/integration-test/java/org/jivesoftware/smackx/jingle/PayloadTypeTest.java b/smack-jingle-old/src/integration-test/java/org/jivesoftware/smackx/jingle/PayloadTypeTest.java index 2c6449223..4404ddd7c 100644 --- a/smack-jingle-old/src/integration-test/java/org/jivesoftware/smackx/jingle/PayloadTypeTest.java +++ b/smack-jingle-old/src/integration-test/java/org/jivesoftware/smackx/jingle/PayloadTypeTest.java @@ -53,7 +53,7 @@ public class PayloadTypeTest extends SmackTestCase { set2.add(common1); // Get the difference - ArrayList