com.thesett.common.util.Sink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-toolkit Show documentation

JUnit Toolkit enhances JUnit with performance testing, asymptotic behaviour analysis, and concurrency testing.

There is a newer version: 0.9.52

/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * 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.thesett.common.util;

/**
 * A Sink is the point at which a producer may add items into a queue. This interface is compatable with
 * java.util.Queue, in that any Queue implementation can also implement this interface with no further work. Sink has
 * been created as a seperate interface, to inroduce the possibility of a data structure that only exposes its Sink, and
 * hides the remainder of its operations.
 *
 * 
 * CRC Card Responsibilities
 * 
 Add elements to a queue.
 * 
 *
 * @author Rupert Smith
 */
public interface Sink
{
    /**
     * Inserts the specified element into this queue, if possible. When using queues that may impose insertion
     * restrictions (for example capacity bounds), method offer is generally preferable to method
     * {@link java.util.Collection#add}, which can fail to insert an element only by throwing an exception.
     *
     * @param  o T The element to insert.
     *
     * @return true if it was possible to add the element to this queue, else false.
     */
    boolean offer(E o);
}