org.crsh.io

Interface Producer<P,C extends Consumer<? super P>>

Type Parameters:

P - the produced element generic type

C - the consumer element generic type

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

Filter<C,P,CONS>

All Known Implementing Classes:

AbstractPipe, ClosureInvoker, CommandInvoker, ConvertingPipe, PipeCommand, PipeLine, ToChunkPipe

public interface Producer<P,C extends Consumer<? super P>>
extends java.io.Closeable

A producer that produces elements in a specific consumer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the producer.
java.lang.Class<P>	getProducedType() Returns the class of the produced type.
void	open(C consumer) Open the producer with the specified consumer.

Method Detail

getProducedType

java.lang.Class<P> getProducedType()

Returns the class of the produced type.

Returns:

the produced type

open

void open(C consumer)

Open the producer with the specified consumer.

Parameters:

consumer - the consumer

close

void close()
           throws java.io.IOException,
                  java.lang.reflect.UndeclaredThrowableException

Close the producer.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - any io exception

java.lang.reflect.UndeclaredThrowableException - anything other kind of exception