public class

StopWorkRunnable

extends java.lang.Object

implements java.lang.Runnable

 java.lang.Object

↳androidx.work.impl.utils.StopWorkRunnable

Gradle dependencies

compile group: 'androidx.work', name: 'work-runtime', version: '2.8.0-alpha02'

  • groupId: androidx.work
  • artifactId: work-runtime
  • version: 2.8.0-alpha02

Artifact androidx.work:work-runtime:2.8.0-alpha02 it located at Google repository (https://maven.google.com/)

Overview

A java.lang.Runnable that requests Processor to stop the work

Summary

Constructors
publicStopWorkRunnable(WorkManagerImpl workManagerImpl, java.lang.String workSpecId, boolean stopInForeground)

Methods
public voidrun()

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public StopWorkRunnable(WorkManagerImpl workManagerImpl, java.lang.String workSpecId, boolean stopInForeground)

Methods

public void run()

Source

/*
 * Copyright 2018 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 androidx.work.impl.utils;

import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.work.Logger;
import androidx.work.impl.WorkManagerImpl;

/**
 * A {@link Runnable} that requests {@link androidx.work.impl.Processor} to stop the work
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class StopWorkRunnable implements Runnable {

    private static final String TAG = Logger.tagWithPrefix("StopWorkRunnable");

    private final WorkManagerImpl mWorkManagerImpl;
    private final String mWorkSpecId;
    private final boolean mStopInForeground;

    public StopWorkRunnable(
            @NonNull WorkManagerImpl workManagerImpl,
            @NonNull String workSpecId,
            boolean stopInForeground) {
        mWorkManagerImpl = workManagerImpl;
        mWorkSpecId = workSpecId;
        mStopInForeground = stopInForeground;
    }
    @Override
    public void run() {
        boolean isStopped;
        if (mStopInForeground) {
            isStopped = mWorkManagerImpl
                    .getProcessor()
                    .stopForegroundWork(mWorkSpecId);
        } else {
            // This call is safe to make for foreground work because Processor ignores requests
            // to stop for foreground work.
            isStopped = mWorkManagerImpl
                    .getProcessor()
                    .stopWork(mWorkSpecId);
        }

        Logger.get().debug(
                TAG,
                "StopWorkRunnable for " + mWorkSpecId + "; Processor.stopWork = " + isStopped);

    }
}