mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2025-12-18 11:01:08 +01:00
Enable werror for javadoc and fix javadoc issues
This commit is contained in:
parent
4249c1a845
commit
1a3067c89b
323 changed files with 2929 additions and 2704 deletions
|
|
@ -214,10 +214,10 @@ public abstract class AdHocCommand {
|
|||
* command. It is invoked on every command. If there is a problem executing
|
||||
* the command it throws an XMPPException.
|
||||
*
|
||||
* @throws NoResponseException
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there is an error executing the command.
|
||||
* @throws NotConnectedException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
public abstract void execute() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||
|
||||
|
|
@ -229,10 +229,10 @@ public abstract class AdHocCommand {
|
|||
* XMPPException.
|
||||
*
|
||||
* @param response the form answer of the previous stage.
|
||||
* @throws NoResponseException
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there is a problem executing the command.
|
||||
* @throws NotConnectedException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
public abstract void next(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||
|
||||
|
|
@ -245,10 +245,10 @@ public abstract class AdHocCommand {
|
|||
*
|
||||
* @param response the form answer of the previous stage.
|
||||
*
|
||||
* @throws NoResponseException
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there is a problem executing the command.
|
||||
* @throws NotConnectedException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
public abstract void complete(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||
|
||||
|
|
@ -258,10 +258,10 @@ public abstract class AdHocCommand {
|
|||
* the previous one. If there is a problem executing the command it throws
|
||||
* an XMPPException.
|
||||
*
|
||||
* @throws NoResponseException
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there is a problem executing the command.
|
||||
* @throws NotConnectedException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
public abstract void prev() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||
|
||||
|
|
@ -270,10 +270,10 @@ public abstract class AdHocCommand {
|
|||
* the execution. If there is a problem executing the command it throws an
|
||||
* XMPPException.
|
||||
*
|
||||
* @throws NoResponseException
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws XMPPErrorException if there is a problem executing the command.
|
||||
* @throws NotConnectedException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
public abstract void cancel() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||
|
||||
|
|
@ -369,7 +369,7 @@ public abstract class AdHocCommand {
|
|||
* The {@link Action#cancel cancel} action is always allowed. To define the
|
||||
* available actions use the <code>addActionAvailable</code> method.
|
||||
*
|
||||
* @param action
|
||||
* @param action TODO javadoc me please
|
||||
* The action to check if it is available.
|
||||
* @return True if the action is available for the current stage.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -250,7 +250,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 if the calling thread was interrupted.
|
||||
*/
|
||||
public DiscoverItems discoverCommands(Jid jid) throws XMPPException, SmackException, InterruptedException {
|
||||
return serviceDiscoveryManager.discoverItems(jid, NAMESPACE);
|
||||
|
|
@ -291,11 +291,11 @@ public final class AdHocCommandManager extends Manager {
|
|||
* <li>The action to execute is one of the available actions</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param requestData
|
||||
* @param requestData TODO javadoc me please
|
||||
* the stanza to process.
|
||||
* @throws NotConnectedException
|
||||
* @throws NoResponseException
|
||||
* @throws InterruptedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
* @throws NoResponseException if there was no response from the remote entity.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
private IQ processAdHocCommand(AdHocCommandData requestData) throws NoResponseException, NotConnectedException, InterruptedException {
|
||||
// Creates the response with the corresponding data
|
||||
|
|
@ -555,7 +555,7 @@ public final class AdHocCommandManager extends Manager {
|
|||
*
|
||||
* @param response the response to send.
|
||||
* @param condition the condition of the error.
|
||||
* @throws NotConnectedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
*/
|
||||
private static IQ respondError(AdHocCommandData response,
|
||||
StanzaError.Condition condition) {
|
||||
|
|
@ -568,7 +568,7 @@ public final class AdHocCommandManager extends Manager {
|
|||
* @param response the response to send.
|
||||
* @param condition the condition of the error.
|
||||
* @param specificCondition the adhoc command error condition.
|
||||
* @throws NotConnectedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
*/
|
||||
private static IQ respondError(AdHocCommandData response, StanzaError.Condition condition,
|
||||
AdHocCommand.SpecificErrorCondition specificCondition) {
|
||||
|
|
@ -581,7 +581,7 @@ public final class AdHocCommandManager extends Manager {
|
|||
*
|
||||
* @param response the response to send.
|
||||
* @param error the error to send.
|
||||
* @throws NotConnectedException
|
||||
* @throws NotConnectedException if the XMPP connection is not connected.
|
||||
*/
|
||||
private static IQ respondError(AdHocCommandData response, StanzaError.Builder error) {
|
||||
response.setType(IQ.Type.error);
|
||||
|
|
@ -596,10 +596,10 @@ public final class AdHocCommandManager extends Manager {
|
|||
* @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 SecurityException if there was a security violation.
|
||||
* @throws NoSuchMethodException if no such method is declared
|
||||
* @throws InvocationTargetException if a reflection-based method or constructor invocation threw.
|
||||
* @throws IllegalArgumentException if an illegal argument was given.
|
||||
* @throws IllegalAccessException
|
||||
* @throws InstantiationException
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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 if there was a security violation.
|
||||
* @throws NoSuchMethodException if no such method is declared
|
||||
* @throws InvocationTargetException if a reflection-based method or constructor invocation threw.
|
||||
* @throws IllegalArgumentException if an illegal argument was given.
|
||||
*/
|
||||
LocalCommand getInstance() throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException;
|
||||
|
||||
|
|
|
|||
|
|
@ -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 if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
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 if the XMPP connection is not connected.
|
||||
* @throws InterruptedException if the calling thread was interrupted.
|
||||
*/
|
||||
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
|
||||
|
|
|
|||
|
|
@ -230,7 +230,7 @@ public class AdHocCommandData extends IQ {
|
|||
* href="http://xmpp.org/extensions/xep-0050.html#impl-session">XEP-0050 § 3.3 Session Lifetime</a>.
|
||||
* </p>
|
||||
*
|
||||
* @param sessionID
|
||||
* @param sessionID TODO javadoc me please
|
||||
*/
|
||||
public void setSessionID(String sessionID) {
|
||||
this.sessionID = sessionID;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue