org.osgi.util.pushstream.PushStreamBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.osgi.util.pushstream Show documentation

OSGi Companion Code for org.osgi.util.pushstream Version 1.0.1

There is a newer version: 1.1.0

Show newest version

/*
 * Copyright (c) OSGi Alliance (2015, 2017). All Rights Reserved.
 * 
 * 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 org.osgi.util.pushstream;

import java.util.concurrent.BlockingQueue;
import java.util.concurrent.Executor;
import java.util.concurrent.ScheduledExecutorService;

import org.osgi.annotation.versioning.ProviderType;

/**
 * A Builder for a PushStream. This Builder extends the support of a standard
 * BufferBuilder by allowing the PushStream to be unbuffered.
 * 
 *
 * @param  The type of objects in the {@link PushEvent}
 * @param  The type of the Queue used in the user specified buffer
 */
@ProviderType
public interface PushStreamBuilder>>
		extends BufferBuilder,T,U> {

	/**
	 * Tells this {@link PushStreamBuilder} to create an unbuffered stream which
	 * delivers events directly to its consumer using the incoming delivery
	 * thread. Setting the {@link PushStreamBuilder} to be unbuffered means that
	 * any buffer, queue policy or push back policy will be ignored. Note that
	 * calling one of:
	 * 
	 * {@link #withBuffer(BlockingQueue)}
	 * {@link #withQueuePolicy(QueuePolicy)}
	 * {@link #withQueuePolicy(QueuePolicyOption)}
	 * {@link #withPushbackPolicy(PushbackPolicy)}
	 * {@link #withPushbackPolicy(PushbackPolicyOption, long)}
	 * {@link #withParallelism(int)}
	 * 
	 * after this method will reset this builder to require a buffer.
	 * 
	 * @return the builder
	 */
	PushStreamBuilder unbuffered();

	/*
	 * Overridden methods to allow the covariant return of a PushStreamBuilder
	 */

	@Override
	PushStreamBuilder withBuffer(U queue);

	@Override
	PushStreamBuilder withQueuePolicy(QueuePolicy queuePolicy);

	@Override
	PushStreamBuilder withQueuePolicy(QueuePolicyOption queuePolicyOption);

	@Override
	PushStreamBuilder withPushbackPolicy(
			PushbackPolicy pushbackPolicy);

	@Override
	PushStreamBuilder withPushbackPolicy(
			PushbackPolicyOption pushbackPolicyOption, long time);

	@Override
	PushStreamBuilder withParallelism(int parallelism);

	@Override
	PushStreamBuilder withExecutor(Executor executor);

	@Override
	PushStreamBuilder withScheduler(ScheduledExecutorService scheduler);
}