Receiver.java

/*
 * Copyright (c) 2010, Rickard Öberg. 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.qi4j.io;

/**
 * Receiver of items during a specific transfer from an Input to an Output.
 */
// START SNIPPET: receiver
public interface Receiver<T, ReceiverThrowableType extends Throwable>
{
// END SNIPPET: receiver
    /**
     * Receive a single item of the given type. The receiver should process it
     * and optionally throw an exception if it fails.
     *
     * @param item
     *
     * @throws ReceiverThrowableType
     */
// START SNIPPET: receiver
    void receive( T item )
        throws ReceiverThrowableType;
}
// END SNIPPET: receiver