[Android] Wrap all share parameters into the ShareParams class

chrome/android/java/src/org/chromium/chrome/browser/share/ShareParams.java

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+package org.chromium.chrome.browser.share;
+
+import android.app.Activity;
+import android.net.Uri;
+import android.support.annotation.Nullable;
+
+import org.chromium.chrome.browser.share.ShareHelper.TargetChosenCallback;
+
+/**
+ * A container object for passing share parameters to {@link ShareHelper}.
+ */
+public class ShareParams {
+    /**
+     * Whether it should share directly with the activity that was most recently used to share.
+     */
+    private final boolean mShareDirectly;
+
+    /** Whether to save the chosen activity for future direct sharing. */
+    private final boolean mSaveLastUsed;
+
+    /** The activity that is used to access package manager. */
+    private final Activity mActivity;
+
+    /** The title of the page to be shared. */
+    private final String mTitle;
+
+    /**
+     * The text to be shared. If both |text| and |url| are supplied, they are concatenated with a
+     * space.
+     */
+    private final String mText;
+
+    /** The URL of the page to be shared. */
+    private final String mUrl;
+
+    /** The Uri to the offline MHTML file to be shared. */
+    private final Uri mOfflineUri;
+
+    /** The Uri of the screenshot of the page to be shared. */
+    private final Uri mScreenshotUri;
+
+    /**
+     * Optional callback to be called when user makes a choice. Will not be called if receiving a
+     * response when the user makes a choice is not supported (on older Android versions).
+     */
+    private final TargetChosenCallback mCallback;
+
+    private ShareParams(boolean shareDirectly, boolean saveLastUsed, Activity activity,
+            String title, String text, String url, @Nullable Uri offlineUri, Uri screenshotUri,

[Ted C, 2017/06/01 20:39:03]

screenshotUri can be nullable as well.

Let's mark all the accessors as Nullable too

[ltian, 2017/06/01 23:27:13]

Done.

+            @Nullable TargetChosenCallback callback) {
+        mShareDirectly = shareDirectly;
+        mSaveLastUsed = saveLastUsed;
+        mActivity = activity;
+        mTitle = title;
+        mText = text;
+        mUrl = url;
+        mOfflineUri = offlineUri;
+        mScreenshotUri = screenshotUri;
+        mCallback = callback;
+    }
+
+    /**
+     * @return Whether it should share directly with the activity that was most recently used to
+     * share.
+     */
+    public boolean isShareDirectly() {
+        return mShareDirectly;
+    }
+
+    /**
+     * @return Whether to save the chosen activity for future direct sharing.
+     */
+    public boolean isSaveLastUsed() {
+        return mSaveLastUsed;
+    }
+
+    /**
+     * @return The activity that is used to access package manager.
+     */
+    public Activity getActivity() {
+        return mActivity;
+    }
+
+    /**
+     * @return The title of the page to be shared.
+     */
+    public String getTitle() {
+        return mTitle;
+    }
+
+    /**
+     * @return The text to be shared.
+     */
+    public String getText() {
+        return mText;
+    }
+
+    /**
+     * @return The URL of the page to be shared.
+     */
+    public String getUrl() {
+        return mUrl;
+    }
+
+    /**
+     * @return The Uri to the offline MHTML file to be shared.
+     */
+    public Uri getOfflineUri() {
+        return mOfflineUri;
+    }
+
+    /**
+     * @return The Uri of the screenshot of the page to be shared.
+     */
+    public Uri getScreenshotUri() {
+        return mScreenshotUri;
+    }
+
+    /**
+     * @return The callback to be called when user makes a choice.
+     */
+    public TargetChosenCallback getCallback() {
+        return mCallback;
+    }
+
+    /** The builder for {@link ShareParams} objects. */
+    public static class Builder {
+        private boolean mShareDirectly;
+        private boolean mSaveLastUsed;
+        private Activity mActivity;
+        private String mTitle;
+        private String mText;
+        private String mUrl;
+        private Uri mOfflineUri;
+        private Uri mScreenshotUri;
+        private TargetChosenCallback mCallback;
+
+        public Builder(Activity activity, String title, String url) {
+            mActivity = activity;
+            mUrl = url;
+            mTitle = title;
+        }
+
+        /**
+         * Sets the text to be shared.
+         */
+        public Builder setText(String text) {
+            mText = text;
+            return this;
+        }
+
+        /**
+         * Sets whether it should share directly with the activity that was most recently used to
+         * share.
+         */
+        public Builder setShareDirectly(boolean shareDirectly) {
+            mShareDirectly = shareDirectly;

[Yusuf, 2017/06/01 20:41:45]

Can we not deduce these two from each other? 

At least we should do:

assert shareDirectly ? savelastused != true : true;

[ltian, 2017/06/01 23:27:14]

The reason I add the deduction is because in ShareHelper if mShareDirectly is
true, it forces the mSaveLastUsed to false. Assert is definitely better to deal
with this.

+            return this;
+        }
+
+        /**
+         * Sets whether to save the chosen activity for future direct sharing.
+         */
+        public Builder setSaveLastUsed(boolean saveLastUsed) {
+            mSaveLastUsed = saveLastUsed;
+            return this;
+        }
+
+        /**
+         * Sets the URL of the page to be shared.
+         */
+        public Builder setUrl(String url) {
+            mUrl = url;
+            return this;
+        }
+
+        /**
+         * Sets the Uri of the offline MHTML file to be shared.
+         */
+        public Builder setOfflineUri(Uri offlineUri) {
+            mOfflineUri = offlineUri;
+            return this;
+        }
+
+        /**
+         * Sets the Uri of the screenshot of the page to be shared.
+         */
+        public Builder setScreenshotUri(Uri screenshotUri) {
+            mScreenshotUri = screenshotUri;
+            return this;
+        }
+
+        /**
+         * Sets the callback to be called when user makes a choice.
+         */
+        public Builder setCallback(TargetChosenCallback callback) {
+            mCallback = callback;
+            return this;
+        }
+
+        /**
+         * @return The activity that is used to access package manager.
+         */
+        public Activity getActivity() {

[Ted C, 2017/06/01 20:39:03]

We shouldn't have getters on the builder.  How many places need this?

[ltian, 2017/06/01 23:27:13]

It is only used in one place in OfflinePageUtils and seems that one can use
Application context. So this is not needed.

+            return mActivity;
+        }
+
+        /** @return A fully constructed {@link ShareParams} object. */
+        public ShareParams build() {
+            if (mShareDirectly) {

[Yusuf, 2017/06/01 20:41:46]

one line.

[ltian, 2017/06/01 23:27:16]

Done.

+                mSaveLastUsed = false;

[Ted C, 2017/06/01 20:39:03]

I don't think we should overwrite values.  If this isn't a valid combination, we
should assert !mSaveLastUsed here instead.

[ltian, 2017/06/01 23:27:15]

Done.

+            }
+            return new ShareParams(mShareDirectly, mSaveLastUsed, mActivity, mTitle, mText, mUrl,
+                    mOfflineUri, mScreenshotUri, mCallback);
+        }
+    }
+}