RubyIO (JRuby Core 9.2.11.1 API)

java.lang.Object
- org.jruby.RubyBasicObject
- - org.jruby.RubyObject
  - - org.jruby.RubyIO

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.io.Serializable, java.lang.AutoCloseable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, IOEncodable

Direct Known Subclasses:

FileDescriptorIO, RubyBasicSocket, RubyFile
```
public class RubyIO
extends RubyObject
implements IOEncodable, java.io.Closeable, java.io.Flushable
```
Author:

jpetersen

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RubyIO.Sysopen
- Nested classes/interfaces inherited from class org.jruby.RubyObject
  RubyObject.Data
- Nested classes/interfaces inherited from class org.jruby.RubyBasicObject
  RubyBasicObject.Finalizer
- Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable
  IOEncodable.ConvConfig

Nested Classes
Modifier and Type	Class and Description
`static class`	`RubyIO.Sysopen`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLOSED_STREAM_MSG`
`static int`	`FD_CLOEXEC`
`protected OpenFile`	`openFile`
`static ByteList`	`PARAGRAPH_SEPARATOR`
`protected boolean`	`popenSpecial` If the stream is being used for popen, we don't want to destroy the process when we close the stream.

Fields inherited from class org.jruby.RubyObject
IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject
ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject
NULL_ARRAY

Constructor Summary

Constructors
Constructor and Description
`RubyIO(Ruby runtime, java.nio.channels.Channel channel)`
`RubyIO(Ruby runtime, java.io.InputStream inputStream)`
`RubyIO(Ruby runtime, java.io.OutputStream outputStream)`
`RubyIO(Ruby runtime, java.io.OutputStream outputStream, boolean autoclose)`
`RubyIO(Ruby runtime, RubyClass type)`
`RubyIO(Ruby runtime, RubyClass klass, java.nio.channels.Channel channel)`
`RubyIO(Ruby runtime, RubyClass cls, ShellLauncher.POpenProcess process, RubyHash options, IOOptions ioOptions)` Deprecated.
`RubyIO(Ruby runtime, ShellLauncher.POpenProcess process, IOOptions ioOptions)`
`RubyIO(Ruby runtime, STDIO stdio)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBlockingThread(RubyThread thread)` Add a thread to the list of blocking threads for this IO.
`IRubyObject`	`advise(ThreadContext context, IRubyObject[] argv)`
`IRubyObject`	`autoclose_set(ThreadContext context, IRubyObject autoclose)`
`IRubyObject`	`autoclose(ThreadContext context)`
`IRubyObject`	`binmode()`
`static IRubyObject`	`binread(ThreadContext context, IRubyObject recv, IRubyObject[] args)` binread is just like read, except it doesn't take options and it forces mode to be "rb:ASCII-8BIT"
`static IRubyObject`	`binwrite(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`IRubyObject`	`bytes(ThreadContext context, Block block)`
`IRubyObject`	`chars(ThreadContext context, Block block)`
`IRubyObject`	`chars19(ThreadContext context, Block block)` Deprecated.
`static RubyArray`	`checkExecEnv(ThreadContext context, RubyHash hash)` Deprecated.
`static void`	`checkExecOptions(IRubyObject options)` Deprecated.
`static void`	`checkPopenOptions(IRubyObject options)` Deprecated.
`static void`	`checkSpawnOptions(IRubyObject options)` Deprecated.
`static ChannelFD`	`cloexecOpen(Ruby runtime, RubyIO.Sysopen data)`
`IRubyObject`	`close_on_exec_p(ThreadContext context)`
`IRubyObject`	`close_on_exec_set(ThreadContext context, IRubyObject arg)`
`IRubyObject`	`close_read(ThreadContext context)`
`IRubyObject`	`close_write(ThreadContext context)`
`void`	`close()`
`IRubyObject`	`close(ThreadContext context)` Closes all open resources for the IO.
`RubyBoolean`	`closed_p(ThreadContext context)`
`IRubyObject`	`codepoints(ThreadContext context, Block block)`
`static RubyIO`	`convertToIO(ThreadContext context, IRubyObject obj)`
`static IRubyObject`	`copy_stream(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static RubyClass`	`createIOClass(Ruby runtime)`
`IRubyObject`	`doReadNonblock(ThreadContext context, IRubyObject[] args, boolean exception)`
`IRubyObject`	`doWriteNonblock(ThreadContext context, IRubyObject[] argv, boolean useException)` Deprecated.
`IRubyObject`	`each_byte(ThreadContext context, Block block)`
`IRubyObject`	`each_byteInternal(ThreadContext context, Block block)` Invoke a block for each byte.
`IRubyObject`	`each_char(ThreadContext context, Block block)`
`IRubyObject`	`each_char19(ThreadContext context, Block block)` Deprecated.
`IRubyObject`	`each_charInternal(ThreadContext context, Block block)`
`IRubyObject`	`each_codepoint(ThreadContext context, Block block)`
`IRubyObject`	`each_line(ThreadContext context, Block block)`
`IRubyObject`	`each_line(ThreadContext context, IRubyObject[] args, Block block)`
`IRubyObject`	`each_line(ThreadContext context, IRubyObject arg0, Block block)`
`IRubyObject`	`each_line(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)`
`IRubyObject`	`each_line(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)`
`IRubyObject`	`each(ThreadContext context, Block block)`
`IRubyObject`	`each(ThreadContext context, IRubyObject[] args, Block block)`
`IRubyObject`	`each(ThreadContext context, IRubyObject arg0, Block block)`
`IRubyObject`	`each(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)`
`IRubyObject`	`each(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)`
`static IRubyObject`	`ensureYieldClose(ThreadContext context, IRubyObject port, Block block)`
`static IRubyObject`	`ensureYieldClosePipes(ThreadContext context, IRubyObject obj, RubyIO r, RubyIO w, Block block)`
`RubyBoolean`	`eof_p(ThreadContext context)`
`IRubyObject`	`external_encoding(ThreadContext context)`
`static void`	`failIfDirectory(Ruby runtime, RubyString pathStr)`
`IRubyObject`	`fcntl(ThreadContext context, IRubyObject cmd)`
`IRubyObject`	`fcntl(ThreadContext context, IRubyObject cmd, IRubyObject arg)`
`RubyFixnum`	`fileno(ThreadContext context)`
`void`	`flush()`
`RubyIO`	`flush(ThreadContext context)` Flushes the IO output stream.
`protected RubyIO`	`flushRaw(ThreadContext context, boolean sync)`
`static IRubyObject`	`for_fd(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)`
`static IRubyObject`	`foreach(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)`
`RubyFixnum`	`fsync(ThreadContext context)`
`boolean`	`getBlocking()`
`boolean`	`getBOM()`
`IRubyObject`	`getbyte(ThreadContext context)` Read a byte.
`int`	`getByte(ThreadContext context)`
`IRubyObject`	`getc()` Deprecated.
`IRubyObject`	`getc(ThreadContext context)`
`IRubyObject`	`getc19(ThreadContext context)` Deprecated.
`java.nio.channels.Channel`	`getChannel()` Get the underlying channel from this IO object.
`int`	`getEcflags()`
`IRubyObject`	`getEcopts()`
`org.jcodings.Encoding`	`getEnc()`
`org.jcodings.Encoding`	`getEnc2()`
`org.jcodings.Encoding`	`getInputEncoding()`
`java.io.InputStream`	`getInStream()`
`static ModeFlags`	`getIOModes(Ruby runtime, java.lang.String modesString)` Deprecated.
`static int`	`getIOModesIntFromString(Ruby runtime, java.lang.String modesString)` Deprecated.
`IRubyObject`	`getline(Ruby runtime, ByteList separator)` Deprecated.
`IRubyObject`	`getline(Ruby runtime, ByteList separator, long limit)` Deprecated.
`IRubyObject`	`getline(ThreadContext context, ByteList separator)` Deprecated.
`IRubyObject`	`getline(ThreadContext context, ByteList separator, long limit)` Deprecated.
`IRubyObject`	`getline(ThreadContext context, IRubyObject separator)`
`IRubyObject`	`getline(ThreadContext context, IRubyObject separator, long limit)` getline using logic of gets.
`ClassIndex`	`getNativeClassIndex()` This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
`OpenFile`	`getOpenFile()`
`OpenFile`	`getOpenFileChecked()`
`OpenFile`	`getOpenFileInitialized()`
`java.io.OutputStream`	`getOutStream()`
`org.jcodings.Encoding`	`getReadEncoding()`
`IRubyObject`	`gets(ThreadContext context)` Read a line.
`IRubyObject`	`gets(ThreadContext context, IRubyObject arg)`
`IRubyObject`	`gets(ThreadContext context, IRubyObject rs, IRubyObject limit_arg)`
`IRubyObject`	`gets(ThreadContext context, IRubyObject rs, IRubyObject limit_arg, IRubyObject opt)`
`boolean`	`getSync()`
`RubyIO`	`GetWriteIO()`
`IRubyObject`	`initialize_copy(IRubyObject _io)` rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object.
`IRubyObject`	`initialize(ThreadContext context, IRubyObject fileNumber, Block unused)`
`IRubyObject`	`initialize(ThreadContext context, IRubyObject fileNumber, IRubyObject second, Block unused)`
`IRubyObject`	`initialize(ThreadContext context, IRubyObject fileNumber, IRubyObject modeValue, IRubyObject options, Block unused)`
`IRubyObject`	`inspect()` rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
`IRubyObject`	`internal_encoding(ThreadContext context)`
`protected static IRubyObject`	`ioClose(ThreadContext context, IRubyObject io)`
`IRubyObject`	`ioctl(ThreadContext context, IRubyObject[] args)`
`static IRubyObject`	`ioOpen(ThreadContext context, IRubyObject filename, IRubyObject vmode, IRubyObject vperm, IRubyObject opt)` Deprecated.
`static IRubyObject`	`ioOpen(ThreadContext context, IRubyObject recv, IRubyObject filename, IRubyObject vmode, IRubyObject vperm, IRubyObject opt)`
`static IRubyObject`	`ioStaticWrite(ThreadContext context, IRubyObject recv, IRubyObject[] argv, boolean binary)`
`boolean`	`isAutoclose()`
`boolean`	`isClosed()` Is this IO closed MRI: rb_io_closed
`RubyFixnum`	`lineno_set(ThreadContext context, IRubyObject newLineNumber)` Sets the current line number.
`RubyFixnum`	`lineno(ThreadContext context)` Returns the current line number.
`IRubyObject`	`lines(ThreadContext context, Block block)`
`IRubyObject`	`lines19(ThreadContext context, Block block)` Deprecated.
`OpenFile`	`MakeOpenFile()`
`static IRubyObject`	`newInstance(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)`
`static RubyIO`	`newIO(Ruby runtime, java.nio.channels.Channel channel)`
`static IOOptions`	`newIOOptions(Ruby runtime, int mode)`
`static IOOptions`	`newIOOptions(Ruby runtime, IOOptions oldFlags, int orOflags)`
`static IOOptions`	`newIOOptions(Ruby runtime, long mode)`
`static IOOptions`	`newIOOptions(Ruby runtime, ModeFlags modeFlags)`
`static IOOptions`	`newIOOptions(Ruby runtime, java.lang.String mode)`
`static ModeFlags`	`newModeFlags(Ruby runtime, int mode)`
`static ModeFlags`	`newModeFlags(Ruby runtime, long mode)`
`static ModeFlags`	`newModeFlags(Ruby runtime, java.lang.String mode)`
`static void`	`obliterateProcess(java.lang.Process process)` Try for around 1s to destroy the child process.
`IRubyObject`	`op_append(ThreadContext context, IRubyObject anObject)` rb_io_addstr
`IRubyObject`	`op_binmode(ThreadContext context)`
`static IRubyObject`	`open(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)`
`protected IOOptions`	`parseIOOptions(IRubyObject arg)`
`IRubyObject`	`pid(ThreadContext context)` Return the process id (pid) of the process this IO object spawned.
`static IRubyObject`	`pipe(ThreadContext context, IRubyObject recv)`
`static IRubyObject`	`pipe(ThreadContext context, IRubyObject klass, IRubyObject[] argv, Block block)`
`static IRubyObject`	`pipe19(ThreadContext context, IRubyObject recv)` Deprecated.
`static IRubyObject`	`pipe19(ThreadContext context, IRubyObject recv, IRubyObject modes)` Deprecated.
`static IRubyObject`	`pipe19(ThreadContext context, IRubyObject klass, IRubyObject[] argv, Block block)` Deprecated.
`static IRubyObject`	`popen(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)`
`static IRubyObject`	`popen3(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)` Deprecated.
`static IRubyObject`	`popen4(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)` Deprecated.
`static org.jruby.RubyIO.POpenTuple`	`popenSpecial(ThreadContext context, IRubyObject[] args)` Deprecated.
`RubyFixnum`	`pos_set(ThreadContext context, IRubyObject offset)`
`RubyFixnum`	`pos(ThreadContext context)`
`IRubyObject`	`pread(ThreadContext context, IRubyObject len, IRubyObject offset)`
`IRubyObject`	`pread(ThreadContext context, IRubyObject len, IRubyObject offset, IRubyObject str)`
`static RubyIO`	`prepStdio(Ruby runtime, java.io.InputStream f, java.nio.channels.Channel c, int fmode, RubyClass klass, java.lang.String path)`
`static RubyIO`	`prepStdio(Ruby runtime, java.io.OutputStream f, java.nio.channels.Channel c, int fmode, RubyClass klass, java.lang.String path)`
`IRubyObject`	`print(ThreadContext context, IRubyObject[] args)` Print some objects to the stream.
`static IRubyObject`	`print(ThreadContext context, IRubyObject out, IRubyObject[] args)` Print some objects to the stream.
`IRubyObject`	`printf(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`putc(ThreadContext context, IRubyObject ch)`
`static IRubyObject`	`putc(ThreadContext context, IRubyObject maybeIO, IRubyObject object)`
`IRubyObject`	`puts(ThreadContext context)`
`IRubyObject`	`puts(ThreadContext context, IRubyObject arg0)`
`IRubyObject`	`puts(ThreadContext context, IRubyObject[] args)`
`static IRubyObject`	`puts(ThreadContext context, IRubyObject maybeIO, IRubyObject... args)`
`IRubyObject`	`puts(ThreadContext context, IRubyObject arg0, IRubyObject arg1)`
`IRubyObject`	`puts(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)`
`static IRubyObject`	`puts0(ThreadContext context, IRubyObject maybeIO)`
`static IRubyObject`	`puts1(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0)`
`static IRubyObject`	`puts2(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1)`
`static IRubyObject`	`puts3(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)`
`IRubyObject`	`pwrite(ThreadContext context, IRubyObject str, IRubyObject offset)`
`protected IRubyObject`	`rbIoClose(ThreadContext context)`
`IRubyObject`	`read_nonblock(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`read(IRubyObject[] args)`
`IRubyObject`	`read(ThreadContext context)`
`IRubyObject`	`read(ThreadContext context, IRubyObject arg0)`
`IRubyObject`	`read(ThreadContext context, IRubyObject length, IRubyObject str)`
`static IRubyObject`	`read(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`read(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)`
`static IRubyObject`	`read19(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)` Deprecated.
`IRubyObject`	`readbyte(ThreadContext context)`
`IRubyObject`	`readchar()` Deprecated.
`IRubyObject`	`readchar(ThreadContext context)` Read a char.
`IRubyObject`	`readline(ThreadContext context)` Read a line.
`IRubyObject`	`readline(ThreadContext context, IRubyObject separator)`
`IRubyObject`	`readline(ThreadContext context, IRubyObject[] args)` Deprecated.
`RubyArray`	`readlines(ThreadContext context)`
`RubyArray`	`readlines(ThreadContext context, IRubyObject arg0)`
`RubyArray`	`readlines(ThreadContext context, IRubyObject[] args)`
`RubyArray`	`readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1)`
`static IRubyObject`	`readlines(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)`
`RubyArray`	`readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)`
`RubyArray`	`readlines19(ThreadContext context, IRubyObject[] args)` Deprecated.
`static IRubyObject`	`readlines19(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)` Deprecated.
`IRubyObject`	`readpartial(ThreadContext context, IRubyObject[] args)`
`void`	`removeBlockingThread(RubyThread thread)` Remove a thread from the list of blocking threads for this IO.
`IRubyObject`	`reopen(ThreadContext context, IRubyObject[] args)`
`protected RubyIO`	`reopenIO(ThreadContext context, RubyIO nfile)`
`RubyFixnum`	`rewind(ThreadContext context)`
`RubyFixnum`	`seek(ThreadContext context, IRubyObject off)`
`RubyFixnum`	`seek(ThreadContext context, IRubyObject[] args)`
`RubyFixnum`	`seek(ThreadContext context, IRubyObject off, IRubyObject whence)`
`static IRubyObject`	`select_static(ThreadContext context, Ruby runtime, IRubyObject[] args)` Deprecated.
`static IRubyObject`	`select(ThreadContext context, IRubyObject recv, IRubyObject[] argv)`
`IRubyObject`	`set_encoding(ThreadContext context, IRubyObject encodingObj)`
`IRubyObject`	`set_encoding(ThreadContext context, IRubyObject encodingString, IRubyObject internalEncoding)`
`IRubyObject`	`set_encoding(ThreadContext context, IRubyObject encodingString, IRubyObject internalEncoding, IRubyObject options)`
`protected RubyIO`	`setAscii8bitBinmode()`
`void`	`setAutoclose(boolean autoclose)`
`void`	`setBlocking(boolean blocking)`
`void`	`setBOM(boolean bom)`
`void`	`setEcflags(int ecflags)`
`void`	`setEcopts(IRubyObject ecopts)`
`void`	`setEnc(org.jcodings.Encoding enc)`
`void`	`setEnc2(org.jcodings.Encoding enc2)`
`void`	`setEncoding(ThreadContext context, IRubyObject v1, IRubyObject v2, IRubyObject opt)`
`void`	`setSync(boolean sync)`
`IRubyObject`	`stat(ThreadContext context)`
`IRubyObject`	`sync_set(IRubyObject sync)` Sets the current sync mode.
`RubyBoolean`	`sync(ThreadContext context)` Returns the current sync mode.
`static IRubyObject`	`sysopen(IRubyObject recv, IRubyObject[] args, Block block)` Deprecated.
`protected static ChannelFD`	`sysopen(Ruby runtime, java.lang.String fname, int oflags, int perm)`
`static IRubyObject`	`sysopen(ThreadContext context, IRubyObject recv, IRubyObject[] argv, Block block)`
`static IRubyObject`	`sysopen19(ThreadContext context, IRubyObject recv, IRubyObject[] argv, Block block)` Deprecated.
`IRubyObject`	`sysread(ThreadContext context, IRubyObject[] args)`
`RubyFixnum`	`sysseek(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`syswrite(ThreadContext context, IRubyObject str)`
`RubyIO`	`to_io()`
`<T> T`	`toJava(java.lang.Class<T> target)` Convert the object to the specified Java class, if possible.
`java.lang.String`	`toString()` The default toString method is just a wrapper that calls the Ruby "to_s" method.
`static IRubyObject`	`tryConvert(ThreadContext context, IRubyObject recv, IRubyObject arg)`
`RubyBoolean`	`tty_p(ThreadContext context)`
`IRubyObject`	`ungetbyte(ThreadContext context, IRubyObject b)`
`IRubyObject`	`ungetc(ThreadContext context, IRubyObject c)`
`protected IOOptions`	`updateIOOptionsFromOptions(ThreadContext context, RubyHash options, IOOptions ioOptions)` See http://ruby-doc.org/core-1.9.3/IO.html#method-c-new for the format of modes in options
`IRubyObject`	`write_nonblock(ThreadContext context, IRubyObject[] argv)`
`IRubyObject`	`write(ThreadContext context, IRubyObject str)` io_write_m
`IRubyObject`	`write(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`write(ThreadContext context, IRubyObject str, boolean nosync)`
`protected static IRubyObject`	`write(ThreadContext context, IRubyObject maybeIO, ByteList byteList)`
`protected static IRubyObject`	`write(ThreadContext context, IRubyObject maybeIO, ByteList byteList, IRubyObject sep)`
`static IRubyObject`	`write(ThreadContext context, IRubyObject maybeIO, IRubyObject str)`
`static IRubyObject`	`write(ThreadContext context, IRubyObject recv, IRubyObject[] argv)`
`static IRubyObject`	`write(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1)`
`static IRubyObject`	`writeStatic(ThreadContext context, IRubyObject recv, IRubyObject[] argv, Block unusedBlock)` Deprecated.

Methods inherited from class org.jruby.RubyObject
attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, eqlInternal, equalInternal, equals, hashCode, inspect, op_eqq, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject
addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject
array

Field Detail
- PARAGRAPH_SEPARATOR
```
public static final ByteList PARAGRAPH_SEPARATOR
```
- CLOSED_STREAM_MSG
```
public static final java.lang.String CLOSED_STREAM_MSG
```
  See Also:
  
  Constant Field Values
- FD_CLOEXEC
```
public static final int FD_CLOEXEC
```
  See Also:
  
  Constant Field Values
- openFile
```
protected OpenFile openFile
```
- popenSpecial
```
protected boolean popenSpecial
```
  If the stream is being used for popen, we don't want to destroy the process when we close the stream.

Constructor Detail

RubyIO

public RubyIO(Ruby runtime,
              RubyClass type)

RubyIO

public RubyIO(Ruby runtime,
              java.io.OutputStream outputStream)

RubyIO

public RubyIO(Ruby runtime,
              java.io.OutputStream outputStream,
              boolean autoclose)

RubyIO

public RubyIO(Ruby runtime,
              java.io.InputStream inputStream)

RubyIO

public RubyIO(Ruby runtime,
              java.nio.channels.Channel channel)

RubyIO

public RubyIO(Ruby runtime,
              RubyClass klass,
              java.nio.channels.Channel channel)

RubyIO

public RubyIO(Ruby runtime,
              ShellLauncher.POpenProcess process,
              IOOptions ioOptions)

RubyIO

@Deprecated
public RubyIO(Ruby runtime,
                          STDIO stdio)

Deprecated.

RubyIO

@Deprecated
public RubyIO(Ruby runtime,
                          RubyClass cls,
                          ShellLauncher.POpenProcess process,
                          RubyHash options,
                          IOOptions ioOptions)

Deprecated.

Method Detail

prepStdio

public static RubyIO prepStdio(Ruby runtime,
                               java.io.InputStream f,
                               java.nio.channels.Channel c,
                               int fmode,
                               RubyClass klass,
                               java.lang.String path)

prepStdio

public static RubyIO prepStdio(Ruby runtime,
                               java.io.OutputStream f,
                               java.nio.channels.Channel c,
                               int fmode,
                               RubyClass klass,
                               java.lang.String path)

newIO

public static RubyIO newIO(Ruby runtime,
                           java.nio.channels.Channel channel)

getOpenFile
```
public OpenFile getOpenFile()
```

getOpenFileChecked
```
public OpenFile getOpenFileChecked()
```

getOpenFileInitialized

public OpenFile getOpenFileInitialized()

getNativeClassIndex
```
public ClassIndex getNativeClassIndex()
```
Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

ClassIndex

createIOClass

public static RubyClass createIOClass(Ruby runtime)

getOutStream

public java.io.OutputStream getOutStream()

getInStream

public java.io.InputStream getInStream()

getChannel
```
public java.nio.channels.Channel getChannel()
```
Get the underlying channel from this IO object. Note that IO buffers data internally, so the channel returned here may have been read into those buffers. If the channel and the IO are both being used at the same time, the stream will get out of sync.

Returns:

the underlying channel for this IO

reopenIO

protected RubyIO reopenIO(ThreadContext context,
                          RubyIO nfile)

reopen

public IRubyObject reopen(ThreadContext context,
                          IRubyObject[] args)

getline

public IRubyObject getline(ThreadContext context,
                           IRubyObject separator)

getline

public IRubyObject getline(ThreadContext context,
                           IRubyObject separator,
                           long limit)

getline using logic of gets. If limit is -1 then read unlimited amount.

getEnc
```
public org.jcodings.Encoding getEnc()
```
Specified by:

getEnc in interface IOEncodable

getReadEncoding

public org.jcodings.Encoding getReadEncoding()

getEnc2
```
public org.jcodings.Encoding getEnc2()
```
Specified by:

getEnc2 in interface IOEncodable

getInputEncoding

public org.jcodings.Encoding getInputEncoding()

newInstance

public static IRubyObject newInstance(ThreadContext context,
                                      IRubyObject recv,
                                      IRubyObject[] args,
                                      Block block)

for_fd

public static IRubyObject for_fd(ThreadContext context,
                                 IRubyObject recv,
                                 IRubyObject[] args,
                                 Block block)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject fileNumber,
                              Block unused)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject fileNumber,
                              IRubyObject second,
                              Block unused)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject fileNumber,
                              IRubyObject modeValue,
                              IRubyObject options,
                              Block unused)

parseIOOptions

protected IOOptions parseIOOptions(IRubyObject arg)

external_encoding

public IRubyObject external_encoding(ThreadContext context)

internal_encoding

public IRubyObject internal_encoding(ThreadContext context)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
                                IRubyObject encodingObj)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
                                IRubyObject encodingString,
                                IRubyObject internalEncoding)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
                                IRubyObject encodingString,
                                IRubyObject internalEncoding,
                                IRubyObject options)

setEncoding

public void setEncoding(ThreadContext context,
                        IRubyObject v1,
                        IRubyObject v2,
                        IRubyObject opt)

open

public static IRubyObject open(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject[] args,
                               Block block)

ensureYieldClose

public static IRubyObject ensureYieldClose(ThreadContext context,
                                           IRubyObject port,
                                           Block block)

sysopen

@Deprecated
public static IRubyObject sysopen(IRubyObject recv,
                                              IRubyObject[] args,
                                              Block block)

Deprecated.

sysopen19

@Deprecated
public static IRubyObject sysopen19(ThreadContext context,
                                                IRubyObject recv,
                                                IRubyObject[] argv,
                                                Block block)

Deprecated.

sysopen

public static IRubyObject sysopen(ThreadContext context,
                                  IRubyObject recv,
                                  IRubyObject[] argv,
                                  Block block)

sysopen

protected static ChannelFD sysopen(Ruby runtime,
                                   java.lang.String fname,
                                   int oflags,
                                   int perm)

cloexecOpen

public static ChannelFD cloexecOpen(Ruby runtime,
                                    RubyIO.Sysopen data)

isAutoclose
```
public boolean isAutoclose()
```

setAutoclose

public void setAutoclose(boolean autoclose)

autoclose

public IRubyObject autoclose(ThreadContext context)

autoclose_set

public IRubyObject autoclose_set(ThreadContext context,
                                 IRubyObject autoclose)

binmode
```
public IRubyObject binmode()
```

op_binmode

public IRubyObject op_binmode(ThreadContext context)

syswrite

public IRubyObject syswrite(ThreadContext context,
                            IRubyObject str)

write_nonblock

public IRubyObject write_nonblock(ThreadContext context,
                                  IRubyObject[] argv)

GetWriteIO
```
public RubyIO GetWriteIO()
```

write

public IRubyObject write(ThreadContext context,
                         IRubyObject str)

io_write_m

write

public IRubyObject write(ThreadContext context,
                         IRubyObject[] args)

write

public IRubyObject write(ThreadContext context,
                         IRubyObject str,
                         boolean nosync)

op_append

public IRubyObject op_append(ThreadContext context,
                             IRubyObject anObject)

rb_io_addstr

fileno

public RubyFixnum fileno(ThreadContext context)

lineno
```
public RubyFixnum lineno(ThreadContext context)
```
Returns the current line number.

Returns:

the current line number.

lineno_set

public RubyFixnum lineno_set(ThreadContext context,
                             IRubyObject newLineNumber)

Sets the current line number.

Parameters:: newLineNumber - The new line number.

sync
```
public RubyBoolean sync(ThreadContext context)
```
Returns the current sync mode. MRI: rb_io_sync

Returns:

the current sync mode.

pid
```
public IRubyObject pid(ThreadContext context)
```
Return the process id (pid) of the process this IO object spawned. If no process exists (popen was not called), then nil is returned. This is not how it appears to be defined but ruby 1.8 works this way.

Returns:

the pid or nil

pos

public RubyFixnum pos(ThreadContext context)

pos_set

public RubyFixnum pos_set(ThreadContext context,
                          IRubyObject offset)

print

public IRubyObject print(ThreadContext context,
                         IRubyObject[] args)

Print some objects to the stream.

print

public static IRubyObject print(ThreadContext context,
                                IRubyObject out,
                                IRubyObject[] args)

Print some objects to the stream. MRI: rb_io_print

printf

public IRubyObject printf(ThreadContext context,
                          IRubyObject[] args)

putc

public IRubyObject putc(ThreadContext context,
                        IRubyObject ch)

putc

public static IRubyObject putc(ThreadContext context,
                               IRubyObject maybeIO,
                               IRubyObject object)

seek

public RubyFixnum seek(ThreadContext context,
                       IRubyObject[] args)

seek

public RubyFixnum seek(ThreadContext context,
                       IRubyObject off)

seek

public RubyFixnum seek(ThreadContext context,
                       IRubyObject off,
                       IRubyObject whence)

sysseek

public RubyFixnum sysseek(ThreadContext context,
                          IRubyObject[] args)

rewind

public RubyFixnum rewind(ThreadContext context)

fsync

public RubyFixnum fsync(ThreadContext context)

sync_set
```
public IRubyObject sync_set(IRubyObject sync)
```
Sets the current sync mode. MRI: rb_io_set_sync

Parameters:

sync - The new sync mode.

setSync
```
public void setSync(boolean sync)
```

getSync
```
public boolean getSync()
```

eof_p

public RubyBoolean eof_p(ThreadContext context)

tty_p

public RubyBoolean tty_p(ThreadContext context)

initialize_copy
```
public IRubyObject initialize_copy(IRubyObject _io)
```
Description copied from class: RubyBasicObject

rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Overrides:

initialize_copy in class RubyBasicObject

closed_p

public RubyBoolean closed_p(ThreadContext context)

isClosed
```
public boolean isClosed()
```
Is this IO closed MRI: rb_io_closed

Returns:

true if closed

close
```
public IRubyObject close(ThreadContext context)
```
Closes all open resources for the IO. It also removes it from our magical all open file descriptor pool.

Returns:

The IO. Returns nil if the IO was already closed. MRI: rb_io_close_m

close
```
public final void close()
```
Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

ioClose

protected static IRubyObject ioClose(ThreadContext context,
                                     IRubyObject io)

rbIoClose

protected IRubyObject rbIoClose(ThreadContext context)

close_write

public IRubyObject close_write(ThreadContext context)

close_read

public IRubyObject close_read(ThreadContext context)

close_on_exec_set

public IRubyObject close_on_exec_set(ThreadContext context,
                                     IRubyObject arg)

close_on_exec_p

public IRubyObject close_on_exec_p(ThreadContext context)

flush
```
public RubyIO flush(ThreadContext context)
```
Flushes the IO output stream. MRI: rb_io_flush

Returns:

The IO.

flush
```
public void flush()
```
Specified by:

flush in interface java.io.Flushable

flushRaw

protected RubyIO flushRaw(ThreadContext context,
                          boolean sync)

gets

public IRubyObject gets(ThreadContext context)

Read a line.

gets

public IRubyObject gets(ThreadContext context,
                        IRubyObject arg)

gets

public IRubyObject gets(ThreadContext context,
                        IRubyObject rs,
                        IRubyObject limit_arg)

gets

public IRubyObject gets(ThreadContext context,
                        IRubyObject rs,
                        IRubyObject limit_arg,
                        IRubyObject opt)

getBlocking
```
public boolean getBlocking()
```

setBlocking

public void setBlocking(boolean blocking)

fcntl

public IRubyObject fcntl(ThreadContext context,
                         IRubyObject cmd)

fcntl

public IRubyObject fcntl(ThreadContext context,
                         IRubyObject cmd,
                         IRubyObject arg)

ioctl

public IRubyObject ioctl(ThreadContext context,
                         IRubyObject[] args)

puts

public IRubyObject puts(ThreadContext context)

puts

public IRubyObject puts(ThreadContext context,
                        IRubyObject arg0)

puts

public IRubyObject puts(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1)

puts

public IRubyObject puts(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        IRubyObject arg2)

puts

public IRubyObject puts(ThreadContext context,
                        IRubyObject[] args)

puts0

public static IRubyObject puts0(ThreadContext context,
                                IRubyObject maybeIO)

puts1

public static IRubyObject puts1(ThreadContext context,
                                IRubyObject maybeIO,
                                IRubyObject arg0)

puts2

public static IRubyObject puts2(ThreadContext context,
                                IRubyObject maybeIO,
                                IRubyObject arg0,
                                IRubyObject arg1)

puts3

public static IRubyObject puts3(ThreadContext context,
                                IRubyObject maybeIO,
                                IRubyObject arg0,
                                IRubyObject arg1,
                                IRubyObject arg2)

puts

public static IRubyObject puts(ThreadContext context,
                               IRubyObject maybeIO,
                               IRubyObject... args)

write

protected static IRubyObject write(ThreadContext context,
                                   IRubyObject maybeIO,
                                   ByteList byteList)

write

protected static IRubyObject write(ThreadContext context,
                                   IRubyObject maybeIO,
                                   ByteList byteList,
                                   IRubyObject sep)

write

public static IRubyObject write(ThreadContext context,
                                IRubyObject maybeIO,
                                IRubyObject str)

write

public static IRubyObject write(ThreadContext context,
                                IRubyObject maybeIO,
                                IRubyObject arg0,
                                IRubyObject arg1)

inspect
```
public IRubyObject inspect()
```
Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

readline

public IRubyObject readline(ThreadContext context)

Read a line.

readline

public IRubyObject readline(ThreadContext context,
                            IRubyObject separator)

getc
```
@Deprecated
public IRubyObject getc()
```
Deprecated.

readchar

public IRubyObject readchar(ThreadContext context)

Read a char. On EOF throw EOFError.

getbyte

public IRubyObject getbyte(ThreadContext context)

Read a byte. On EOF returns nil.

getByte

public int getByte(ThreadContext context)

readbyte

public IRubyObject readbyte(ThreadContext context)

getc

public IRubyObject getc(ThreadContext context)

getc19

@Deprecated
public final IRubyObject getc19(ThreadContext context)

Deprecated.

ungetbyte

public IRubyObject ungetbyte(ThreadContext context,
                             IRubyObject b)

ungetc

public IRubyObject ungetc(ThreadContext context,
                          IRubyObject c)

read_nonblock

public IRubyObject read_nonblock(ThreadContext context,
                                 IRubyObject[] args)

doReadNonblock

public IRubyObject doReadNonblock(ThreadContext context,
                                  IRubyObject[] args,
                                  boolean exception)

readpartial

public IRubyObject readpartial(ThreadContext context,
                               IRubyObject[] args)

sysread

public IRubyObject sysread(ThreadContext context,
                           IRubyObject[] args)

read

public IRubyObject read(IRubyObject[] args)

read

public IRubyObject read(ThreadContext context)

read

public IRubyObject read(ThreadContext context,
                        IRubyObject arg0)

read

public IRubyObject read(ThreadContext context,
                        IRubyObject length,
                        IRubyObject str)

readchar

@Deprecated
public IRubyObject readchar()

Deprecated.

stat

public IRubyObject stat(ThreadContext context)

each_byteInternal

public IRubyObject each_byteInternal(ThreadContext context,
                                     Block block)

Invoke a block for each byte.

MRI: rb_io_each_byte

each_byte

public IRubyObject each_byte(ThreadContext context,
                             Block block)

bytes

public IRubyObject bytes(ThreadContext context,
                         Block block)

each_charInternal

public IRubyObject each_charInternal(ThreadContext context,
                                     Block block)

each_char

public IRubyObject each_char(ThreadContext context,
                             Block block)

chars

public IRubyObject chars(ThreadContext context,
                         Block block)

codepoints

public IRubyObject codepoints(ThreadContext context,
                              Block block)

each_codepoint

public IRubyObject each_codepoint(ThreadContext context,
                                  Block block)

each

public IRubyObject each(ThreadContext context,
                        Block block)

each

public IRubyObject each(ThreadContext context,
                        IRubyObject arg0,
                        Block block)

each

public IRubyObject each(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        Block block)

each

public IRubyObject each(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        Block block)

each

public IRubyObject each(ThreadContext context,
                        IRubyObject[] args,
                        Block block)

each_line

public IRubyObject each_line(ThreadContext context,
                             Block block)

each_line

public IRubyObject each_line(ThreadContext context,
                             IRubyObject arg0,
                             Block block)

each_line

public IRubyObject each_line(ThreadContext context,
                             IRubyObject arg0,
                             IRubyObject arg1,
                             Block block)

each_line

public IRubyObject each_line(ThreadContext context,
                             IRubyObject arg0,
                             IRubyObject arg1,
                             IRubyObject arg2,
                             Block block)

each_line

public IRubyObject each_line(ThreadContext context,
                             IRubyObject[] args,
                             Block block)

lines

public IRubyObject lines(ThreadContext context,
                         Block block)

readlines

public RubyArray readlines(ThreadContext context)

readlines

public RubyArray readlines(ThreadContext context,
                           IRubyObject arg0)

readlines

public RubyArray readlines(ThreadContext context,
                           IRubyObject arg0,
                           IRubyObject arg1)

readlines

public RubyArray readlines(ThreadContext context,
                           IRubyObject arg0,
                           IRubyObject arg1,
                           IRubyObject arg2)

readlines

public RubyArray readlines(ThreadContext context,
                           IRubyObject[] args)

to_io
```
public RubyIO to_io()
```

toString
```
public java.lang.String toString()
```
Description copied from class: RubyObject

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class RubyObject

foreach

public static IRubyObject foreach(ThreadContext context,
                                  IRubyObject recv,
                                  IRubyObject[] args,
                                  Block block)

convertToIO

public static RubyIO convertToIO(ThreadContext context,
                                 IRubyObject obj)

select

public static IRubyObject select(ThreadContext context,
                                 IRubyObject recv,
                                 IRubyObject[] argv)

advise

public IRubyObject advise(ThreadContext context,
                          IRubyObject[] argv)

failIfDirectory

public static void failIfDirectory(Ruby runtime,
                                   RubyString pathStr)

ioOpen

public static IRubyObject ioOpen(ThreadContext context,
                                 IRubyObject recv,
                                 IRubyObject filename,
                                 IRubyObject vmode,
                                 IRubyObject vperm,
                                 IRubyObject opt)

binread
```
public static IRubyObject binread(ThreadContext context,
                                  IRubyObject recv,
                                  IRubyObject[] args)
```
binread is just like read, except it doesn't take options and it forces mode to be "rb:ASCII-8BIT"

Parameters:

context - the current ThreadContext

recv - the target of the call (IO or a subclass)

args - arguments; path [, length [, offset]]

Returns:

the binary contents of the given file, at specified length and offset

read

public static IRubyObject read(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject[] args,
                               Block unusedBlock)

read

public static IRubyObject read(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject[] args)

binwrite

public static IRubyObject binwrite(ThreadContext context,
                                   IRubyObject recv,
                                   IRubyObject[] args)

write

public static IRubyObject write(ThreadContext context,
                                IRubyObject recv,
                                IRubyObject[] argv)

ioStaticWrite

public static IRubyObject ioStaticWrite(ThreadContext context,
                                        IRubyObject recv,
                                        IRubyObject[] argv,
                                        boolean binary)

readlines19

@Deprecated
public static IRubyObject readlines19(ThreadContext context,
                                                  IRubyObject recv,
                                                  IRubyObject[] args,
                                                  Block unusedBlock)

Deprecated.

readlines

public static IRubyObject readlines(ThreadContext context,
                                    IRubyObject recv,
                                    IRubyObject[] args,
                                    Block unusedBlock)

popen

public static IRubyObject popen(ThreadContext context,
                                IRubyObject recv,
                                IRubyObject[] args,
                                Block block)

pipe19

@Deprecated
public static IRubyObject pipe19(ThreadContext context,
                                             IRubyObject recv)

Deprecated.

pipe19

@Deprecated
public static IRubyObject pipe19(ThreadContext context,
                                             IRubyObject recv,
                                             IRubyObject modes)

Deprecated.

pipe19

@Deprecated
public static IRubyObject pipe19(ThreadContext context,
                                             IRubyObject klass,
                                             IRubyObject[] argv,
                                             Block block)

Deprecated.

pipe

public static IRubyObject pipe(ThreadContext context,
                               IRubyObject recv)

pipe

public static IRubyObject pipe(ThreadContext context,
                               IRubyObject klass,
                               IRubyObject[] argv,
                               Block block)

ensureYieldClosePipes

public static IRubyObject ensureYieldClosePipes(ThreadContext context,
                                                IRubyObject obj,
                                                RubyIO r,
                                                RubyIO w,
                                                Block block)

copy_stream

public static IRubyObject copy_stream(ThreadContext context,
                                      IRubyObject recv,
                                      IRubyObject[] args)

tryConvert

public static IRubyObject tryConvert(ThreadContext context,
                                     IRubyObject recv,
                                     IRubyObject arg)

pread

public IRubyObject pread(ThreadContext context,
                         IRubyObject len,
                         IRubyObject offset)

pread

public IRubyObject pread(ThreadContext context,
                         IRubyObject len,
                         IRubyObject offset,
                         IRubyObject str)

pwrite

public IRubyObject pwrite(ThreadContext context,
                          IRubyObject str,
                          IRubyObject offset)

addBlockingThread
```
public void addBlockingThread(RubyThread thread)
```
Add a thread to the list of blocking threads for this IO.

Parameters:

thread - A thread blocking on this IO

removeBlockingThread
```
public void removeBlockingThread(RubyThread thread)
```
Remove a thread from the list of blocking threads for this IO.

Parameters:

thread - A thread blocking on this IO

updateIOOptionsFromOptions

protected IOOptions updateIOOptionsFromOptions(ThreadContext context,
                                               RubyHash options,
                                               IOOptions ioOptions)

See http://ruby-doc.org/core-1.9.3/IO.html#method-c-new for the format of modes in options

checkExecOptions

@Deprecated
public static void checkExecOptions(IRubyObject options)

Deprecated.

checkSpawnOptions

@Deprecated
public static void checkSpawnOptions(IRubyObject options)

Deprecated.

checkPopenOptions

@Deprecated
public static void checkPopenOptions(IRubyObject options)

Deprecated.

obliterateProcess
```
public static void obliterateProcess(java.lang.Process process)
```
Try for around 1s to destroy the child process. This is to work around issues on some JVMs where if you try to destroy the process too quickly it may not be ready and may ignore the destroy. A subsequent waitFor will then hang. This version tries to destroy and call exitValue repeatedly for up to 1000 calls with 1ms delay between iterations, with the intent that the target process ought to be "ready to die" fairly quickly and we don't get stuck in a blocking waitFor call.

Parameters:

process - The process to obliterate

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
                                     long mode)

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
                                     int mode)

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
                                     java.lang.String mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
                                     ModeFlags modeFlags)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
                                     long mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
                                     int mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
                                     java.lang.String mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
                                     IOOptions oldFlags,
                                     int orOflags)

readline

@Deprecated
public IRubyObject readline(ThreadContext context,
                                        IRubyObject[] args)

Deprecated.

setEnc2

public void setEnc2(org.jcodings.Encoding enc2)

Specified by:: setEnc2 in interface IOEncodable

setEnc

public void setEnc(org.jcodings.Encoding enc)

Specified by:: setEnc in interface IOEncodable

setEcflags
```
public void setEcflags(int ecflags)
```
Specified by:

setEcflags in interface IOEncodable

getEcflags
```
public int getEcflags()
```
Specified by:

getEcflags in interface IOEncodable

setEcopts
```
public void setEcopts(IRubyObject ecopts)
```
Specified by:

setEcopts in interface IOEncodable

getEcopts
```
public IRubyObject getEcopts()
```
Specified by:

getEcopts in interface IOEncodable

setBOM
```
public void setBOM(boolean bom)
```
Specified by:

setBOM in interface IOEncodable

getBOM
```
public boolean getBOM()
```
Specified by:

getBOM in interface IOEncodable

toJava
```
public <T> T toJava(java.lang.Class<T> target)
```
Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyBasicObject

Parameters:

target - The target type to which the object should be converted.

See Also:

IRubyObject.toJava(java.lang.Class<T>)

setAscii8bitBinmode

protected RubyIO setAscii8bitBinmode()

MakeOpenFile
```
public final OpenFile MakeOpenFile()
```

getline

@Deprecated
public IRubyObject getline(Ruby runtime,
                                       ByteList separator)

Deprecated.

getline

@Deprecated
public IRubyObject getline(Ruby runtime,
                                       ByteList separator,
                                       long limit)

Deprecated.

getline

@Deprecated
public IRubyObject getline(ThreadContext context,
                                       ByteList separator)

Deprecated.

getline

@Deprecated
public IRubyObject getline(ThreadContext context,
                                       ByteList separator,
                                       long limit)

Deprecated.

lines19

@Deprecated
public IRubyObject lines19(ThreadContext context,
                                       Block block)

Deprecated.

each_char19

@Deprecated
public IRubyObject each_char19(ThreadContext context,
                                           Block block)

Deprecated.

chars19

@Deprecated
public IRubyObject chars19(ThreadContext context,
                                       Block block)

Deprecated.

readlines19

@Deprecated
public RubyArray readlines19(ThreadContext context,
                                         IRubyObject[] args)

Deprecated.

getIOModes

@Deprecated
public static ModeFlags getIOModes(Ruby runtime,
                                               java.lang.String modesString)

Deprecated.

getIOModesIntFromString

@Deprecated
public static int getIOModesIntFromString(Ruby runtime,
                                                      java.lang.String modesString)

Deprecated.

writeStatic

@Deprecated
public static IRubyObject writeStatic(ThreadContext context,
                                                  IRubyObject recv,
                                                  IRubyObject[] argv,
                                                  Block unusedBlock)

Deprecated.

popen3

@Deprecated
public static IRubyObject popen3(ThreadContext context,
                                             IRubyObject recv,
                                             IRubyObject[] args,
                                             Block block)

Deprecated.

popen4

@Deprecated
public static IRubyObject popen4(ThreadContext context,
                                             IRubyObject recv,
                                             IRubyObject[] args,
                                             Block block)

Deprecated.

popenSpecial

@Deprecated
public static org.jruby.RubyIO.POpenTuple popenSpecial(ThreadContext context,
                                                                   IRubyObject[] args)

Deprecated.

doWriteNonblock

@Deprecated
public IRubyObject doWriteNonblock(ThreadContext context,
                                               IRubyObject[] argv,
                                               boolean useException)

Deprecated.

select_static

@Deprecated
public static IRubyObject select_static(ThreadContext context,
                                                    Ruby runtime,
                                                    IRubyObject[] args)

Deprecated.

checkExecEnv

@Deprecated
public static RubyArray checkExecEnv(ThreadContext context,
                                                 RubyHash hash)

Deprecated.

ioOpen

@Deprecated
public static IRubyObject ioOpen(ThreadContext context,
                                             IRubyObject filename,
                                             IRubyObject vmode,
                                             IRubyObject vperm,
                                             IRubyObject opt)

Deprecated.

read19

@Deprecated
public static IRubyObject read19(ThreadContext context,
                                             IRubyObject recv,
                                             IRubyObject[] args,
                                             Block unusedBlock)

Deprecated.

Class RubyIO

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable

Field Summary

Fields inherited from class org.jruby.RubyObject

Fields inherited from class org.jruby.RubyBasicObject

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

Constructor Summary

Method Summary

Methods inherited from class org.jruby.RubyObject

Methods inherited from class org.jruby.RubyBasicObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

Field Detail

PARAGRAPH_SEPARATOR

CLOSED_STREAM_MSG

FD_CLOEXEC

openFile

popenSpecial

Constructor Detail

RubyIO

RubyIO

RubyIO

RubyIO

RubyIO

RubyIO

RubyIO

RubyIO

RubyIO

Method Detail

prepStdio

prepStdio

newIO

getOpenFile

getOpenFileChecked

getOpenFileInitialized

getNativeClassIndex

createIOClass

getOutStream

getInStream

getChannel

reopenIO

reopen

getline

getline

getEnc

getReadEncoding

getEnc2

getInputEncoding

newInstance

for_fd

initialize

initialize

initialize

parseIOOptions

external_encoding

internal_encoding

set_encoding

set_encoding

set_encoding

setEncoding

open

ensureYieldClose

sysopen

sysopen19

sysopen

sysopen

cloexecOpen

isAutoclose

setAutoclose

autoclose

autoclose_set

binmode

op_binmode

syswrite

write_nonblock

GetWriteIO

write