org.mule.streaming.AbstractConsumer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mule-core Show documentation
Mule server and core classes
There is a newer version: 3.9.0
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.streaming;

import org.mule.api.MuleException;

import java.util.NoSuchElementException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Base implementation of {@link Consumer}. This template class takes care of the
 * contract's subtleties like returning fast when closed and throwing the correct
 * types of exceptions
 * 
 * @param  the type that the consumer will return
 * @param  the type that the producer generates
 * @since 3.5.0
 */
public abstract class AbstractConsumer implements Consumer
{

    private static final transient Logger logger = LoggerFactory.getLogger(AbstractConsumer.class);

    protected final Producer
 producer;
    private boolean closed = false;

    public AbstractConsumer(Producer producer)
    {
        this.producer = producer;
    }

    /**
     * Implement this method to actually consume the producer without worrying about
     * exception types or checking fo this consumer to be closed. If the producer is
     * consumed then simply return null
     * 
     * @return a new item or null
     * @throws NoSuchElementException
     */
    protected abstract T doConsume() throws NoSuchElementException;

    /**
     * Implement this method to actualy check for the {@link Producer} being fully
     * consumed without worrying about it being closed or throwing any exceptions
     * 
     * @return whether the {@link Producer} has been consumed or not
     */
    protected abstract boolean checkConsumed();

    /**
     * {@inheritDoc}
     */
    @Override
    public final T consume() throws NoSuchElementException
    {
        if (this.closed)
        {
            throw new ClosedConsumerException("this consumer is already closed");
        }

        if (this.isConsumed())
        {
            throw new NoSuchElementException();
        }

        T value = this.doConsume();

        if (value == null)
        {
            this.closeQuietly();
        }

        return value;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean isConsumed()
    {
        if (this.closed)
        {
            return true;
        }

        boolean isConsumed = this.checkConsumed();
        if (isConsumed)
        {
            this.closeQuietly();
        }
        return isConsumed;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() throws MuleException
    {
        this.closed = true;
        this.producer.close();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int size()
    {
        return this.producer.size();
    }

    private void closeQuietly()
    {
        try
        {
            this.close();
        }
        catch (MuleException e)
        {
            if (logger.isWarnEnabled())
            {
                logger.warn("Expection was trapped trying to close consumer", e);
            }
        }
    }

}