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 import java.io.IOException; 024 025 /** 026 * A producer that produces elements in a specific consumer. 027 * 028 * @param <P> the produced element generic type 029 * @param <C> the consumer element generic type 030 */ 031 public interface Producer<P, C extends Consumer<P>> extends Closeable { 032 033 /** 034 * Returns the class of the produced type. 035 * 036 * @return the produced type 037 */ 038 Class<P> getProducedType(); 039 040 /** 041 * Open the producer with the specified consumer. 042 * 043 * @param consumer the consumer 044 */ 045 void open(C consumer); 046 047 /** 048 * Close the producer. 049 */ 050 void close() throws IOException; 051 052 }