Helper.java

/*
 *
 * The DbUnit Database Testing Framework
 * Copyright (C)2002-2004, DbUnit.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

package org.dbunit.dataset.common.handlers;

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

/**
 * Abstract helper that assists a {@link PipelineComponent} in processing a character.
 *
 * @author fede
 * @author Last changed by: $Author$
 * @version $Revision$ $Date$
 * @since 2.2 (Sep 12, 2004)
 */
public abstract class Helper {

    /**
     * Logger for this class
     */
    private static final Logger logger = LoggerFactory.getLogger(Helper.class);

    private PipelineComponent handler;

    abstract void helpWith(char c) throws PipelineException;

    /**
     * Returns whether this helper allows input to end while it is active. The default
     * implementation always allows it.
     *
     * @return <code>true</code> if ending input now is allowed.
     * @throws IllegalStateException if this helper's state cannot be evaluated.
     */
    public boolean allowForNoMoreInput() throws IllegalStateException {
        return true;
    }

    PipelineComponent getHandler() {
        return handler;
    }

    void setHandler(PipelineComponent handler) {
        logger.debug("setHandler(handler={}) - start", handler);
        this.handler = handler;
    }
}