Merge pull request #1088 from owncloud/updated_docs_about_target_of_PRs

[pub/Android/ownCloud.git] / src / com / owncloud / android / operations / common / SyncOperation.java

diff --git a/src/com/owncloud/android/operations/common/SyncOperation.java b/src/com/owncloud/android/operations/common/SyncOperation.java
index e16530d..5fb5c8c 100644 (file)
--- a/src/com/owncloud/android/operations/common/SyncOperation.java
+++ b/src/com/owncloud/android/operations/common/SyncOperation.java
@@ -1,5 +1,8 @@
-/* ownCloud Android client application
- *   Copyright (C) 2012-2014 ownCloud Inc.
+/**
+ *   ownCloud Android client application
+ *
+ *   @author David A. Velasco
+ *   Copyright (C) 2015 ownCloud Inc.

  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License version 2,
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License version 2,


@@ -17,13 +20,13 @@
 
 package com.owncloud.android.operations.common;
 
 
 package com.owncloud.android.operations.common;
 

+import com.owncloud.android.MainApp;

 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.lib.common.OwnCloudClient;
 import com.owncloud.android.lib.common.operations.OnRemoteOperationListener;
 import com.owncloud.android.lib.common.operations.RemoteOperation;
 import com.owncloud.android.lib.common.operations.RemoteOperationResult;
 
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.lib.common.OwnCloudClient;
 import com.owncloud.android.lib.common.operations.OnRemoteOperationListener;
 import com.owncloud.android.lib.common.operations.RemoteOperation;
 import com.owncloud.android.lib.common.operations.RemoteOperationResult;
 

-import android.app.Activity;

 import android.content.Context;
 import android.os.Handler;
 
 import android.content.Context;
 import android.os.Handler;
 


@@ -33,8 +36,6 @@ import android.os.Handler;
  * with local data in the device.
  * 
  * Provides methods to execute the operation both synchronously or asynchronously.
  * with local data in the device.
  * 
  * Provides methods to execute the operation both synchronously or asynchronously.

- * 
- * @author David A. Velasco 

  */
 public abstract class SyncOperation extends RemoteOperation {
        
  */
 public abstract class SyncOperation extends RemoteOperation {
        


@@ -52,18 +53,21 @@ public abstract class SyncOperation extends RemoteOperation {
      * 
      * Do not call this method from the main thread.
      * 
      * 
      * Do not call this method from the main thread.
      * 

-     * This method should be used whenever an ownCloud account is available, instead of {@link #execute(OwnCloudClient)}. 
+     * This method should be used whenever an ownCloud account is available, instead of
+     * {@link #execute(OwnCloudClient, com.owncloud.android.datamodel.FileDataStorageManager)}.

      * 
      * 

-     * @param account   ownCloud account in remote ownCloud server to reach during the execution of the operation.
+     * @param storageManager

      * @param context   Android context for the component calling the method.
      * @return          Result of the operation.
      */
     public RemoteOperationResult execute(FileDataStorageManager storageManager, Context context) {
         if (storageManager == null) {
      * @param context   Android context for the component calling the method.
      * @return          Result of the operation.
      */
     public RemoteOperationResult execute(FileDataStorageManager storageManager, Context context) {
         if (storageManager == null) {

-            throw new IllegalArgumentException("Trying to execute a sync operation with a NULL storage manager");
+            throw new IllegalArgumentException("Trying to execute a sync operation with a " +
+                    "NULL storage manager");

         }
         if (storageManager.getAccount() == null) {
         }
         if (storageManager.getAccount() == null) {

-            throw new IllegalArgumentException("Trying to execute a sync operation with a storage manager for a NULL account");
+            throw new IllegalArgumentException("Trying to execute a sync operation with a " +
+                    "storage manager for a NULL account");

         }
         mStorageManager = storageManager;
         return super.execute(mStorageManager.getAccount(), context);
         }
         mStorageManager = storageManager;
         return super.execute(mStorageManager.getAccount(), context);


@@ -75,12 +79,16 @@ public abstract class SyncOperation extends RemoteOperation {
         * 
      * Do not call this method from the main thread.
      * 
         * 
      * Do not call this method from the main thread.
      * 

-        * @param client        Client object to reach an ownCloud server during the execution of the operation.
+        * @param client        Client object to reach an ownCloud server during the execution of the o
+     *                  peration.
+     * @param storageManager

         * @return                      Result of the operation.
         */
         * @return                      Result of the operation.
         */

-       public RemoteOperationResult execute(OwnCloudClient client, FileDataStorageManager storageManager) {
+       public RemoteOperationResult execute(OwnCloudClient client,
+                                         FileDataStorageManager storageManager) {

         if (storageManager == null)
         if (storageManager == null)

-            throw new IllegalArgumentException("Trying to execute a sync operation with a NULL storage manager");
+            throw new IllegalArgumentException("Trying to execute a sync operation with a " +
+                    "NULL storage manager");

         mStorageManager = storageManager;
                return super.execute(client);
        }
         mStorageManager = storageManager;
                return super.execute(client);
        }


@@ -89,37 +97,50 @@ public abstract class SyncOperation extends RemoteOperation {
     /**
      * Asynchronously executes the remote operation
      * 
     /**
      * Asynchronously executes the remote operation
      * 

-     * This method should be used whenever an ownCloud account is available, instead of {@link #execute(OwnCloudClient)}. 
+     * This method should be used whenever an ownCloud account is available, instead of
+     * {@link #execute(OwnCloudClient)}.

      * 
      * 

-     * @param account           ownCloud account in remote ownCloud server to reach during the execution of the operation.
+     * @param account           ownCloud account in remote ownCloud server to reach during the
+     *                          execution of the operation.

      * @param context           Android context for the component calling the method.
      * @param listener          Listener to be notified about the execution of the operation.
      * @param context           Android context for the component calling the method.
      * @param listener          Listener to be notified about the execution of the operation.

-     * @param listenerHandler   Handler associated to the thread where the methods of the listener objects must be called.
+     * @param listenerHandler   Handler associated to the thread where the methods of the listener
+     *                          objects must be called.

      * @return                  Thread were the remote operation is executed.
      */
      * @return                  Thread were the remote operation is executed.
      */

-    public Thread execute(FileDataStorageManager storageManager, Context context, OnRemoteOperationListener listener, Handler listenerHandler, Activity callerActivity) {
+       /*
+    public Thread execute(FileDataStorageManager storageManager,
+    Context context, OnRemoteOperationListener listener, Handler listenerHandler, Activity callerActivity) {

         if (storageManager == null) {
         if (storageManager == null) {

-            throw new IllegalArgumentException("Trying to execute a sync operation with a NULL storage manager");
+            throw new IllegalArgumentException("Trying to execute a sync operation
+             with a NULL storage manager");

         }
         if (storageManager.getAccount() == null) {
         }
         if (storageManager.getAccount() == null) {

-            throw new IllegalArgumentException("Trying to execute a sync operation with a storage manager for a NULL account");
+            throw new IllegalArgumentException("Trying to execute a sync operation with a
+             storage manager for a NULL account");

         }
         mStorageManager = storageManager;
         }
         mStorageManager = storageManager;

-        return super.execute(storageManager.getAccount(), context, listener, listenerHandler, callerActivity);
+        return super.execute(storageManager.getAccount(), context, listener, listenerHandler,
+         callerActivity);

     }
     }

+    */

 
     
        /**
         * Asynchronously executes the remote operation
         * 
 
     
        /**
         * Asynchronously executes the remote operation
         * 

-        * @param client                        Client object to reach an ownCloud server during the execution of the operation.
+        * @param client                        Client object to reach an ownCloud server during the
+     *                          execution of the operation.

         * @param listener                      Listener to be notified about the execution of the operation.
         * @param listener                      Listener to be notified about the execution of the operation.

-        * @param listenerHandler       Handler associated to the thread where the methods of the listener objects must be called.
+        * @param listenerHandler       Handler associated to the thread where the methods of
+     *                          the listener objects must be called.

         * @return                                      Thread were the remote operation is executed.
         */
         * @return                                      Thread were the remote operation is executed.
         */

-       public Thread execute(OwnCloudClient client, FileDataStorageManager storageManager, OnRemoteOperationListener listener, Handler listenerHandler) {
+       public Thread execute(OwnCloudClient client, FileDataStorageManager storageManager,
+                          OnRemoteOperationListener listener, Handler listenerHandler) {

         if (storageManager == null) {
         if (storageManager == null) {

-            throw new IllegalArgumentException("Trying to execute a sync operation with a NULL storage manager");
+            throw new IllegalArgumentException("Trying to execute a sync operation " +
+                    "with a NULL storage manager");

         }
         mStorageManager = storageManager;
         return super.execute(client, listener, listenerHandler);
         }
         mStorageManager = storageManager;
         return super.execute(client, listener, listenerHandler);