org.jruby.util.io

Class OpenFile

java.lang.Object

org.jruby.util.io.OpenFile

public class OpenFile
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpenFile.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPEND
static int	BINMODE
static int	CREATE
static int	RBUF
static int	READABLE
static int	READWRITE
static int	SETENC_BY_BOM
static int	SYNC
static int	SYNCWRITE
static int	TEXTMODE
static int	TRUNC
static int	WBUF
static int	WRITABLE
static int	WSPLIT
static int	WSPLIT_INITIALIZED

Constructor Summary

Constructors

Constructor and Description
OpenFile()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areBothEOF()
void	checkClosed(Ruby runtime)
void	checkReadable(Ruby runtime)
void	checkWritable(Ruby runtime)
void	cleanup(Ruby runtime, boolean raise)
void	clearTextMode()
void	fflush(Stream stream)
void	finalize(Ruby runtime, boolean raise)
OpenFile.Finalizer	getFinalizer()
static int	getFModeFromString(String modesString)
int	getLineNumber()
Stream	getMainStream()
Stream	getMainStreamSafe()
int	getMode()
String	getModeAsString(Ruby runtime)
static int	getModeFlagsAsIntFrom(int fmode)
String	getPath()
long	getPid()
Stream	getPipeStream()
Stream	getPipeStreamSafe()
Process	getProcess()
static String	getStringFromMode(int mode)
Stream	getWriteStream()
Stream	getWriteStreamSafe()
boolean	isAutoclose()
boolean	isBinmode()
boolean	isOpen()
boolean	isReadable()
boolean	isReadBuffered()
boolean	isStdio()
boolean	isSync()
boolean	isTextMode()
boolean	isWritable()
boolean	isWriteBuffered()
void	seek(long offset, int whence)
void	setAutoclose(boolean autoclose)
void	setBinmode()
void	setFinalizer(OpenFile.Finalizer finalizer)
void	setLineNumber(int lineNumber)
void	setMainStream(Stream mainStream)
void	setMode(int modes)
void	setPath(String path)
void	setPipeStream(Stream pipeStream)
void	setProcess(Process process)
void	setReadBuffered()
void	setStdio(boolean stdio)
void	setSync(boolean sync)
void	setTextMode()
void	setWriteBuffered()

Methods inherited from class java.lang.Object

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

Field Detail

READABLE

public static final int READABLE

See Also:

Constant Field Values

WRITABLE

public static final int WRITABLE

See Also:

Constant Field Values

READWRITE

public static final int READWRITE

See Also:

Constant Field Values

BINMODE

public static final int BINMODE

See Also:

Constant Field Values

SYNC

public static final int SYNC

See Also:

Constant Field Values

WBUF

public static final int WBUF

See Also:

Constant Field Values

RBUF

public static final int RBUF

See Also:

Constant Field Values

APPEND

public static final int APPEND

See Also:

Constant Field Values

CREATE

public static final int CREATE

See Also:

Constant Field Values

WSPLIT

public static final int WSPLIT

See Also:

Constant Field Values

WSPLIT_INITIALIZED

public static final int WSPLIT_INITIALIZED

See Also:

Constant Field Values

TRUNC

public static final int TRUNC

See Also:

Constant Field Values

TEXTMODE

public static final int TEXTMODE

See Also:

Constant Field Values

SETENC_BY_BOM

public static final int SETENC_BY_BOM

See Also:

Constant Field Values

SYNCWRITE

public static final int SYNCWRITE

See Also:

Constant Field Values

Constructor Detail

OpenFile

public OpenFile()

Method Detail

getMainStream

public Stream getMainStream()

getMainStreamSafe

public Stream getMainStreamSafe()
                         throws BadDescriptorException

Throws:

BadDescriptorException

setMainStream

public void setMainStream(Stream mainStream)

getPipeStream

public Stream getPipeStream()

getPipeStreamSafe

public Stream getPipeStreamSafe()
                         throws BadDescriptorException

Throws:

BadDescriptorException

setPipeStream

public void setPipeStream(Stream pipeStream)

getWriteStream

public Stream getWriteStream()

getWriteStreamSafe

public Stream getWriteStreamSafe()
                          throws BadDescriptorException

Throws:

BadDescriptorException

getMode

public int getMode()

getModeAsString

public String getModeAsString(Ruby runtime)

getModeFlagsAsIntFrom

public static int getModeFlagsAsIntFrom(int fmode)

getFModeFromString

public static int getFModeFromString(String modesString)
                              throws InvalidValueException

Throws:

InvalidValueException

getStringFromMode

public static String getStringFromMode(int mode)

checkReadable

public void checkReadable(Ruby runtime)
                   throws IOException,
                          BadDescriptorException,
                          InvalidValueException

Throws:

IOException

BadDescriptorException

InvalidValueException

seek

public void seek(long offset,
        int whence)
          throws IOException,
                 InvalidValueException,
                 PipeException,
                 BadDescriptorException

Throws:

IOException

InvalidValueException

PipeException

BadDescriptorException

fflush

public void fflush(Stream stream)
            throws IOException,
                   BadDescriptorException

Throws:

IOException

BadDescriptorException

checkWritable

public void checkWritable(Ruby runtime)
                   throws IOException,
                          BadDescriptorException,
                          InvalidValueException

Throws:

IOException

BadDescriptorException

InvalidValueException

checkClosed

public void checkClosed(Ruby runtime)

isBinmode

public boolean isBinmode()

isTextMode

public boolean isTextMode()

setTextMode

public void setTextMode()

clearTextMode

public void clearTextMode()

setBinmode

public void setBinmode()

isOpen

public boolean isOpen()

isReadable

public boolean isReadable()

isWritable

public boolean isWritable()

isReadBuffered

public boolean isReadBuffered()

setReadBuffered

public void setReadBuffered()

isWriteBuffered

public boolean isWriteBuffered()

setWriteBuffered

public void setWriteBuffered()

setSync

public void setSync(boolean sync)

isSync

public boolean isSync()

areBothEOF

public boolean areBothEOF()
                   throws IOException,
                          BadDescriptorException

Throws:

IOException

BadDescriptorException

setMode

public void setMode(int modes)

getProcess

public Process getProcess()

setProcess

public void setProcess(Process process)

getPid

public long getPid()

getLineNumber

public int getLineNumber()

setLineNumber

public void setLineNumber(int lineNumber)

getPath

public String getPath()

setPath

public void setPath(String path)

isAutoclose

public boolean isAutoclose()

setAutoclose

public void setAutoclose(boolean autoclose)

setStdio

public void setStdio(boolean stdio)

isStdio

public boolean isStdio()

getFinalizer

public OpenFile.Finalizer getFinalizer()

setFinalizer

public void setFinalizer(OpenFile.Finalizer finalizer)

cleanup

public void cleanup(Ruby runtime,
           boolean raise)

finalize

public void finalize(Ruby runtime,
            boolean raise)