Package org.jruby.ext.stringio

Class StringIO

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.stringio.StringIO

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, EncodingCapable, CoreObjectType, DataType

public class StringIO
extends RubyObject
implements EncodingCapable, DataType

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringIO.GenericReadable
static class	StringIO.GenericWritable
(package private) static class	StringIO.StringIOData

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

RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CHAR_BIT
private static final Getline.Callback<StringIO,IRubyObject>	GETLINE
private static final Getline.Callback<StringIO,RubyArray>	GETLINE_ARY
private static final Getline.Callback<StringIO,StringIO>	GETLINE_YIELD
static final ByteList	NEWLINE
(package private) StringIO.StringIOData	ptr
private static final int	STRIO_READABLE
private static final int	STRIO_READWRITE
private static final int	STRIO_WRITABLE

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

Modifier	Constructor	Description
protected	StringIO(Ruby runtime, RubyClass klass)

Method Summary

Modifier and Type	Method	Description
IRubyObject	binmode(ThreadContext context)
private static void	bm_init_skip(int[] skip, byte[] pat, int patPtr, int m)
private static int	bm_search(byte[] little, int lstart, int llen, byte[] big, int bstart, int blen, int[] skip)
IRubyObject	chars(ThreadContext context, Block block)
private void	checkFinalized()
void	checkFrozen()	The actual method that checks frozen with the default frozen message from MRI.
private void	checkInitialized()
private void	checkModifiable()
private void	checkOpen()
private void	checkReadable()
private void	checkWritable()
private static int	chompNewlineWidth(byte[] bytes, int s, int e)
IRubyObject	close(ThreadContext context)
IRubyObject	close_read(ThreadContext context)
IRubyObject	close_write(ThreadContext context)
private boolean	closed()
IRubyObject	closed_p()
IRubyObject	closed_read_p()
IRubyObject	closed_write_p()
IRubyObject	codepoints(ThreadContext context, Block block)
static RubyClass	createStringIOClass(Ruby runtime)
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)
IRubyObject	each_byte(ThreadContext context, Block block)
IRubyObject	each_char(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	eof(ThreadContext context)
IRubyObject	external_encoding(ThreadContext context)
IRubyObject	getbyte(ThreadContext context)
IRubyObject	getc(ThreadContext context)
org.jcodings.Encoding	getEncoding()
private IRubyObject	getline(ThreadContext context, IRubyObject rs, int limit, boolean chomp)
IRubyObject	gets(ThreadContext context)
IRubyObject	gets(ThreadContext context, IRubyObject arg0)
IRubyObject	gets(ThreadContext context, IRubyObject[] args)
IRubyObject	gets(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	gets(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject other)
IRubyObject	internal_encoding(ThreadContext context)
private boolean	isEndOfString()
IRubyObject	length()
IRubyObject	lineno(ThreadContext context)
IRubyObject	lines(ThreadContext context, IRubyObject[] args, Block block)
static IRubyObject	newInstance(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
IRubyObject	pos(ThreadContext context)
IRubyObject	putc(ThreadContext context, IRubyObject ch)
IRubyObject	puts(ThreadContext context, IRubyObject[] args)
IRubyObject	read(ThreadContext context, IRubyObject[] args)
private boolean	readable()
IRubyObject	readlines(ThreadContext context)
IRubyObject	readlines(ThreadContext context, IRubyObject arg0)
IRubyObject	readlines(ThreadContext context, IRubyObject[] args)
IRubyObject	readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	reopen(ThreadContext context, IRubyObject[] args)
IRubyObject	rewind(ThreadContext context)
IRubyObject	seek(ThreadContext context, IRubyObject[] args)
IRubyObject	set_encoding(ThreadContext context, IRubyObject ext_enc)
IRubyObject	set_encoding(ThreadContext context, IRubyObject enc, IRubyObject ignored)
IRubyObject	set_encoding(ThreadContext context, IRubyObject enc, IRubyObject ignored1, IRubyObject ignored2)
IRubyObject	set_lineno(ThreadContext context, IRubyObject arg)
IRubyObject	set_pos(IRubyObject arg)
IRubyObject	set_string(IRubyObject arg)
void	setEncoding(org.jcodings.Encoding enc)
IRubyObject	string(ThreadContext context)
private long	stringIOWrite(ThreadContext context, Ruby runtime, IRubyObject arg)
IRubyObject	strio_self()
IRubyObject	strio_unimpl(ThreadContext context, IRubyObject[] args)
private void	strioExtend(int pos, int len)
IRubyObject	strioFalse(ThreadContext context)
IRubyObject	strioFirst(IRubyObject arg)
private void	strioInit(ThreadContext context, IRubyObject[] args)
IRubyObject	strioNil(ThreadContext context)
private RubyString	strioSubstr(Ruby runtime, int pos, int len, org.jcodings.Encoding enc)
IRubyObject	strioZero(ThreadContext context)
IRubyObject	sync(ThreadContext context)
IRubyObject	sysread(IRubyObject[] args)
IRubyObject	truncate(IRubyObject len)
IRubyObject	ungetbyte(ThreadContext context, IRubyObject arg)
private void	ungetbyteCommon(byte[] ungetBytes, int ungetBegin, int ungetLen)
private void	ungetbyteCommon(int c)
private void	ungetbyteCommon(RubyString ungetBytes)
IRubyObject	ungetc(ThreadContext context, IRubyObject arg)
private boolean	writable()
IRubyObject	write(ThreadContext context, IRubyObject arg)
IRubyObject	write(ThreadContext context, IRubyObject[] args)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql, eql_p, 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, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize19, inspect, 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, method_missing, method_missing19, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, 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, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, type_deprecated, 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

Field Details

ptr

StringIO.StringIOData ptr

STRIO_READABLE

private static final int STRIO_READABLE

STRIO_WRITABLE

private static final int STRIO_WRITABLE

STRIO_READWRITE

private static final int STRIO_READWRITE

CHAR_BIT

private static final int CHAR_BIT

See Also:

• Constant Field Values

GETLINE

private static final Getline.Callback<StringIO,IRubyObject> GETLINE

GETLINE_YIELD

private static final Getline.Callback<StringIO,StringIO> GETLINE_YIELD

GETLINE_ARY

private static final Getline.Callback<StringIO,RubyArray> GETLINE_ARY

NEWLINE

public static final ByteList NEWLINE

Constructor Details

StringIO

protected StringIO(Ruby runtime,
 RubyClass klass)

Method Details

createStringIOClass

public static RubyClass createStringIOClass(Ruby runtime)

getEncoding

public org.jcodings.Encoding getEncoding()

Specified by:

getEncoding in interface EncodingCapable

setEncoding

public void setEncoding(org.jcodings.Encoding enc)

Specified by:

setEncoding in interface EncodingCapable

newInstance

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

open

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

initialize

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

strioInit

private void strioInit(ThreadContext context,
 IRubyObject[] args)

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject other)

binmode

public IRubyObject binmode(ThreadContext context)

strio_self

public IRubyObject strio_self()

strio_unimpl

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

strioZero

public IRubyObject strioZero(ThreadContext context)

strioFirst

public IRubyObject strioFirst(IRubyObject arg)

strioFalse

public IRubyObject strioFalse(ThreadContext context)

strioNil

public IRubyObject strioNil(ThreadContext context)

close

public IRubyObject close(ThreadContext context)

closed_p

public IRubyObject closed_p()

close_read

public IRubyObject close_read(ThreadContext context)

closed_read_p

public IRubyObject closed_read_p()

close_write

public IRubyObject close_write(ThreadContext context)

closed_write_p

public IRubyObject closed_write_p()

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,
 IRubyObject[] args,
 Block block)

each_byte

public IRubyObject each_byte(ThreadContext context,
 Block block)

each_char

public IRubyObject each_char(ThreadContext context,
 Block block)

chars

public IRubyObject chars(ThreadContext context,
 Block block)

eof

public IRubyObject eof(ThreadContext context)

isEndOfString

private boolean isEndOfString()

getc

public IRubyObject getc(ThreadContext context)

getbyte

public IRubyObject getbyte(ThreadContext context)

strioSubstr

private RubyString strioSubstr(Ruby runtime,
 int pos,
 int len,
 org.jcodings.Encoding enc)

bm_init_skip

private static void bm_init_skip(int[] skip,
 byte[] pat,
 int patPtr,
 int m)

bm_search

private static int bm_search(byte[] little,
 int lstart,
 int llen,
 byte[] big,
 int bstart,
 int blen,
 int[] skip)

gets

public IRubyObject gets(ThreadContext context)

gets

public IRubyObject gets(ThreadContext context,
 IRubyObject arg0)

gets

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

gets

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

gets

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

getline

private IRubyObject getline(ThreadContext context,
 IRubyObject rs,
 int limit,
 boolean chomp)

chompNewlineWidth

private static int chompNewlineWidth(byte[] bytes,
 int s,
 int e)

length

public IRubyObject length()

lineno

public IRubyObject lineno(ThreadContext context)

set_lineno

public IRubyObject set_lineno(ThreadContext context,
 IRubyObject arg)

pos

public IRubyObject pos(ThreadContext context)

set_pos

public IRubyObject set_pos(IRubyObject arg)

strioExtend

private void strioExtend(int pos,
 int len)

putc

public IRubyObject putc(ThreadContext context,
 IRubyObject ch)

read

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

readlines

public IRubyObject readlines(ThreadContext context)

readlines

public IRubyObject readlines(ThreadContext context,
 IRubyObject arg0)

readlines

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

readlines

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

readlines

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

reopen

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

rewind

public IRubyObject rewind(ThreadContext context)

seek

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

set_string

public IRubyObject set_string(IRubyObject arg)

string

public IRubyObject string(ThreadContext context)

sync

public IRubyObject sync(ThreadContext context)

sysread

public IRubyObject sysread(IRubyObject[] args)

truncate

public IRubyObject truncate(IRubyObject len)

ungetc

public IRubyObject ungetc(ThreadContext context,
 IRubyObject arg)

ungetbyteCommon

private void ungetbyteCommon(int c)

ungetbyteCommon

private void ungetbyteCommon(RubyString ungetBytes)

ungetbyteCommon

private void ungetbyteCommon(byte[] ungetBytes,
 int ungetBegin,
 int ungetLen)

ungetbyte

public IRubyObject ungetbyte(ThreadContext context,
 IRubyObject arg)

write

public IRubyObject write(ThreadContext context,
 IRubyObject arg)

write

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

stringIOWrite

private long stringIOWrite(ThreadContext context,
 Ruby runtime,
 IRubyObject arg)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject ext_enc)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject enc,
 IRubyObject ignored)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject enc,
 IRubyObject ignored1,
 IRubyObject ignored2)

external_encoding

public IRubyObject external_encoding(ThreadContext context)

internal_encoding

public IRubyObject internal_encoding(ThreadContext context)

each_codepoint

public IRubyObject each_codepoint(ThreadContext context,
 Block block)

codepoints

public IRubyObject codepoints(ThreadContext context,
 Block block)

puts

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

checkFrozen

public void checkFrozen()

Description copied from class: RubyBasicObject

The actual method that checks frozen with the default frozen message from MRI. If possible, call this instead of RubyBasicObject.testFrozen(java.lang.String).

Overrides:

checkFrozen in class RubyBasicObject

readable

private boolean readable()

writable

private boolean writable()

closed

private boolean closed()

checkReadable

private void checkReadable()

checkWritable

private void checkWritable()

checkModifiable

private void checkModifiable()

checkInitialized

private void checkInitialized()

checkFinalized

private void checkFinalized()

checkOpen

private void checkOpen()