All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.gh.bmd.jrt.android.builder.InvocationContextChannelBuilder Maven / Gradle / Ivy

There is a newer version: 6.0.0
Show newest version
/*
 * 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 com.gh.bmd.jrt.android.builder;

import com.gh.bmd.jrt.android.builder.ContextRoutineBuilder.CacheStrategyType;
import com.gh.bmd.jrt.builder.ConfigurableBuilder;
import com.gh.bmd.jrt.builder.RoutineConfiguration;
import com.gh.bmd.jrt.channel.OutputChannel;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Interface defining a builder of output channels bound to routine invocations.
* In order to be successfully bound, the specific routine invocation must have a user defined ID * and still running (or cached) at the time of the channel creation. *

* Created by davide on 1/14/15. * * @see InvocationContextRoutineBuilder */ public interface InvocationContextChannelBuilder extends ConfigurableBuilder { /** * Builds and returns an output channel bound to the routine invocation. * * @return the newly created output channel. */ @Nonnull OutputChannel buildChannel(); /** * Tells the builder how to cache the invocation result after its completion. A null value means * that it is up to the framework to choose a default strategy. * * @param strategyType the cache strategy. * @return this builder. */ @Nonnull InvocationContextChannelBuilder onComplete(@Nullable CacheStrategyType strategyType); /** * Makes the builder destroy all the cached invocation instances. */ void purge(); /** * Makes the builder destroy the cached invocation instances with the specified input. * * @param input the input. */ void purge(@Nullable Object input); /** * Makes the builder destroy the cached invocation instances with the specified inputs. * * @param inputs the inputs. */ void purge(@Nullable Object... inputs); /** * Makes the builder destroy the cached invocation instances with the specified inputs. * * @param inputs the inputs. */ void purge(@Nullable Iterable inputs); /** * Note that only the options related to logs will be employed. * * @param configuration the routine configuration. * @return this builder. */ @Nonnull InvocationContextChannelBuilder withConfiguration(@Nullable RoutineConfiguration configuration); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy