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