1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2018 The Dagger Authors. 3*f585d8a3SJacky Wang * 4*f585d8a3SJacky Wang * Licensed under the Apache License, Version 2.0 (the "License"); 5*f585d8a3SJacky Wang * you may not use this file except in compliance with the License. 6*f585d8a3SJacky Wang * You may obtain a copy of the License at 7*f585d8a3SJacky Wang * 8*f585d8a3SJacky Wang * http://www.apache.org/licenses/LICENSE-2.0 9*f585d8a3SJacky Wang * 10*f585d8a3SJacky Wang * Unless required by applicable law or agreed to in writing, software 11*f585d8a3SJacky Wang * distributed under the License is distributed on an "AS IS" BASIS, 12*f585d8a3SJacky Wang * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13*f585d8a3SJacky Wang * See the License for the specific language governing permissions and 14*f585d8a3SJacky Wang * limitations under the License. 15*f585d8a3SJacky Wang */ 16*f585d8a3SJacky Wang 17*f585d8a3SJacky Wang package dagger.producers.internal; 18*f585d8a3SJacky Wang 19*f585d8a3SJacky Wang import dagger.producers.Producer; 20*f585d8a3SJacky Wang 21*f585d8a3SJacky Wang /** A {@link Producer} that can be cancelled directly even if it hasn't been started. */ 22*f585d8a3SJacky Wang public interface CancellableProducer<T> extends Producer<T> { 23*f585d8a3SJacky Wang 24*f585d8a3SJacky Wang /** 25*f585d8a3SJacky Wang * Cancels this producer. If {@link #get()} has already been called, the future it returns will be 26*f585d8a3SJacky Wang * cancelled if possible. If not, calling {@link #get()} will return a cancelled future and will 27*f585d8a3SJacky Wang * not actually start the underlying operation. 28*f585d8a3SJacky Wang * 29*f585d8a3SJacky Wang * @param mayInterruptIfRunning the value that should be passed to {@code Future.cancel(boolean)} 30*f585d8a3SJacky Wang * for the futures for any running tasks when cancelling them 31*f585d8a3SJacky Wang */ cancel(boolean mayInterruptIfRunning)32*f585d8a3SJacky Wang void cancel(boolean mayInterruptIfRunning); 33*f585d8a3SJacky Wang 34*f585d8a3SJacky Wang /** Returns a new view of this producer for use as a dependency of another node. */ newDependencyView()35*f585d8a3SJacky Wang Producer<T> newDependencyView(); 36*f585d8a3SJacky Wang 37*f585d8a3SJacky Wang /** 38*f585d8a3SJacky Wang * Returns a new view of this producer for use as an entry point. 39*f585d8a3SJacky Wang * 40*f585d8a3SJacky Wang * <p>When the view's future is cancelled, the given {@code cancellableListener} will be called. 41*f585d8a3SJacky Wang */ newEntryPointView(CancellationListener cancellationListener)42*f585d8a3SJacky Wang Producer<T> newEntryPointView(CancellationListener cancellationListener); 43*f585d8a3SJacky Wang } 44