org.vesalainen.io.Pushbackable Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014 Timo Vesalainen
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package org.vesalainen.io;

import java.io.IOException;
import java.nio.Buffer;

/**
 * A class that implements this interface is able to pushback data, so that
 * the pushbacked data becomes input.
 * @author Timo Vesalainen
 * @param 
 */
public interface Pushbackable
{
    /**
     * Pushes buffers back. Following reads will return buffers content in that order.
     * @param buffer
     * @throws IOException 
     */
    void pushback(I... buffer) throws IOException;
    /**
     * Returns true if there are pushback data to read.
     * @return 
     */
    boolean hasPushback();
}