org.graphstream.stream.binary.ByteDecoder Maven / Gradle / Ivy

/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

/**
 * @since 2009-04-17
 * 
 * @author Guilhelm Savin 
 * @author Hicham Brahimi 
 */
package org.graphstream.stream.binary;

import org.graphstream.stream.Source;

import java.nio.ByteBuffer;

/**
 * Decode an event that has been encoded into a binary buffer and dispatch this
 * event to its sources. This is a complementary features of the event encoding
 * in {@link ByteEncoder}.
 *
 * @since 31/01/16.
 */
public interface ByteDecoder extends Source {
	/**
	 * Decode the buffer, and dispatch the corresponding event.
	 *
	 * @param buffer
	 *            event as a binary buffer
	 */
	void decode(ByteBuffer buffer);

	/**
	 * Tells if the buffer contains an event that is ready to be dispatched. The
	 * bytes considered should be from 0 to the buffer's position. The position of
	 * the buffer SHOULD NOT be changed.
	 *
	 * @param buffer
	 * @return true if the buffer contains an event
	 */
	boolean validate(ByteBuffer buffer);
}