net.sourceforge.javaflacencoder

Class FLACFileOutputStream

java.lang.Object

net.sourceforge.javaflacencoder.FLACFileOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable, FLACOutputStream

public class FLACFileOutputStream
extends Object
implements FLACOutputStream, Closeable

This class provides basic file output for writing from a FLACEncoder.

Author:

Preston Lacey

Constructor Summary

Constructors

Constructor and Description
FLACFileOutputStream(File file)
FLACFileOutputStream(FileOutputStream fos) Constructor.
FLACFileOutputStream(String filename) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canSeek() Test whether this stream is seekable.
void	close() Close FileOutputStream owned by this object.
long	getPos() Get the current write position of this stream.
boolean	isValid() Deprecated.
long	seek(long pos) Attempt to seek to the given location within this stream.
long	size() Get the number of bytes that have been written in length! This takes into account seeking to different portions.
void	write(byte data) Write a byte to this stream.
int	write(byte[] data, int offset, int count) Write the given number of bytes from the byte array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FLACFileOutputStream

public FLACFileOutputStream(String filename)
                     throws IOException

Constructor. Create a FLACFileOutputStream using the given filename. If file exists, file will be overwritten.

Parameters:

filename - file to connect to output stream.

Throws:

IOException

FLACFileOutputStream

public FLACFileOutputStream(File file)
                     throws IOException

Throws:

IOException

FLACFileOutputStream

public FLACFileOutputStream(FileOutputStream fos)
                     throws IOException

Constructor. Create a FLACFileOutputStream using the given FileOutputStream.

Parameters:

fos - FileOutputStream to write to, must be open. Current position of fos will be used as this object's position.

Throws:

IOException

Method Detail

isValid

@Deprecated
public boolean isValid()

Deprecated.

Get the status of this file stream(whether the file was successourceforgeully open or not).

Returns:

true if file was successourceforgeully opened, false otherwise.

seek

public long seek(long pos)
          throws IOException

Attempt to seek to the given location within this stream. It is not guaranteed that all implementations can or will support seeking. Use the method canSeek()

Specified by:

seek in interface FLACOutputStream

Parameters:

pos - target position to seek to.

Returns:

current position after seek attempt.

Throws:

IOException

write

public void write(byte data)
           throws IOException

Write a byte to this stream.

Specified by:

write in interface FLACOutputStream

Parameters:

data - byte to write.

Throws:

IOException - IOException will be raised if an error occurred while writing.

write

public int write(byte[] data,
                 int offset,
                 int count)
          throws IOException

Write the given number of bytes from the byte array. Return number of bytes written.

Specified by:

write in interface FLACOutputStream

Parameters:

data - array containing bytes to be written.

offset - start index of array to begin reading from.

count - number of bytes to write.

Returns:

number of bytes written.

Throws:

IOException - IOException upon a write error.

size

public long size()

Get the number of bytes that have been written in length! This takes into account seeking to different portions.

Specified by:

size in interface FLACOutputStream

Returns:

total length written.

canSeek

public boolean canSeek()

Test whether this stream is seekable.

Specified by:

canSeek in interface FLACOutputStream

Returns:

true if stream is seekable, false otherwise

getPos

public long getPos()

Get the current write position of this stream.

Specified by:

getPos in interface FLACOutputStream

Returns:

current write position.

close

public void close()
           throws IOException

Close FileOutputStream owned by this object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FLACOutputStream

Throws:

IOException