org.jruby.util
Class IOHandlerSeekable

java.lang.Object
  org.jruby.util.IOHandler
      org.jruby.util.IOHandlerJavaIO
          org.jruby.util.IOHandlerSeekable

All Implemented Interfaces:

Finalizable

public class IOHandlerSeekable
extends IOHandlerJavaIO
implements Finalizable

This file implements a seekable IO file.

Author:

Thomas E Enebo (enebo@acm.org)

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.util.IOHandler

IOHandler.BadDescriptorException, IOHandler.InvalidValueException, IOHandler.PipeException

Field Summary

protected java.nio.ByteBuffer	buffer
protected java.nio.channels.FileChannel	channel
protected java.lang.String	cwd
protected java.io.RandomAccessFile	file
protected java.lang.String	path
protected boolean	reading

Fields inherited from class org.jruby.util.IOHandlerJavaIO

ungotc

Fields inherited from class org.jruby.util.IOHandler

fileno, isOpen, isSync, modes, PARAGRAPH_DELIMETER, SEEK_CUR, SEEK_END, SEEK_SET

Constructor Summary

IOHandlerSeekable(Ruby runtime, java.lang.String path, IOModes modes)

Method Summary

IOHandler	cloneIOHandler()
void	close() Close IO handler resources.
void	finalize() Ensure close (especially flush) when we're finished with
void	flush()
java.nio.channels.FileChannel	getFileChannel()
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream()
ByteList	getsEntireStream()
boolean	isEOF() Return true when at end of file (EOF).
int	pid() Get the process ID associated with this handler.
long	pos() Get the current position within the file associated with this handler.
void	resetByModes(IOModes newModes)
void	rewind()
void	seek(long offset, int type) Perform a seek based on pos().
void	sync() Flush and sync all writes to the filesystem.
int	sysread()
ByteList	sysread(int number)
int	syswrite(ByteList buf)
int	syswrite(int c)
void	truncate(long newLength)

Methods inherited from class org.jruby.util.IOHandlerJavaIO

getc, gets, putc, read, read, ready, sysread, ungetc, write

Methods inherited from class org.jruby.util.IOHandler

checkOpen, checkPermissionsSubsetOf, checkReadable, checkWritable, checkWriteable, getFileno, getModes, getRuntime, hasPendingBuffered, isOpen, isReadable, isSync, isWriteable, reset, setFileno, setIsSync, waitUntilReady

Methods inherited from class java.lang.Object

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

Field Detail

file

protected java.io.RandomAccessFile file

path

protected java.lang.String path

cwd

protected java.lang.String cwd

buffer

protected java.nio.ByteBuffer buffer

reading

protected boolean reading

channel

protected java.nio.channels.FileChannel channel

Constructor Detail

IOHandlerSeekable

public IOHandlerSeekable(Ruby runtime,
                         java.lang.String path,
                         IOModes modes)
                  throws java.io.IOException,
                         IOHandler.InvalidValueException

Throws:

java.io.IOException

IOHandler.InvalidValueException

Method Detail

getsEntireStream

public ByteList getsEntireStream()
                          throws java.io.IOException

Overrides:

getsEntireStream in class IOHandlerJavaIO

Throws:

java.io.IOException

cloneIOHandler

public IOHandler cloneIOHandler()
                         throws java.io.IOException,
                                IOHandler.PipeException,
                                IOHandler.InvalidValueException

Specified by:

cloneIOHandler in class IOHandler

Throws:

java.io.IOException

IOHandler.PipeException

IOHandler.InvalidValueException

close

public void close()
           throws java.io.IOException,
                  IOHandler.BadDescriptorException

Close IO handler resources.

Specified by:

close in class IOHandler

Throws:

java.io.IOException

BadDescriptorException

IOHandler.BadDescriptorException

See Also:

IOHandler.close()

flush

public void flush()
           throws java.io.IOException,
                  IOHandler.BadDescriptorException

Specified by:

flush in class IOHandler

Throws:

java.io.IOException

BadDescriptorException

