xref: /frameworks/support/work/workmanager/src/main/java/androidx/work/WorkRequest.java

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * 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 android.arch.background.workmanager;

import android.arch.background.workmanager.impl.WorkImpl;
import android.support.annotation.NonNull;
import android.support.annotation.VisibleForTesting;

import java.util.ArrayList;
import java.util.List;

/**
 * A class to execute a logical unit of non-repeating work.
 */

public abstract class Work implements BaseWork {

    /**
     * Creates an array of {@link Work} with defaults from an array of {@link Worker} class names.
     *
     * @param workerClasses An array of {@link Worker} class names
     * @return An array of {@link Work} constructed by using defaults in the {@link Builder}
     */
    public static Work[] from(@NonNull Class<? extends Worker>... workerClasses) {
        Work[] workArray = new Work[workerClasses.length];
        for (int i = 0; i < workerClasses.length; ++i) {
            workArray[i] = new Work.Builder(workerClasses[i]).build();
        }
        return workArray;
    }

    /**
     * Creates a list of {@link Work} with defaults from an array of {@link Worker} class names.
     *
     * @param workerClasses An array of {@link Worker} class names
     * @return A listof {@link Work} constructed by using defaults in the {@link Builder}
     */
    public static List<Work> from(@NonNull List<Class<? extends Worker>> workerClasses) {
        List<Work> workList = new ArrayList<>(workerClasses.size());
        for (Class<? extends Worker> workerClass : workerClasses) {
            workList.add(new Work.Builder(workerClass).build());
        }
        return workList;
    }

    /**
     * Builder for {@link Work} class.
     */
    public static class Builder implements WorkBuilder<Work, Builder> {

        private WorkImpl.Builder mInternalBuilder;

        /**
         * Creates a {@link Work} that runs once.
         *
         * @param workerClass The {@link Worker} class to run with this job
         */
        public Builder(Class<? extends Worker> workerClass) {
            mInternalBuilder = new WorkImpl.Builder(workerClass);
        }

        /**
         * Specify whether {@link Work} should run with an initial delay. Default is 0ms.
         *
         * @param duration initial delay before running WorkSpec (in milliseconds)
         * @return The current {@link Builder}
         */
        @Override
        public Builder withInitialDelay(long duration) {
            mInternalBuilder.withInitialDelay(duration);
            return this;
        }

        /**
         * Specify an {@link InputMerger}.  The default is {@link OverwritingInputMerger}.
         *
         * @param inputMerger The class name of the {@link InputMerger} to use for this {@link Work}
         * @return The current {@link Builder}
         */
        @Override
        public Builder withInputMerger(@NonNull Class<? extends InputMerger> inputMerger) {
            mInternalBuilder.withInputMerger(inputMerger);
            return this;
        }

        @Override
        public Builder withBackoffCriteria(
                @NonNull BackoffPolicy backoffPolicy,
                long backoffDelayMillis) {
            mInternalBuilder.withBackoffCriteria(backoffPolicy, backoffDelayMillis);
            return this;
        }

        @Override
        public Builder withConstraints(@NonNull Constraints constraints) {
            mInternalBuilder.withConstraints(constraints);
            return this;
        }

        @Override
        public Builder withArguments(@NonNull Arguments arguments) {
            mInternalBuilder.withArguments(arguments);
            return this;
        }

        @Override
        public Builder addTag(@NonNull String tag) {
            mInternalBuilder.addTag(tag);
            return this;
        }

        @Override
        public Work build() {
            return mInternalBuilder.build();
        }

        @VisibleForTesting
        @Override
        public Builder withInitialStatus(WorkStatus status) {
            mInternalBuilder.withInitialStatus(status);
            return this;
        }

        @VisibleForTesting
        @Override
        public Builder withInitialRunAttemptCount(int runAttemptCount) {
            mInternalBuilder.withInitialRunAttemptCount(runAttemptCount);
            return this;
        }

        @VisibleForTesting
        @Override
        public Builder withPeriodStartTime(long periodStartTime) {
            mInternalBuilder.withPeriodStartTime(periodStartTime);
            return this;
        }
    }
}