com.albedinsky.android.support.intent.SmsIntent.java Source code

Introduction

Here is the source code for com.albedinsky.android.support.intent.SmsIntent.java

Source

/*
 * =================================================================================================
 *                             Copyright (C) 2016 Martin Albedinsky
 * =================================================================================================
 *         Licensed under the Apache License, Version 2.0 or later (further "License" only).
 * -------------------------------------------------------------------------------------------------
 * You may use this file only in compliance with the License. More details and copy of this License 
 * you may obtain at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 * You can redistribute, modify or publish any part of the code written within this file but as it 
 * is described in the License, the software distributed under the License is distributed on an 
 * "AS IS" BASIS, WITHOUT WARRANTIES or CONDITIONS OF ANY KIND.
 * 
 * See the License for the specific language governing permissions and limitations under the License.
 * =================================================================================================
 */
package com.albedinsky.android.support.intent;

import android.app.Activity;
import android.content.Intent;
import android.net.Uri;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.StringRes;
import android.support.v4.app.Fragment;
import android.text.TextUtils;

/**
 * A {@link BaseIntent} builder implementation providing API for building of intents targeting
 * an <b>SMS sending</b> related applications.
 * <p>
 * This intent builder requires only a phone number to be specified via {@link #phoneNumber(String)}.
 *
 * @author Martin Albedinsky
 * @see DialerIntent
 */
public final class SmsIntent extends BaseIntent {

    /**
     * Interface ===================================================================================
     */

    /**
     * Constants ===================================================================================
     */

    /**
     * Log TAG.
     */
    // private static final String TAG = "SmsIntent";

    /**
     * Static members ==============================================================================
     */

    /**
     * Uri scheme for <b>SMS message</b> targeting intents.
     * <p>
     * Constant value: <b>sms</b>
     */
    public static final String URI_SCHEME = "sms";

    /**
     * Members =====================================================================================
     */

    /**
     * Phone number to send SMS to.
     */
    private String mPhoneNumber;

    /**
     * Body of an SMS to send.
     */
    private CharSequence mBody;

    /**
     * Constructors ================================================================================
     */

    /**
     * Creates a new instance of SmsIntent for the given <var>activity</var> context.
     * See {@link com.albedinsky.android.support.intent.BaseIntent#BaseIntent(Activity)}
     * for additional info.
     */
    public SmsIntent(@NonNull Activity activity) {
        super(activity);
    }

    /**
     * Creates a new instance of SmsIntent for the given <var>fragment</var> context.
     * See {@link com.albedinsky.android.support.intent.BaseIntent#BaseIntent(android.support.v4.app.Fragment)}
     * for additional info.
     */
    public SmsIntent(@NonNull Fragment fragment) {
        super(fragment);
    }

    /**
     * Methods =====================================================================================
     */

    /**
     * Same as {@link #phoneNumber(String)} for resource id.
     *
     * @param resId Resource id of the desired phone number.
     */
    public SmsIntent phoneNumber(@StringRes int resId) {
        return phoneNumber(obtainString(resId));
    }

    /**
     * Sets a phone number that should be passed to the SMS application.
     *
     * @param number The desired phone number.
     * @return This intent builder to allow methods chaining.
     */
    public SmsIntent phoneNumber(@Nullable String number) {
        this.mPhoneNumber = number;
        return this;
    }

    /**
     * Returns the phone number that will be passed to the SMS application.
     *
     * @return Phone number or empty string if not specified yet.
     */
    @NonNull
    public String phoneNumber() {
        return mPhoneNumber != null ? mPhoneNumber : "";
    }

    /**
     * Same as {@link #body(CharSequence)} for resource id.
     *
     * @param resId Resource id of the desired SMS body.
     */
    public SmsIntent body(@StringRes int resId) {
        return body(obtainText(resId));
    }

    /**
     * Sets a body for SMS to send.
     *
     * @param body The desired body text.
     * @return This intent builder to allow methods chaining.
     * @see #body()
     */
    public SmsIntent body(@NonNull CharSequence body) {
        this.mBody = body;
        return this;
    }

    /**
     * Returns the body for SMS to send.
     *
     * @return Message of SMS or empty text if not specified yet.
     * @see #body(CharSequence)
     */
    @NonNull
    public CharSequence body() {
        return mBody != null ? mBody : "";
    }

    /**
     */
    @Override
    protected void ensureCanBuildOrThrow() {
        super.ensureCanBuildOrThrow();
        if (TextUtils.isEmpty(mPhoneNumber)) {
            throw cannotBuildIntentException("No phone number specified.");
        }
    }

    /**
     */
    @NonNull
    @Override
    protected Intent onBuild() {
        final Intent intent = new Intent(Intent.ACTION_VIEW, Uri.fromParts(URI_SCHEME, mPhoneNumber, null));
        if (!TextUtils.isEmpty(mBody)) {
            intent.putExtra("sms_body", mBody);
        }
        return intent;
    }

    /**
     * Inner classes ===============================================================================
     */
}