com.jmatio.io.stream.DataOutputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of matfilerw Show documentation

MatFileRW - Read and write .mat files

There is a newer version: 3.1.1

/*
 * Code licensed under new-style BSD (see LICENSE).
 * All code up to tags/original: Copyright (c) 2006, Wojciech Gradkowski
 * All code after tags/original: Copyright (c) 2015, DiffPlug
 */
package com.jmatio.io.stream;

import java.io.IOException;
import java.nio.ByteBuffer;

interface DataOutputStream {
	/**
	 * Returns the current size of this stream.
	 * 
	 * @return the current size of this stream.
	 * @throws IOException
	 */
	public abstract int size() throws IOException;

	/**
	 * Returns the current {@link ByteBuffer} mapped on the target file.
	 * 
	 * Note: the {@link ByteBuffer} has READ ONLY access.
	 * 
	 * @return the {@link ByteBuffer}
	 * @throws IOException
	 */
	public abstract ByteBuffer getByteBuffer() throws IOException;

	/**
	 * Writes a sequence of bytes to this stream from the given buffer.
	 * 
	 * @param byteBuffer
	 *            the source {@link ByteBuffer}
	 * @throws IOException
	 */
	public abstract void write(ByteBuffer byteBuffer) throws IOException;

}