dagger.producers.monitoring.ProductionComponentMonitor Maven / Gradle / Ivy
Show all versions of dagger-producers Show documentation
/*
* Copyright (C) 2015 The Dagger Authors.
*
* 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 dagger.producers.monitoring;
import dagger.producers.Produces;
import dagger.producers.ProductionComponent;
/**
* A hook for monitoring execution of {@linkplain ProductionComponent production components}. To
* install a {@code ProductionComponentMonitor}, contribute to a set binding of
* {@code ProductionComponentMonitor.Factory}. The factory will be asked to create one monitor for
* the component, and the resulting single instance will be used to create individual monitors for
* producers.
*
* For example:
* {@literal @Module}
* final class MyMonitorModule {
* {@literal @Provides @IntoSet} ProductionComponentMonitor.Factory provideMonitorFactory(
* MyProductionComponentMonitor.Factory monitorFactory) {
* return monitorFactory;
* }
* }
*
* {@literal @ProductionComponent(modules = {MyMonitorModule.class, MyProducerModule.class})}
* interface MyComponent {
* {@literal ListenableFuture} someType();
* }
*
*
* If any of these methods throw, then the exception will be logged, and the framework will act
* as though a no-op monitor was returned.
*
* @since 2.1
*/
public abstract class ProductionComponentMonitor {
/** Returns a monitor for an individual {@linkplain Produces producer method}. */
public abstract ProducerMonitor producerMonitorFor(ProducerToken token);
private static final ProductionComponentMonitor NO_OP =
new ProductionComponentMonitor() {
@Override
public ProducerMonitor producerMonitorFor(ProducerToken token) {
return ProducerMonitor.noOp();
}
};
/** Returns a monitor that does no monitoring. */
public static ProductionComponentMonitor noOp() {
return NO_OP;
}
public abstract static class Factory {
/** Creates a component-specific monitor when the component is created. */
public abstract ProductionComponentMonitor create(Object component);
private static final Factory NO_OP_FACTORY =
new Factory() {
@Override
public ProductionComponentMonitor create(Object component) {
return ProductionComponentMonitor.noOp();
}
};
/** Returns a factory that returns no-op monitors. */
public static Factory noOp() {
return NO_OP_FACTORY;
}
}
}