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