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.Flushable;
023import java.io.IOException;
024
025/**
026 * Defines the interface for a consumer.
027 *
028 * @param <C> the consumed element generic type
029 */
030public interface Consumer<C> extends Flushable {
031
032  /**
033   * Provide an element.
034   *
035   * @param element the provided element
036   */
037  void provide(C element) throws IOException;
038
039  /**
040   * Returns the class of the element generic type.
041   *
042   * @return the consumed type
043   */
044  Class<C> getConsumedType();
045}