001 /* 002 * Copyright (C) 2012 eXo Platform SAS. 003 * 004 * This is free software; you can redistribute it and/or modify it 005 * under the terms of the GNU Lesser General Public License as 006 * published by the Free Software Foundation; either version 2.1 of 007 * the License, or (at your option) any later version. 008 * 009 * This software is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * You should have received a copy of the GNU Lesser General Public 015 * License along with this software; if not, write to the Free 016 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 017 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 018 */ 019 020 package org.crsh.io; 021 022 import java.io.Closeable; 023 024 /** 025 * A producer that produces elements in a specific consumer. 026 * 027 * @param <E> the element generic type 028 * @param <C> the consumer generic type 029 */ 030 public interface Producer<E, C extends Consumer<E>> extends Closeable { 031 032 /** 033 * Returns the class of the produced type. 034 * 035 * @return the produced type 036 */ 037 Class<E> getProducedType(); 038 039 /** 040 * Set the pipe status. 041 * 042 * @param piped the piped status 043 */ 044 void setPiped(boolean piped); 045 046 /** 047 * Open the producer with the specified consumer. 048 * 049 * @param consumer the consumer 050 */ 051 void open(C consumer); 052 053 /** 054 * Close the producer. 055 */ 056 void close(); 057 058 }