IOHandler.BadDescriptorException

See Also:

IOHandler.flush()

getInputStream

public java.io.InputStream getInputStream()

Specified by:

getInputStream in class IOHandlerJavaIO

See Also:

org.jruby.util.IOHandler#getInputStream()

getOutputStream

public java.io.OutputStream getOutputStream()

Specified by:

getOutputStream in class IOHandlerJavaIO

See Also:

org.jruby.util.IOHandler#getOutputStream()

isEOF

public boolean isEOF()
              throws java.io.IOException,
                     IOHandler.BadDescriptorException

Description copied from class: IOHandler

Return true when at end of file (EOF).

Specified by:

isEOF in class IOHandler

Returns:

true if at EOF; false otherwise

Throws:

java.io.IOException

BadDescriptorException

IOHandler.BadDescriptorException

See Also:

IOHandler.isEOF()

pid

public int pid()

Description copied from class: IOHandler

Get the process ID associated with this handler.

Specified by:

pid in class IOHandler

Returns:

the pid if the IOHandler represents a process; otherwise -1

See Also:

IOHandler.pid()

pos

public long pos()
         throws java.io.IOException

Description copied from class: IOHandler

Get the current position within the file associated with this handler.

Specified by:

pos in class IOHandler

Returns:

the current position in the file.

Throws:

java.io.IOException

See Also:

IOHandler.pos()

resetByModes

public void resetByModes(IOModes newModes)
                  throws java.io.IOException,
                         IOHandler.InvalidValueException

Specified by:

resetByModes in class IOHandler

Throws:

java.io.IOException

IOHandler.InvalidValueException

rewind

public void rewind()
            throws java.io.IOException,
                   IOHandler.InvalidValueException

Specified by:

rewind in class IOHandler

Throws:

java.io.IOException

InvalidValueException

IOHandler.InvalidValueException

See Also:

IOHandler.rewind()

seek

public void seek(long offset,
                 int type)
          throws java.io.IOException,
                 IOHandler.InvalidValueException

Description copied from class: IOHandler

Perform a seek based on pos().

Specified by:

seek in class IOHandler

Throws:

java.io.IOException

InvalidValueException

IOHandler.InvalidValueException

See Also:

IOHandler.seek(long, int)

sync

public void sync()
          throws java.io.IOException

Description copied from class: IOHandler

Flush and sync all writes to the filesystem.

Specified by:

sync in class IOHandler

Throws:

java.io.IOException - if the sync does not work

See Also:

IOHandler.sync()

sysread

public ByteList sysread(int number)
                 throws java.io.IOException,
                        IOHandler.BadDescriptorException

Overrides:

sysread in class IOHandlerJavaIO

Throws:

java.io.IOException

IOHandler.BadDescriptorException

sysread

public int sysread()
            throws java.io.IOException

Specified by:

sysread in class IOHandlerJavaIO

Throws:

java.io.IOException

See Also:

org.jruby.util.IOHandler#sysread()

syswrite

public int syswrite(ByteList buf)
             throws java.io.IOException,
                    IOHandler.BadDescriptorException

Specified by:

syswrite in class IOHandler

Throws:

java.io.IOException

BadDescriptorException

IOHandler.BadDescriptorException

See Also:

org.jruby.util.IOHandler#syswrite(String buf)

syswrite

public int syswrite(int c)
             throws java.io.IOException,
                    IOHandler.BadDescriptorException

Specified by:

syswrite in class IOHandler

Throws:

java.io.IOException

BadDescriptorException

IOHandler.BadDescriptorException

See Also:

org.jruby.util.IOHandler#syswrite(String buf)

truncate

public void truncate(long newLength)
              throws java.io.IOException

Specified by:

truncate in class IOHandler

Throws:

java.io.IOException

getFileChannel

public java.nio.channels.FileChannel getFileChannel()

Specified by:

getFileChannel in class IOHandler

finalize

public void finalize()

Ensure close (especially flush) when we're finished with

Specified by:

finalize in interface Finalizable

Overrides:

finalize in class java.lang.Object