Module org.jruby.base

Package org.jruby

Class RubyString

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyString

All Implemented Interfaces:

Serializable, CharSequence, Cloneable, Comparable<IRubyObject>, Appendable, InstanceVariables, InternalVariables, IRubyObject, EncodingCapable, MarshalEncoding, CoreObjectType, SimpleHash, ByteListHolder, CodeRangeable

Direct Known Subclasses:

RubyString.FString

public class RubyString
extends RubyObject
implements CharSequence, EncodingCapable, MarshalEncoding, CodeRangeable, Appendable, SimpleHash

Implementation of Ruby String class Concurrency: no synchronization is required among readers, but all users must synchronize externally with writers.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RubyString.EmptyByteListHolder	Encoding aware String construction routines for 1.9
static class	RubyString.FString	An FString is a frozen string that is also deduplicated and cached.

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
protected byte	flags
static RubyString[]	NULL_ARRAY
protected byte	shareLevel

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, ERR_INSECURE_SET_INST_VAR, FALSE_F, FROZEN_F, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, VAR_TABLE_OFFSET, varTable, varTableStamp

Constructor Summary

Constructors

Modifier	Constructor	Description
	RubyString(Ruby runtime, RubyClass rubyClass)	Deprecated, for removal: This API element is subject to removal in a future version.
	RubyString(Ruby runtime, RubyClass rubyClass, byte[] value)	Deprecated, for removal: This API element is subject to removal in a future version.
	RubyString(Ruby runtime, RubyClass rubyClass, CharSequence value)	Deprecated, for removal: This API element is subject to removal in a future version.
	RubyString(Ruby runtime, RubyClass rubyClass, CharSequence value, org.jcodings.Encoding enc)	Deprecated, for removal: This API element is subject to removal in a future version.
	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value)	Deprecated, for removal: This API element is subject to removal in a future version.
	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, boolean objectSpace)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, int cr)
protected	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, int cr, boolean objectspace)
protected	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, org.jcodings.Encoding enc)
	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, org.jcodings.Encoding encoding, boolean objectSpace)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	RubyString(Ruby runtime, RubyClass rubyClass, ByteList value, org.jcodings.Encoding enc, int cr)

Method Summary

Modifier and Type	Method	Description
RubyString	append(RubyString other)
RubyString	append(IRubyObject other)
RubyString	append(IRubyObject other, Function<IRubyObject,RubyString> convert)	rb_str_append
IRubyObject	append_as_bytes(ThreadContext context)
IRubyObject	append_as_bytes(ThreadContext context, IRubyObject arg0)
IRubyObject	append_as_bytes(ThreadContext context, IRubyObject[] args)
RubyString	append19(IRubyObject other)	Deprecated.
RubyString	appendAsDynamicString(IRubyObject other)
RubyString	appendAsStringOrAny(IRubyObject other)
void	appendIntoString(RubyString target)
IRubyObject	ascii_only_p(ThreadContext context)
String	asJavaString()	rb_to_id
void	associateEncoding(org.jcodings.Encoding enc)
RubyString	asString()	rb_obj_as_string First converts this object into a String using the "to_s" method and returns it.
static boolean	atCharBoundary(byte[] bytes, int s, int p, int e, org.jcodings.Encoding enc)
IRubyObject	b(ThreadContext context)
IRubyObject	byteindex(ThreadContext context, IRubyObject arg0)
IRubyObject	byteindex(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
static String	byteListToString(ByteList bytes)
IRubyObject	byterindex(ThreadContext context, IRubyObject arg0)
IRubyObject	byterindex(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	bytes(ThreadContext context, Block block)
RubyFixnum	bytesize()	Deprecated.
RubyFixnum	bytesize(ThreadContext context)
IRubyObject	byteslice(ThreadContext context, IRubyObject arg)
IRubyObject	byteslice(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
IRubyObject	bytesplice(ThreadContext context, IRubyObject[] args)
IRubyObject	bytesplice(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	bytesplice(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
static String	bytesToString(byte[] bytes)
static String	bytesToString(byte[] bytes, int beg, int len)
int	capacity()	Determine how much space exists after the begin offset in this string's buffer.
RubyString	capitalize(ThreadContext context)	rb_str_capitalize / rb_str_capitalize_bang
RubyString	capitalize(ThreadContext context, IRubyObject arg)
RubyString	capitalize(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	capitalize_bang(ThreadContext context)
IRubyObject	capitalize_bang(ThreadContext context, IRubyObject arg)
IRubyObject	capitalize_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	casecmp(ThreadContext context, IRubyObject other)
IRubyObject	casecmp_p(ThreadContext context, IRubyObject other)
final RubyString	cat(byte ch)
final RubyString	cat(byte[] str)
final RubyString	cat(byte[] str, int beg, int len)
final int	cat(byte[] bytes, int p, int len, org.jcodings.Encoding enc)
final RubyString	cat(int ch)
final RubyString	cat(int code, org.jcodings.Encoding enc)
final RubyString	cat(RubyString str)
final RubyString	cat(ByteList str)
final RubyString	cat(ByteList other, int codeRange)
final RubyString	cat19(RubyString str2)	Deprecated.
final int	cat19(ByteList other, int codeRange)	Deprecated.
final RubyString	catAscii(byte[] bytes, int ptr, int ptrLen)
final RubyString	catString(String str)
final RubyString	catStringUnsafe(String str)	Append a Java String to this RubyString assuming it will be the encoding of the RubyString.
final RubyString	catWithCodeRange(RubyString str2)
final int	catWithCodeRange(ByteList other, int codeRange)
IRubyObject	center(IRubyObject arg0)	Deprecated.
IRubyObject	center(IRubyObject arg0, IRubyObject arg1)	Deprecated.
IRubyObject	center(ThreadContext context, IRubyObject arg0)	rb_str_center
IRubyObject	center(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
char	charAt(int offset)
IRubyObject	chars(ThreadContext context, Block block)
static org.jcodings.Encoding	checkEncoding(Ruby runtime, ByteList str1, ByteList str2)
final org.jcodings.Encoding	checkEncoding(RubyString other)
final org.jcodings.Encoding	checkEncoding(CodeRangeable other)
void	checkFrozen()	The actual method that checks frozen with the default frozen message from MRI.
IRubyObject	checkStringType()	rb_check_string_type Tries to return a coerced string representation of this object, using "to_str".
RubyString	chill()
RubyString	chill_symbol_string()
RubyString	chomp(ThreadContext context)	rb_str_chomp_bang In the common case, removes CR and LF characters in various ways depending on the value of the optional args[0].
RubyString	chomp(ThreadContext context, IRubyObject arg0)
IRubyObject	chomp_bang(ThreadContext context)
IRubyObject	chomp_bang(ThreadContext context, IRubyObject arg0)
IRubyObject	chomp_bang19(ThreadContext context)	Deprecated.
IRubyObject	chomp_bang19(ThreadContext context, IRubyObject arg0)	Deprecated.
RubyString	chomp19(ThreadContext context)	Deprecated.
RubyString	chomp19(ThreadContext context, IRubyObject arg0)	Deprecated.
IRubyObject	chop(ThreadContext context)	rb_str_chop / rb_str_chop_bang
IRubyObject	chop_bang(ThreadContext context)
IRubyObject	chr(ThreadContext context)
RubyString	clear()	Deprecated.
RubyString	clear(ThreadContext context)
final void	clearCodeRange()
IRubyObject	codepoints(ThreadContext context, Block block)
final int	compareTo(IRubyObject other)	Compares this Ruby object with another.
RubyString	concat(IRubyObject other)
RubyString	concat(ThreadContext context, IRubyObject obj)	rb_str_concat
RubyString	concat(ThreadContext context, IRubyObject[] objs)	rb_str_concat_multi
RubyString	concatSingle(ThreadContext context, IRubyObject other)	rb_str_concat
RubyString	convertToString()	Tries to convert this object to a Ruby String using the "to_str" method.
IRubyObject	count(ThreadContext context)
IRubyObject	count(ThreadContext context, IRubyObject arg)
IRubyObject	count(ThreadContext context, IRubyObject[] args)
static RubyClass	createStringClass(ThreadContext context, RubyClass Object, RubyModule Comparable)
RubyString	crypt(ThreadContext context, IRubyObject other)	rb_str_crypt
String	decodeString()	Convert this Ruby string to a Java String.
IRubyObject	delete(ThreadContext context)	rb_str_delete / rb_str_delete_bang
IRubyObject	delete(ThreadContext context, IRubyObject arg)
IRubyObject	delete(ThreadContext context, IRubyObject[] args)
IRubyObject	delete_bang(ThreadContext context)
IRubyObject	delete_bang(ThreadContext context, IRubyObject arg)
IRubyObject	delete_bang(ThreadContext context, IRubyObject[] args)
IRubyObject	delete_prefix(ThreadContext context, IRubyObject prefix)
IRubyObject	delete_prefix_bang(ThreadContext context, IRubyObject prefix)
IRubyObject	delete_suffix(ThreadContext context, IRubyObject suffix)
IRubyObject	delete_suffix_bang(ThreadContext context, IRubyObject suffix)
IRubyObject	doClone()
RubyString	downcase(ThreadContext context)	rb_str_downcase / rb_str_downcase_bang
RubyString	downcase(ThreadContext context, IRubyObject arg)
RubyString	downcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	downcase_bang(ThreadContext context)
IRubyObject	downcase_bang(ThreadContext context, IRubyObject arg)
IRubyObject	downcase_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	dump()	Deprecated.
IRubyObject	dump(ThreadContext context)	rb_str_dump
IRubyObject	dup()	Overridden dup for fast-path logic.
IRubyObject	dup(ThreadContext context)	RubyMethod dup.
final RubyString	dupAsChilled(Ruby runtime, RubyClass clazz, String file, int line)
RubyString.FString	dupAsFString(Ruby runtime)
IRubyObject	dupFrozen()
IRubyObject	each_byte(ThreadContext context, Block block)	rb_str_each_byte
IRubyObject	each_char(ThreadContext context, Block block)
IRubyObject	each_codepoint(ThreadContext context, Block block)	rb_str_each_codepoint
IRubyObject	each_grapheme_cluster(ThreadContext context, Block block)
IRubyObject	each_line(ThreadContext context, Block block)	rb_str_each_line
IRubyObject	each_line(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	each_line(ThreadContext context, IRubyObject arg, IRubyObject opts, Block block)
void	empty()
RubyBoolean	empty_p(ThreadContext context)	rb_str_empty
IRubyObject	encode(ThreadContext context)
IRubyObject	encode(ThreadContext context, IRubyObject arg)
IRubyObject	encode(ThreadContext context, IRubyObject toEncoding, IRubyObject arg)
IRubyObject	encode(ThreadContext context, IRubyObject toEncoding, IRubyObject forcedEncoding, IRubyObject opts)
IRubyObject	encode_bang(ThreadContext context)
IRubyObject	encode_bang(ThreadContext context, IRubyObject arg0)
IRubyObject	encode_bang(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	encode_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	encode_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
static ByteList	encodeBytelist(CharSequence value, org.jcodings.Encoding encoding)
IRubyObject	encoding(ThreadContext context)
IRubyObject	encStrScrub(ThreadContext context, org.jcodings.Encoding enc, IRubyObject repl, int cr, Block block)
IRubyObject	encStrScrub(ThreadContext context, org.jcodings.Encoding enc, IRubyObject repl, Block block)
IRubyObject	end_with_p(ThreadContext context)
IRubyObject	end_with_p(ThreadContext context, IRubyObject arg)
IRubyObject	end_with_p(ThreadContext context, IRubyObject[] args)
boolean	endsWithAsciiChar(char c)
protected boolean	endWith(IRubyObject tmp)
void	ensureAvailable(ThreadContext context, int extraLength)	Ensure the backing store belongs to this string and has enough space to add extraLength bytes.
final void	ensureInstanceVariablesSettable()	Makes sure that instance variables can be set on this object, including information about whether this object is frozen.
final boolean	eql(IRubyObject other)	short circuit for String key comparison
boolean	equals(Object other)	This override does not do a "checked" dispatch.
RubyString	export(ThreadContext context)
IRubyObject	force_encoding(ThreadContext context, IRubyObject enc)
IRubyObject	freeze(ThreadContext context)
protected void	frozenCheck()
IRubyObject	getbyte(ThreadContext context, IRubyObject index)
ByteList	getByteList()	Get the ByteList which backs this Ruby String
byte[]	getBytes()
final int	getCodeRange()
static RubyString.EmptyByteListHolder	getEmptyByteList(org.jcodings.Encoding enc)
org.jcodings.Encoding	getEncoding()
Class	getJavaClass()	Will return the Java interface that most closely can represent this object, when working through Java integration translations.
org.jcodings.Encoding	getMarshalEncoding()
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
String	getUnicodeValue()	used by ar-jdbc
CharSequence	getValue()
IRubyObject	grapheme_clusters(ThreadContext context, Block block)
IRubyObject	gsub(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	gsub(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	gsub_bang(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	gsub_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
RubyString	gsubFast(ThreadContext context, RubyRegexp regexp, RubyString repl, Block block)
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
boolean	hasNul()	Does this string contain \0 anywhere (per byte search).
IRubyObject	hex(ThreadContext context)	rb_str_hex
RubyBoolean	include_p(ThreadContext context, IRubyObject obj)	rb_str_include
static IRubyObject	includeRange(ThreadContext context, RubyString _beg, RubyString _end, IRubyObject _val, boolean exclusive)
final boolean	independent()
IRubyObject	index(ThreadContext context, IRubyObject arg0)	rb_str_index_m
IRubyObject	index(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject opts)
RubyString	initialize_copy(IRubyObject other)	Deprecated.
RubyString	initialize_copy(ThreadContext context, IRubyObject other)	Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	insert(ThreadContext context, IRubyObject indexArg, IRubyObject arg)
RubyString	inspect()	Deprecated.
static RubyString	inspect(Ruby runtime, ByteList byteList)	Deprecated.
IRubyObject	inspect(ThreadContext context)	rb_str_inspect
static RubyString	inspect(ThreadContext context, ByteList byteList)
RubySymbol	intern()	Deprecated.
RubySymbol	intern(ThreadContext context)
final boolean	isAsciiOnly()
boolean	isBare(Ruby runtime)	Deprecated.
boolean	isBare(ThreadContext context)	Is this a "bare" string, i.e.
final boolean	isBrokenString()
protected boolean	isChilled()
protected boolean	isChilledLiteral()
final boolean	isCodeRangeAsciiOnly()
final boolean	isCodeRangeBroken()
final boolean	isCodeRangeValid()
boolean	isEmpty()
final void	keepCodeRange()
int	length()
IRubyObject	lines(ThreadContext context, Block block)
IRubyObject	lines(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	lines(ThreadContext context, IRubyObject arg, IRubyObject opts, Block block)
IRubyObject	ljust(IRubyObject arg0)	Deprecated.
IRubyObject	ljust(IRubyObject arg0, IRubyObject arg1)	Deprecated.
IRubyObject	ljust(ThreadContext context, IRubyObject arg0)	rb_str_ljust
IRubyObject	ljust(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
long	longHashCode()
IRubyObject	lstrip(ThreadContext context)	rb_str_lstrip / rb_str_lstrip_bang
IRubyObject	lstrip_bang(ThreadContext context)
final RubyString	makeIndependent()
final RubyString	makeIndependent(int length)
final RubyString	makeShared(Ruby runtime, int index, int len)
final RubyString	makeShared(Ruby runtime, RubyClass meta, int index, int len)
final RubyString	makeSharedString(Ruby runtime, int index, int len)
IRubyObject	match(ThreadContext context, IRubyObject pattern)	Deprecated.
IRubyObject	match(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	match(ThreadContext context, IRubyObject pattern, Block block)
IRubyObject	match(ThreadContext context, IRubyObject pattern, IRubyObject pos, Block block)
IRubyObject	match_p(ThreadContext context, IRubyObject pattern)
IRubyObject	match_p(ThreadContext context, IRubyObject pattern, IRubyObject pos)
IRubyObject	match19(ThreadContext context, IRubyObject pattern)	Deprecated.
IRubyObject	match19(ThreadContext context, IRubyObject[] args, Block block)	Deprecated.
IRubyObject	match19(ThreadContext context, IRubyObject pattern, IRubyObject pos, Block block)	Deprecated.
final IRubyObject	minus_at(ThreadContext context)
final void	modify()
final void	modify(int length)	rb_str_modify (with length bytes ensured)
final void	modify19()	Deprecated.
final void	modifyAndClearCodeRange()
void	modifyAndKeepCodeRange()
final void	modifyCheck()	Check that the string can be modified, raising error otherwise.
void	modifyCheck(byte[] b, int len)
final void	modifyExpand(int length)	rb_str_modify_expand
protected void	mutateChilledString()
static RubyString	newAllocatedString(Ruby runtime, RubyClass metaClass)
static RubyString	newBinaryString(Ruby runtime, String str)
static RubyString	newBinaryString(Ruby runtime, ByteList str)
static RubyString	newChilledString(Ruby runtime, ByteList bytes, int coderange, String file, int line)
static RubyString	newDebugChilledString(Ruby runtime, RubyClass rubyClass, ByteList value, int cr, String file, int line)
static RubyString	newDebugFrozenString(Ruby runtime, RubyClass rubyClass, ByteList value, int cr, String file, int line)
static RubyString	newEmptyBinaryString(Ruby runtime)
static RubyString	newEmptyString(Ruby runtime)
static RubyString	newEmptyString(Ruby runtime, org.jcodings.Encoding enc)
static RubyString	newEmptyString(Ruby runtime, RubyClass metaClass)
static RubyString	newEmptyString(Ruby runtime, RubyClass metaClass, org.jcodings.Encoding enc)
RubyString	newFrozen()
static RubyString	newFString(Ruby runtime, String content)	Create anew or deduplicate a RubyString based on the given Java String content.
static RubyString	newInstance(IRubyObject recv, IRubyObject[] args, Block block)	rb_str_s_new
static RubyString	newInternalFromJavaExternal(Ruby runtime, String str)	Return a new Ruby String encoded as the default internal encoding given a Java String that has come from an external source.
static RubyString	newString(Ruby runtime, byte[] bytes)
static RubyString	newString(Ruby runtime, byte[] bytes, int start, int length)
static RubyString	newString(Ruby runtime, byte[] bytes, int start, int length, org.jcodings.Encoding encoding)
static RubyString	newString(Ruby runtime, CharSequence str)
static RubyString	newString(Ruby runtime, CharSequence str, org.jcodings.Encoding encoding)
static RubyString	newString(Ruby runtime, String str)
static RubyString	newString(Ruby runtime, String str, org.jcodings.Encoding encoding)
static RubyString	newString(Ruby runtime, ByteList bytes)
static RubyString	newString(Ruby runtime, ByteList bytes, int coderange)
static RubyString	newString(Ruby runtime, ByteList bytes, org.jcodings.Encoding encoding)
static RubyString	newStringLight(Ruby runtime, int size)
static RubyString	newStringLight(Ruby runtime, int size, org.jcodings.Encoding encoding)
static RubyString	newStringLight(Ruby runtime, ByteList bytes)
static RubyString	newStringNoCopy(Ruby runtime, byte[] bytes)
static RubyString	newStringNoCopy(Ruby runtime, byte[] bytes, int start, int length)
static RubyString	newStringNoCopy(Ruby runtime, byte[] bytes, int start, int length, org.jcodings.Encoding encoding)
static RubyString	newStringNoCopy(Ruby runtime, RubyClass clazz, ByteList bytes)
static RubyString	newStringNoCopy(Ruby runtime, RubyClass clazz, ByteList bytes, org.jcodings.Encoding enc, int cr)
static RubyString	newStringNoCopy(Ruby runtime, ByteList bytes)
static RubyString	newStringNoCopy(Ruby runtime, ByteList bytes, org.jcodings.Encoding enc, int cr)
static RubyString	newStringShared(Ruby runtime, byte[] bytes)	Deprecated.
static RubyString	newStringShared(Ruby runtime, byte[] bytes, int start, int length)	Deprecated.
static RubyString	newStringShared(Ruby runtime, byte[] bytes, int start, int length, org.jcodings.Encoding encoding)
static RubyString	newStringShared(Ruby runtime, byte[] bytes, org.jcodings.Encoding encoding)	Deprecated.
static RubyString	newStringShared(Ruby runtime, RubyClass clazz, ByteList bytes)
static RubyString	newStringShared(Ruby runtime, RubyClass clazz, ByteList bytes, org.jcodings.Encoding encoding)
static RubyString	newStringShared(Ruby runtime, RubyString orig)
static RubyString	newStringShared(Ruby runtime, ByteList bytes)
static RubyString	newStringShared(Ruby runtime, ByteList bytes, int codeRange)
static RubyString	newStringShared(Ruby runtime, ByteList bytes, org.jcodings.Encoding encoding)
static RubyString	newUnicodeString(Ruby runtime, CharSequence str)
static RubyString	newUnicodeString(Ruby runtime, String str)
static RubyString	newUSASCIIString(Ruby runtime, String str)
static RubyString	newUsAsciiStringNoCopy(Ruby runtime, ByteList bytes)
static RubyString	newUsAsciiStringShared(Ruby runtime, byte[] bytes, int start, int length)
static RubyString	newUsAsciiStringShared(Ruby runtime, ByteList bytes)
static RubyString	newUTF16String(Ruby runtime, CharSequence str)
static RubyString	newUTF16String(Ruby runtime, String str)
static RubyString	newUTF8String(Ruby runtime, CharSequence str)
static RubyString	newUTF8String(Ruby runtime, String str)
static RubyString	objAsString(ThreadContext context, IRubyObject obj)	rb_obj_as_string
IRubyObject	oct(ThreadContext context)	rb_str_oct
IRubyObject	op_aref(ThreadContext context, IRubyObject arg)	rb_str_aref, rb_str_aref_m
IRubyObject	op_aref(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
IRubyObject	op_aset(ThreadContext context, IRubyObject arg0, IRubyObject arg1)	rb_str_aset, rb_str_aset_m
IRubyObject	op_aset(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
final int	op_cmp(RubyString other)	rb_str_cmp
IRubyObject	op_cmp(ThreadContext context, IRubyObject other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_str_equal
RubyString	op_format(ThreadContext context, IRubyObject arg)
IRubyObject	op_ge(ThreadContext context, IRubyObject other)
IRubyObject	op_ge19(ThreadContext context, IRubyObject other)	Deprecated.
IRubyObject	op_gt(ThreadContext context, IRubyObject other)
IRubyObject	op_gt19(ThreadContext context, IRubyObject other)	Deprecated.
IRubyObject	op_le(ThreadContext context, IRubyObject other)
IRubyObject	op_le19(ThreadContext context, IRubyObject other)	Deprecated.
IRubyObject	op_lt(ThreadContext context, IRubyObject other)
IRubyObject	op_lt19(ThreadContext context, IRubyObject other)	Deprecated.
IRubyObject	op_match(ThreadContext context, IRubyObject other)	rb_str_match
IRubyObject	op_mul(ThreadContext context, IRubyObject other)
IRubyObject	op_mul19(ThreadContext context, IRubyObject other)	Deprecated.
IRubyObject	op_plus(ThreadContext context, IRubyObject arg)
IRubyObject	op_plus19(ThreadContext context, IRubyObject arg)	Deprecated.
IRubyObject	ord(ThreadContext context)
IRubyObject	partition(ThreadContext context, Block block)
IRubyObject	partition(ThreadContext context, IRubyObject arg, Block block)
final IRubyObject	plus_at()	Deprecated.
final IRubyObject	plus_at(ThreadContext context)
final RubyString	prepend(byte ch)
final RubyString	prepend(int ch)
IRubyObject	prepend(ThreadContext context, IRubyObject other)	rb_str_prepend
IRubyObject	prepend(ThreadContext context, IRubyObject[] objs)	rb_str_prepend
static IRubyObject	rbStrEscape(ThreadContext context, RubyString str)
int	rbStrOffset(int pos)
IRubyObject	replace(IRubyObject other)	Deprecated.
RubyString	replace(ThreadContext context, IRubyObject other)	rb_str_replace_m
RubyString	replace19(IRubyObject other)	Deprecated.
final void	resize(int size)	rb_str_resize
IRubyObject	reverse(ThreadContext context)
RubyString	reverse_bang(ThreadContext context)
RubyString	reverse_bang19(ThreadContext context)	Deprecated.
IRubyObject	reverse19(ThreadContext context)	Deprecated.
IRubyObject	rindex(ThreadContext context, IRubyObject arg0)	rb_str_rindex_m
IRubyObject	rindex(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	rjust(IRubyObject arg0)	Deprecated.
IRubyObject	rjust(IRubyObject arg0, IRubyObject arg1)	Deprecated.
IRubyObject	rjust(ThreadContext context, IRubyObject arg0)	rb_str_rjust
IRubyObject	rjust(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	rpartition(ThreadContext context, IRubyObject arg)
IRubyObject	rstrip(ThreadContext context)	rb_str_rstrip / rb_str_rstrip_bang
IRubyObject	rstrip_bang(ThreadContext context)
RubyFixnum	rubyLength(ThreadContext context)
IRubyObject	scan(ThreadContext context, IRubyObject pat, Block block)	rb_str_scan
final int	scanForCodeRange()
static int	scanForCodeRange(ByteList bytes)
IRubyObject	scrub(ThreadContext context, Block block)
IRubyObject	scrub(ThreadContext context, IRubyObject repl, Block block)
IRubyObject	scrub_bang(ThreadContext context, Block block)
IRubyObject	scrub_bang(ThreadContext context, IRubyObject repl, Block block)
IRubyObject	setbyte(ThreadContext context, IRubyObject index, IRubyObject val)
final void	setByteListShared()
final void	setCodeRange(int codeRange)
void	setEncoding(org.jcodings.Encoding encoding)
final void	setEncodingAndCodeRange(org.jcodings.Encoding enc, int cr)
void	setReadLength(int length)
void	setValue(CharSequence value)	Deprecated.
void	setValue(ByteList value)
boolean	shouldMarshalEncoding()
RubyClass	singletonClass(ThreadContext context)	Will either return the existing singleton class for this object, or create a new one and return that.
int	size()
IRubyObject	slice_bang(ThreadContext context, IRubyObject arg0)	rb_str_slice_bang
IRubyObject	slice_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
RubyArray	split(RubyRegexp delimiter)	Deprecated.
RubyArray	split(RubyRegexp delimiter, int limit)	Deprecated.
RubyArray	split(RubyString delimiter)	Deprecated.
RubyArray	split(RubyString delimiter, int limit)	Deprecated.
RubyArray	split(ThreadContext context)
RubyArray	split(ThreadContext context, RubyRegexp delimiter, int limit)	Split for ext (Java) callers (does not write $~).
RubyArray	split(ThreadContext context, RubyString delimiter, int limit)	Split for ext (Java) callers (does not write $~).
RubyArray	split(ThreadContext context, IRubyObject arg0)
RubyArray	split(ThreadContext context, IRubyObject pattern, IRubyObject limit)
IRubyObject	splitWithBlock(ThreadContext context, Block block)	rb_str_split_m
IRubyObject	splitWithBlock(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	splitWithBlock(ThreadContext context, IRubyObject pattern, IRubyObject limit, Block block)
IRubyObject	squeeze(ThreadContext context)	rb_str_squeeze / rb_str_squeeze_bang
IRubyObject	squeeze(ThreadContext context, IRubyObject arg)
IRubyObject	squeeze(ThreadContext context, IRubyObject[] args)
IRubyObject	squeeze_bang(ThreadContext context)
IRubyObject	squeeze_bang(ThreadContext context, IRubyObject arg)
IRubyObject	squeeze_bang(ThreadContext context, IRubyObject[] args)
IRubyObject	start_with_p(ThreadContext context)
IRubyObject	start_with_p(ThreadContext context, IRubyObject arg)
IRubyObject	start_with_p(ThreadContext context, IRubyObject[] args)
boolean	startsWith(RubyString str)
IRubyObject	str_eql_p(ThreadContext context, IRubyObject other)
IRubyObject	str_eql_p19(ThreadContext context, IRubyObject other)	Deprecated.
final RubyString	strDup()	Deprecated.
final RubyString	strDup(Ruby runtime)
final RubyString	strDup(Ruby runtime, RubyClass clazz)
int	strHashCode(Ruby runtime)	Generate a hash for the String, using its associated Ruby instance's hash seed.
static byte[]	stringToBytes(String string)
final IRubyObject	stringToInum(int base)
IRubyObject	stringToInum(int base, boolean badcheck)	rb_str_to_inum
static RubyString	stringValue(IRubyObject object)
IRubyObject	strip(ThreadContext context)	rb_str_strip / rb_str_strip_bang
IRubyObject	strip_bang(ThreadContext context)
final int	strLength()
IRubyObject	strScrub(ThreadContext context, IRubyObject repl, Block block)	Scrub the contents of this string, replacing invalid characters as appropriate.
IRubyObject	sub(ThreadContext context, IRubyObject arg0, Block block)	rb_str_sub / rb_str_sub_bang
IRubyObject	sub(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	sub_bang(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	sub_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
final IRubyObject	subBangFast(ThreadContext context, RubyRegexp regexp, RubyString repl)	sub! but without any frame globals ...
CharSequence	subSequence(int start, int end)
final IRubyObject	substr(int beg, int len)	Deprecated.
final IRubyObject	substr(Ruby runtime, int beg, int len)	Deprecated.
final IRubyObject	substr(ThreadContext context, int beg, int len)
final IRubyObject	substr19(Ruby runtime, int beg, int len)	Deprecated.
final IRubyObject	substrEnc(Ruby runtime, int beg, int len)	Deprecated.
final IRubyObject	substrEnc(ThreadContext context, int beg, int len)
IRubyObject	succ(ThreadContext context)
IRubyObject	succ_bang()	Deprecated.
IRubyObject	succ_bang(ThreadContext context)
IRubyObject	sum(ThreadContext context)
IRubyObject	sum(ThreadContext context, IRubyObject arg)
IRubyObject	sumCommon(ThreadContext context, long bits)
RubyString	swapcase(ThreadContext context)	rb_str_swapcase / rb_str_swapcase_bang
RubyString	swapcase(ThreadContext context, IRubyObject arg)
RubyString	swapcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	swapcase_bang(ThreadContext context)
IRubyObject	swapcase_bang(ThreadContext context, IRubyObject arg)
IRubyObject	swapcase_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	to_c(ThreadContext context)	string_to_c
IRubyObject	to_f()	Deprecated.
IRubyObject	to_f(ThreadContext context)
IRubyObject	to_i()	Deprecated.
IRubyObject	to_i(IRubyObject arg0)	Deprecated.
IRubyObject	to_i(ThreadContext context)
IRubyObject	to_i(ThreadContext context, IRubyObject arg0)	rb_str_to_i
IRubyObject	to_r(ThreadContext context)	string_to_r
RubyString	to_s(ThreadContext context)
final org.jcodings.Encoding	toEncoding(Ruby runtime)	Deprecated.
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
String	toString()	The default toString method is just a wrapper that calls the Ruby "to_s" method.
IRubyObject	tr(ThreadContext context, IRubyObject src, IRubyObject repl)	rb_str_tr / rb_str_tr_bang
IRubyObject	tr_bang(ThreadContext context, IRubyObject src, IRubyObject repl)
IRubyObject	tr_s(ThreadContext context, IRubyObject src, IRubyObject repl)	rb_str_tr_s / rb_str_tr_s_bang
IRubyObject	tr_s_bang(ThreadContext context, IRubyObject src, IRubyObject repl)
IRubyObject	tr_s_bang19(ThreadContext context, IRubyObject src, IRubyObject repl)	Deprecated.
IRubyObject	tr_s19(ThreadContext context, IRubyObject src, IRubyObject repl)	Deprecated.
static IRubyObject	try_convert(ThreadContext context, IRubyObject recv, IRubyObject str)
IRubyObject	undump(ThreadContext context)
static RubyString	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyString	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)
RubyArray	unpack(IRubyObject obj)	Deprecated.
RubyArray	unpack(ThreadContext context, IRubyObject obj, Block block)
RubyArray	unpack(ThreadContext context, IRubyObject obj, IRubyObject opt, Block block)
IRubyObject	unpack1(ThreadContext context, IRubyObject obj, Block block)
IRubyObject	unpack1(ThreadContext context, IRubyObject obj, IRubyObject opt, Block block)
int	unseededStrHashCode(Ruby runtime)	Generate a hash for the String, without a seed.
RubyString	upcase(ThreadContext context)	rb_str_upcase / rb_str_upcase_bang
RubyString	upcase(ThreadContext context, IRubyObject arg)
RubyString	upcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	upcase_bang(ThreadContext context)
IRubyObject	upcase_bang(ThreadContext context, IRubyObject arg)
IRubyObject	upcase_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
final IRubyObject	upto(ThreadContext context, IRubyObject end, Block block)	rb_str_upto_m
final IRubyObject	upto(ThreadContext context, IRubyObject end, IRubyObject excl, Block block)
IRubyObject	valid_encoding_p(ThreadContext context)
void	verifyAsciiCompatible()
final void	view(ByteList bytes)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, dig, dig1, dig2, eqlInternal, equalInternal, finishObjectClass, inspect, op_eqq, puts, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

__id__, addFinalizer, addFinalizer, anyToString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, checkArrayType, checkCallMethod, checkCallMethod, cloneSetup, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataWrapStruct, decode, display, dupFinalizer, dupSetup, eql_p, eql_p, equal_p, evalUnder, extend, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableList, getVariableNameList, hash, hashyInspect, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setTaint, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, type, untaint, validateInstanceVariable, variableTableContains, 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 java.lang.CharSequence

chars, codePoints

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

checkStringType19, marshalLiveVariables

Field Details

NULL_ARRAY

public static RubyString[] NULL_ARRAY

shareLevel

protected volatile byte shareLevel

flags

protected byte flags

Constructor Details

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 CharSequence value)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 CharSequence value,
 org.jcodings.Encoding enc)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 byte[] value)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 boolean objectSpace)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

@Deprecated(since="10.1.0.0",
            forRemoval=true)
public RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 org.jcodings.Encoding encoding,
 boolean objectSpace)

Deprecated, for removal: This API element is subject to removal in a future version.

RubyString

protected RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 org.jcodings.Encoding enc,
 int cr)

RubyString

protected RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 org.jcodings.Encoding enc)

RubyString

protected RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 int cr)

RubyString

protected RubyString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 int cr,
 boolean objectspace)

Method Details

createStringClass

public static RubyClass createStringClass(ThreadContext context,
 RubyClass Object,
 RubyModule Comparable)

getEncoding

public org.jcodings.Encoding getEncoding()

Specified by:

getEncoding in interface EncodingCapable

setEncoding

public void setEncoding(org.jcodings.Encoding encoding)

Specified by:

setEncoding in interface EncodingCapable

shouldMarshalEncoding

public boolean shouldMarshalEncoding()

Specified by:

shouldMarshalEncoding in interface MarshalEncoding

getMarshalEncoding

public org.jcodings.Encoding getMarshalEncoding()

Specified by:

getMarshalEncoding in interface MarshalEncoding

associateEncoding

public void associateEncoding(org.jcodings.Encoding enc)

setEncodingAndCodeRange

public final void setEncodingAndCodeRange(org.jcodings.Encoding enc,
 int cr)

toEncoding

@Deprecated(since="10.0.0.0")
public final org.jcodings.Encoding toEncoding(Ruby runtime)

Deprecated.

getCodeRange

public final int getCodeRange()

Specified by:

getCodeRange in interface CodeRangeable

setCodeRange

public final void setCodeRange(int codeRange)

Specified by:

setCodeRange in interface CodeRangeable

clearCodeRange

public final void clearCodeRange()

Specified by:

clearCodeRange in interface CodeRangeable

keepCodeRange

public final void keepCodeRange()

Specified by:

keepCodeRange in interface CodeRangeable

isCodeRangeAsciiOnly

public final boolean isCodeRangeAsciiOnly()

isAsciiOnly

public final boolean isAsciiOnly()

isCodeRangeValid

public final boolean isCodeRangeValid()

Specified by:

isCodeRangeValid in interface CodeRangeable

isCodeRangeBroken

public final boolean isCodeRangeBroken()

isBrokenString

public final boolean isBrokenString()

scanForCodeRange

public final int scanForCodeRange()

Specified by:

scanForCodeRange in interface CodeRangeable

scanForCodeRange

public static int scanForCodeRange(ByteList bytes)

checkEncoding

public final org.jcodings.Encoding checkEncoding(RubyString other)

checkEncoding

public final org.jcodings.Encoding checkEncoding(CodeRangeable other)

Specified by:

checkEncoding in interface CodeRangeable

checkEncoding

public static org.jcodings.Encoding checkEncoding(Ruby runtime,
 ByteList str1,
 ByteList str2)

strLength

public final int strLength()

eql

public final boolean eql(IRubyObject other)

short circuit for String key comparison

Specified by:

eql in interface IRubyObject

Overrides:

eql in class RubyBasicObject

Returns:

Will by default just call the Ruby method "eql?"

hasNul

public boolean hasNul()

Does this string contain \0 anywhere (per byte search).

Returns:

true if it does

verifyAsciiCompatible

public void verifyAsciiCompatible()

newStringLight

public static RubyString newStringLight(Ruby runtime,
 ByteList bytes)

newStringLight

public static RubyString newStringLight(Ruby runtime,
 int size)

newStringLight

public static RubyString newStringLight(Ruby runtime,
 int size,
 org.jcodings.Encoding encoding)

newString

public static RubyString newString(Ruby runtime,
 CharSequence str)

newString

public static RubyString newString(Ruby runtime,
 CharSequence str,
 org.jcodings.Encoding encoding)

newString

public static RubyString newString(Ruby runtime,
 String str)

newString

public static RubyString newString(Ruby runtime,
 String str,
 org.jcodings.Encoding encoding)

newBinaryString

public static RubyString newBinaryString(Ruby runtime,
 String str)

newBinaryString

public static RubyString newBinaryString(Ruby runtime,
 ByteList str)

newUSASCIIString

public static RubyString newUSASCIIString(Ruby runtime,
 String str)

newString

public static RubyString newString(Ruby runtime,
 byte[] bytes)

newString

public static RubyString newString(Ruby runtime,
 byte[] bytes,
 int start,
 int length)

newString

public static RubyString newString(Ruby runtime,
 byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding)

newString

public static RubyString newString(Ruby runtime,
 ByteList bytes)

newString

public static RubyString newString(Ruby runtime,
 ByteList bytes,
 int coderange)

newChilledString

public static RubyString newChilledString(Ruby runtime,
 ByteList bytes,
 int coderange,
 String file,
 int line)

newString

public static RubyString newString(Ruby runtime,
 ByteList bytes,
 org.jcodings.Encoding encoding)

newUnicodeString

public static RubyString newUnicodeString(Ruby runtime,
 String str)

newUTF8String

public static RubyString newUTF8String(Ruby runtime,
 String str)

newUTF16String

public static RubyString newUTF16String(Ruby runtime,
 String str)

newUnicodeString

public static RubyString newUnicodeString(Ruby runtime,
 CharSequence str)

newUTF8String

public static RubyString newUTF8String(Ruby runtime,
 CharSequence str)

newUTF16String

public static RubyString newUTF16String(Ruby runtime,
 CharSequence str)

newInternalFromJavaExternal

public static RubyString newInternalFromJavaExternal(Ruby runtime,
 String str)

Return a new Ruby String encoded as the default internal encoding given a Java String that has come from an external source. If there is no default internal encoding set, the Ruby String will be encoded using Java's default external encoding. If an internal encoding is set, that encoding will be used for the Ruby String.

Parameters:

runtime -

str -

Returns:

newStringShared

public static RubyString newStringShared(Ruby runtime,
 RubyString orig)

newStringShared

public static RubyString newStringShared(Ruby runtime,
 ByteList bytes)

newStringShared

public static RubyString newStringShared(Ruby runtime,
 ByteList bytes,
 org.jcodings.Encoding encoding)

newStringShared

public static RubyString newStringShared(Ruby runtime,
 ByteList bytes,
 int codeRange)

newStringShared

public static RubyString newStringShared(Ruby runtime,
 RubyClass clazz,
 ByteList bytes)

newStringShared

public static RubyString newStringShared(Ruby runtime,
 RubyClass clazz,
 ByteList bytes,
 org.jcodings.Encoding encoding)

newStringShared

@Deprecated(since="10.0.0.0")
public static RubyString newStringShared(Ruby runtime,
 byte[] bytes)

Deprecated.

newStringShared

@Deprecated(since="10.0.0.0")
public static RubyString newStringShared(Ruby runtime,
 byte[] bytes,
 org.jcodings.Encoding encoding)

Deprecated.

newStringShared

@Deprecated(since="10.0.0.0")
public static RubyString newStringShared(Ruby runtime,
 byte[] bytes,
 int start,
 int length)

Deprecated.

newStringShared

public static RubyString newStringShared(Ruby runtime,
 byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding)

newEmptyString

public static RubyString newEmptyString(Ruby runtime)

newEmptyBinaryString

public static RubyString newEmptyBinaryString(Ruby runtime)

newAllocatedString

public static RubyString newAllocatedString(Ruby runtime,
 RubyClass metaClass)

newEmptyString

public static RubyString newEmptyString(Ruby runtime,
 RubyClass metaClass)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 ByteList bytes)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 RubyClass clazz,
 ByteList bytes)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 byte[] bytes,
 int start,
 int length)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 byte[] bytes)

independent

public final boolean independent()

makeIndependent

public final RubyString makeIndependent()

makeIndependent

public final RubyString makeIndependent(int length)

export

public RubyString export(ThreadContext context)

capacity

public int capacity()

Determine how much space exists after the begin offset in this string's buffer.

Returns:

the amount of capacity in this string's buffer after the begin offset

getEmptyByteList

public static RubyString.EmptyByteListHolder getEmptyByteList(org.jcodings.Encoding enc)

newEmptyString

public static RubyString newEmptyString(Ruby runtime,
 RubyClass metaClass,
 org.jcodings.Encoding enc)

newEmptyString

public static RubyString newEmptyString(Ruby runtime,
 org.jcodings.Encoding enc)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 RubyClass clazz,
 ByteList bytes,
 org.jcodings.Encoding enc,
 int cr)

newStringNoCopy

public static RubyString newStringNoCopy(Ruby runtime,
 ByteList bytes,
 org.jcodings.Encoding enc,
 int cr)

newUsAsciiStringNoCopy

public static RubyString newUsAsciiStringNoCopy(Ruby runtime,
 ByteList bytes)

newUsAsciiStringShared

public static RubyString newUsAsciiStringShared(Ruby runtime,
 ByteList bytes)

newUsAsciiStringShared

public static RubyString newUsAsciiStringShared(Ruby runtime,
 byte[] bytes,
 int start,
 int length)

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

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

• ClassIndex

getJavaClass

public Class getJavaClass()

Description copied from class: RubyBasicObject

Will return the Java interface that most closely can represent this object, when working through Java integration translations.

Specified by:

getJavaClass in interface IRubyObject

Overrides:

getJavaClass in class RubyBasicObject

Returns:

the true Java class of this (Ruby) object

convertToString

public RubyString convertToString()

Description copied from class: RubyBasicObject

Tries to convert this object to a Ruby String using the "to_str" method.

Specified by:

convertToString in interface IRubyObject

Overrides:

convertToString in class RubyBasicObject

Returns:

a string representation of this

toString

public String toString()

Description copied from class: RubyObject

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

Specified by:

toString in interface CharSequence

Overrides:

toString in class RubyObject

Returns:

string representation

decodeString

public String decodeString()

Convert this Ruby string to a Java String. This version is encoding-aware.

Returns:

A decoded Java String, based on this Ruby string's encoding.

dup

public IRubyObject dup()

Overridden dup for fast-path logic.

Specified by:

dup in interface IRubyObject

Overrides:

dup in class RubyBasicObject

Returns:

A new RubyString sharing the original backing store.

dupFrozen

public IRubyObject dupFrozen()

dup

public IRubyObject dup(ThreadContext context)

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Parameters:

context - the thread context

Returns:

a dup-ed object

strDup

public final RubyString strDup(Ruby runtime)

strDup

public final RubyString strDup(Ruby runtime,
 RubyClass clazz)

dupAsChilled

public final RubyString dupAsChilled(Ruby runtime,
 RubyClass clazz,
 String file,
 int line)

dupAsFString

public RubyString.FString dupAsFString(Ruby runtime)

makeSharedString

public final RubyString makeSharedString(Ruby runtime,
 int index,
 int len)

makeShared

public final RubyString makeShared(Ruby runtime,
 int index,
 int len)

makeShared

public final RubyString makeShared(Ruby runtime,
 RubyClass meta,
 int index,
 int len)

setByteListShared

public final void setByteListShared()

modifyCheck

public final void modifyCheck()

Check that the string can be modified, raising error otherwise. If you plan to modify a string with shared backing store, this method is not sufficient; you will need to call modify() instead.

modifyCheck

public void modifyCheck(byte[] b,
 int len)

frozenCheck

protected void frozenCheck()

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

ensureInstanceVariablesSettable

public final void ensureInstanceVariablesSettable()

Description copied from class: RubyBasicObject

Makes sure that instance variables can be set on this object, including information about whether this object is frozen. Will throw a suitable exception in that case.

Overrides:

ensureInstanceVariablesSettable in class RubyBasicObject

mutateChilledString

protected void mutateChilledString()

isChilled

protected boolean isChilled()

isChilledLiteral

protected boolean isChilledLiteral()

modify

public final void modify()

Specified by:

modify in interface ByteListHolder

modify19

@Deprecated(since="10.0.0.0")
public final void modify19()

Deprecated.

modifyAndClearCodeRange

public final void modifyAndClearCodeRange()

modifyAndKeepCodeRange

public void modifyAndKeepCodeRange()

Specified by:

modifyAndKeepCodeRange in interface CodeRangeable

modify

public final void modify(int length)

rb_str_modify (with length bytes ensured)

Specified by:

modify in interface ByteListHolder

modifyExpand

public final void modifyExpand(int length)

rb_str_modify_expand

ensureAvailable

public void ensureAvailable(ThreadContext context,
 int extraLength)

Ensure the backing store belongs to this string and has enough space to add extraLength bytes. MRI: str_ensure_available_capa

Parameters:

context - the current thread context

extraLength - the extra length needed

setReadLength

public void setReadLength(int length)

newFString

public static RubyString newFString(Ruby runtime,
 String content)

Create anew or deduplicate a RubyString based on the given Java String content.

Parameters:

runtime - the JRuby runtime

content - the Java String content

Returns:

a frozen, deduplicated RubyString hosting the given content

newFrozen

public RubyString newFrozen()

newDebugFrozenString

public static RubyString newDebugFrozenString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 int cr,
 String file,
 int line)

newDebugChilledString

public static RubyString newDebugChilledString(Ruby runtime,
 RubyClass rubyClass,
 ByteList value,
 int cr,
 String file,
 int line)

resize

public final void resize(int size)

rb_str_resize

view

public final void view(ByteList bytes)

bytesToString

public static String bytesToString(byte[] bytes,
 int beg,
 int len)

byteListToString

public static String byteListToString(ByteList bytes)

bytesToString

public static String bytesToString(byte[] bytes)

stringToBytes

public static byte[] stringToBytes(String string)

asString

public RubyString asString()

Description copied from class: RubyBasicObject

rb_obj_as_string First converts this object into a String using the "to_s" method and returns it. If to_s doesn't return a Ruby String, Convert.anyToString(org.jruby.runtime.ThreadContext, org.jruby.runtime.builtin.IRubyObject) is used instead.

Specified by:

asString in interface IRubyObject

Overrides:

asString in class RubyBasicObject

Returns:

string representation

checkStringType

public IRubyObject checkStringType()

Description copied from class: RubyBasicObject

rb_check_string_type Tries to return a coerced string representation of this object, using "to_str". If that returns something other than a String or nil, an empty String will be returned.

Specified by:

checkStringType in interface IRubyObject

Overrides:

checkStringType in class RubyBasicObject

Returns:

nil if type check failed

try_convert

public static IRubyObject try_convert(ThreadContext context,
 IRubyObject recv,
 IRubyObject str)

to_s

public RubyString to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

compareTo

public final int compareTo(IRubyObject other)

Description copied from class: RubyBasicObject

Compares this Ruby object with another.

Specified by:

compareTo in interface Comparable<IRubyObject>

Overrides:

compareTo in class RubyBasicObject

Parameters:

other - another IRubyObject

Returns:

0 if equal, < 0 if this is less than other, > 0 if this is greater than other

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject other)

Overrides:

op_cmp in class RubyBasicObject

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject other)

rb_str_equal

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

minus_at

public final IRubyObject minus_at(ThreadContext context)

plus_at

@Deprecated(since="10.0.0.0")
public final IRubyObject plus_at()

Deprecated.

plus_at

public final IRubyObject plus_at(ThreadContext context)

op_plus19

@Deprecated(since="10.0.0.0")
public IRubyObject op_plus19(ThreadContext context,
 IRubyObject arg)

Deprecated.

op_plus

public IRubyObject op_plus(ThreadContext context,
 IRubyObject arg)

op_mul19

@Deprecated(since="10.0.0.0")
public IRubyObject op_mul19(ThreadContext context,
 IRubyObject other)

Deprecated.

op_mul

public IRubyObject op_mul(ThreadContext context,
 IRubyObject other)

op_format

public RubyString op_format(ThreadContext context,
 IRubyObject arg)

hash

public RubyFixnum hash(ThreadContext context)

Description copied from class: RubyBasicObject

Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the hash value

hashCode

public int hashCode()

Description copied from class: RubyObject

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyObject

Returns:

the hash code

See Also:

• RubyBasicObject.hashCode()

longHashCode

public long longHashCode()

Specified by:

longHashCode in interface SimpleHash

strHashCode

public int strHashCode(Ruby runtime)

Generate a hash for the String, using its associated Ruby instance's hash seed.

Parameters:

runtime - the runtime

Returns:

calculated hash

unseededStrHashCode

public int unseededStrHashCode(Ruby runtime)

Generate a hash for the String, without a seed.

Parameters:

runtime - the runtime

Returns:

calculated hash

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyObject

Parameters:

other - object to compare

Returns:

true if equals

See Also:

• RubyBasicObject.equals(Object)

objAsString

public static RubyString objAsString(ThreadContext context,
 IRubyObject obj)

rb_obj_as_string

op_cmp

public final int op_cmp(RubyString other)

rb_str_cmp

asJavaString

public String asJavaString()

rb_to_id

Specified by:

asJavaString in interface IRubyObject

Overrides:

asJavaString in class RubyBasicObject

Returns:

a (Java) string

doClone

public IRubyObject doClone()

cat

public final RubyString cat(byte[] str)

cat

public final RubyString cat(byte[] str,
 int beg,
 int len)

cat19

@Deprecated(since="10.0.0.0")
public final RubyString cat19(RubyString str2)

Deprecated.

catWithCodeRange

public final RubyString catWithCodeRange(RubyString str2)

cat

public final RubyString cat(ByteList other,
 int codeRange)

cat19

@Deprecated(since="10.0.0.0")
public final int cat19(ByteList other,
 int codeRange)

Deprecated.

catWithCodeRange

public final int catWithCodeRange(ByteList other,
 int codeRange)

catStringUnsafe

public final RubyString catStringUnsafe(String str)

Append a Java String to this RubyString assuming it will be the encoding of the RubyString. If it is not then then it will end up as an invalid string. Some methods assume an encoding of BINARY so that broken bytes are possible/expected (e.g. an error message with two names which are not compatible to be combined into a single Ruby String). Proc#to_s is an example of this.

Parameters:

str - to be appended

Returns:

this string after it has appended str

catString

public final RubyString catString(String str)

cat

public final RubyString cat(RubyString str)

cat

public final RubyString cat(ByteList str)

cat

public final RubyString cat(byte ch)

cat

public final RubyString cat(int ch)

cat

public final RubyString cat(int code,
 org.jcodings.Encoding enc)

cat

public final int cat(byte[] bytes,
 int p,
 int len,
 org.jcodings.Encoding enc)

catAscii

public final RubyString catAscii(byte[] bytes,
 int ptr,
 int ptrLen)

replace19

@Deprecated(since="10.0.0.0")
public RubyString replace19(IRubyObject other)

Deprecated.

initialize_copy

@Deprecated(since="10.0.0.0")
public RubyString initialize_copy(IRubyObject other)

Deprecated.

Overrides:

initialize_copy in class RubyBasicObject

Parameters:

other - object

Returns:

a copy

initialize_copy

public RubyString initialize_copy(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

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

Parameters:

context - the thread context

other - the original

Returns:

a copy unless the same thing

replace

@Deprecated(since="10.0.0.0")
public IRubyObject replace(IRubyObject other)

Deprecated.

replace

public RubyString replace(ThreadContext context,
 IRubyObject other)

rb_str_replace_m

clear

@Deprecated(since="10.0.0.0")
public RubyString clear()

Deprecated.

clear

public RubyString clear(ThreadContext context)

reverse19

@Deprecated(since="10.0.0.0")
public IRubyObject reverse19(ThreadContext context)

Deprecated.

reverse

public IRubyObject reverse(ThreadContext context)

reverse_bang19

@Deprecated(since="10.0.0.0")
public RubyString reverse_bang19(ThreadContext context)

Deprecated.

reverse_bang

public RubyString reverse_bang(ThreadContext context)

newInstance

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

rb_str_s_new

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject arg0)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject arg0,
 IRubyObject opts)

casecmp

public IRubyObject casecmp(ThreadContext context,
 IRubyObject other)

casecmp_p

public IRubyObject casecmp_p(ThreadContext context,
 IRubyObject other)

op_match

public IRubyObject op_match(ThreadContext context,
 IRubyObject other)

rb_str_match

Overrides:

op_match in class RubyBasicObject

Parameters:

context - the thread context

other - arg

Returns:

true if matches (always nil)

match19

@Deprecated(since="10.0.0.0")
public IRubyObject match19(ThreadContext context,
 IRubyObject pattern)

Deprecated.

match19

@Deprecated(since="10.0.0.0")
public IRubyObject match19(ThreadContext context,
 IRubyObject pattern,
 IRubyObject pos,
 Block block)

Deprecated.

match19

@Deprecated(since="10.0.0.0")
public IRubyObject match19(ThreadContext context,
 IRubyObject[] args,
 Block block)

Deprecated.

match

@Deprecated(since="10.0.0.0")
public IRubyObject match(ThreadContext context,
 IRubyObject pattern)

Deprecated.

String#match(pattern) rb_str_match_m

Parameters:

pattern - Regexp or String

match

public IRubyObject match(ThreadContext context,
 IRubyObject pattern,
 Block block)

match

public IRubyObject match(ThreadContext context,
 IRubyObject pattern,
 IRubyObject pos,
 Block block)

match

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

match_p

public IRubyObject match_p(ThreadContext context,
 IRubyObject pattern)

match_p

public IRubyObject match_p(ThreadContext context,
 IRubyObject pattern,
 IRubyObject pos)

op_ge19

@Deprecated(since="10.0.0.0")
public IRubyObject op_ge19(ThreadContext context,
 IRubyObject other)

Deprecated.

op_ge

public IRubyObject op_ge(ThreadContext context,
 IRubyObject other)

op_gt19

@Deprecated(since="10.0.0.0")
public IRubyObject op_gt19(ThreadContext context,
 IRubyObject other)

Deprecated.

op_gt

public IRubyObject op_gt(ThreadContext context,
 IRubyObject other)

op_le19

@Deprecated(since="10.0.0.0")
public IRubyObject op_le19(ThreadContext context,
 IRubyObject other)

Deprecated.

op_le

public IRubyObject op_le(ThreadContext context,
 IRubyObject other)

op_lt19

@Deprecated(since="10.0.0.0")
public IRubyObject op_lt19(ThreadContext context,
 IRubyObject other)

Deprecated.

op_lt

public IRubyObject op_lt(ThreadContext context,
 IRubyObject other)

str_eql_p19

@Deprecated(since="10.0.0.0")
public IRubyObject str_eql_p19(ThreadContext context,
 IRubyObject other)

Deprecated.

str_eql_p

public IRubyObject str_eql_p(ThreadContext context,
 IRubyObject other)

upcase

public RubyString upcase(ThreadContext context)

rb_str_upcase / rb_str_upcase_bang

upcase

public RubyString upcase(ThreadContext context,
 IRubyObject arg)

upcase

public RubyString upcase(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

upcase_bang

public IRubyObject upcase_bang(ThreadContext context)

upcase_bang

public IRubyObject upcase_bang(ThreadContext context,
 IRubyObject arg)

upcase_bang

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

downcase

public RubyString downcase(ThreadContext context)

rb_str_downcase / rb_str_downcase_bang

downcase

public RubyString downcase(ThreadContext context,
 IRubyObject arg)

downcase

public RubyString downcase(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

downcase_bang

public IRubyObject downcase_bang(ThreadContext context)

downcase_bang

public IRubyObject downcase_bang(ThreadContext context,
 IRubyObject arg)

downcase_bang

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

swapcase

public RubyString swapcase(ThreadContext context)

rb_str_swapcase / rb_str_swapcase_bang

swapcase

public RubyString swapcase(ThreadContext context,
 IRubyObject arg)

swapcase

public RubyString swapcase(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

swapcase_bang

public IRubyObject swapcase_bang(ThreadContext context)

swapcase_bang

public IRubyObject swapcase_bang(ThreadContext context,
 IRubyObject arg)

swapcase_bang

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

capitalize

public RubyString capitalize(ThreadContext context)

rb_str_capitalize / rb_str_capitalize_bang

capitalize

public RubyString capitalize(ThreadContext context,
 IRubyObject arg)

capitalize

public RubyString capitalize(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

capitalize_bang

public IRubyObject capitalize_bang(ThreadContext context)

capitalize_bang

public IRubyObject capitalize_bang(ThreadContext context,
 IRubyObject arg)

capitalize_bang

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

dump

@Deprecated(since="10.0.0.0")
public IRubyObject dump()

Deprecated.

dump

public IRubyObject dump(ThreadContext context)

rb_str_dump

undump

public IRubyObject undump(ThreadContext context)

insert

public IRubyObject insert(ThreadContext context,
 IRubyObject indexArg,
 IRubyObject arg)

inspect

@Deprecated(since="10.0.0.0")
public RubyString inspect()

Deprecated.

Description copied from interface: IRubyObject

RubyMethod inspect.

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

inspect

public IRubyObject inspect(ThreadContext context)

rb_str_inspect

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

rbStrEscape

public static IRubyObject rbStrEscape(ThreadContext context,
 RubyString str)

inspect

@Deprecated(since="10.0.0.0")
public static RubyString inspect(Ruby runtime,
 ByteList byteList)

Deprecated.

inspect

public static RubyString inspect(ThreadContext context,
 ByteList byteList)

size

public int size()

rubyLength

public RubyFixnum rubyLength(ThreadContext context)

bytesize

public RubyFixnum bytesize(ThreadContext context)

bytesize

@Deprecated(since="10.0.0.0")
public RubyFixnum bytesize()

Deprecated.

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int offset)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

empty_p

public RubyBoolean empty_p(ThreadContext context)

rb_str_empty

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface CharSequence

appendIntoString

public void appendIntoString(RubyString target)

Specified by:

appendIntoString in interface Appendable

append

public RubyString append(IRubyObject other,
 Function<IRubyObject,RubyString> convert)

rb_str_append

append

public RubyString append(IRubyObject other)

append

public RubyString append(RubyString other)

append19

@Deprecated(since="9.4.4.0")
public RubyString append19(IRubyObject other)

Deprecated.

appendAsDynamicString

public RubyString appendAsDynamicString(IRubyObject other)

appendAsStringOrAny

public RubyString appendAsStringOrAny(IRubyObject other)

concatSingle

public RubyString concatSingle(ThreadContext context,
 IRubyObject other)

rb_str_concat

concat

public RubyString concat(ThreadContext context,
 IRubyObject obj)

rb_str_concat

concat

public RubyString concat(ThreadContext context,
 IRubyObject[] objs)

rb_str_concat_multi

concat

public RubyString concat(IRubyObject other)

prepend

public IRubyObject prepend(ThreadContext context,
 IRubyObject other)

rb_str_prepend

prepend

public IRubyObject prepend(ThreadContext context,
 IRubyObject[] objs)

rb_str_prepend

prepend

public final RubyString prepend(byte ch)

prepend

public final RubyString prepend(int ch)

crypt

public RubyString crypt(ThreadContext context,
 IRubyObject other)

rb_str_crypt

stringValue

public static RubyString stringValue(IRubyObject object)

sub

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

rb_str_sub / rb_str_sub_bang

sub

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

sub_bang

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

sub_bang

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

subBangFast

public final IRubyObject subBangFast(ThreadContext context,
 RubyRegexp regexp,
 RubyString repl)

sub! but without any frame globals ...

Parameters:

context - current context

regexp - the regular expression

repl - replacement string value

Returns:

sub result

gsub

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

gsub

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

gsub_bang

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

gsub_bang

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

gsubFast

public RubyString gsubFast(ThreadContext context,
 RubyRegexp regexp,
 RubyString repl,
 Block block)

index

public IRubyObject index(ThreadContext context,
 IRubyObject arg0)

rb_str_index_m

index

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

byteindex

public IRubyObject byteindex(ThreadContext context,
 IRubyObject arg0)

byteindex

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

rindex

public IRubyObject rindex(ThreadContext context,
 IRubyObject arg0)

rb_str_rindex_m

rindex

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

byterindex

public IRubyObject byterindex(ThreadContext context,
 IRubyObject arg0)

byterindex

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

substr

@Deprecated(since="9.4-")
public final IRubyObject substr(int beg,
 int len)

Deprecated.

substr

@Deprecated(since="10.0.0.0")
public final IRubyObject substr(Ruby runtime,
 int beg,
 int len)

Deprecated.

substr

public final IRubyObject substr(ThreadContext context,
 int beg,
 int len)

substr19

@Deprecated(since="10.0.0.0")
public final IRubyObject substr19(Ruby runtime,
 int beg,
 int len)

Deprecated.

substrEnc

@Deprecated(since="10.0.0.0")
public final IRubyObject substrEnc(Ruby runtime,
 int beg,
 int len)

Deprecated.

substrEnc

public final IRubyObject substrEnc(ThreadContext context,
 int beg,
 int len)

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject arg)

rb_str_aref, rb_str_aref_m

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject arg1,
 IRubyObject arg2)

byteslice

public IRubyObject byteslice(ThreadContext context,
 IRubyObject arg1,
 IRubyObject arg2)

byteslice

public IRubyObject byteslice(ThreadContext context,
 IRubyObject arg)

bytesplice

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

bytesplice

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

bytesplice

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

atCharBoundary

public static boolean atCharBoundary(byte[] bytes,
 int s,
 int p,
 int e,
 org.jcodings.Encoding enc)

op_aset

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

rb_str_aset, rb_str_aset_m

op_aset

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

slice_bang

public IRubyObject slice_bang(ThreadContext context,
 IRubyObject arg0)

rb_str_slice_bang

slice_bang

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

succ

public IRubyObject succ(ThreadContext context)

succ_bang

@Deprecated(since="10.0.0.0")
public IRubyObject succ_bang()

Deprecated.

succ_bang

public IRubyObject succ_bang(ThreadContext context)

upto

public final IRubyObject upto(ThreadContext context,
 IRubyObject end,
 Block block)

rb_str_upto_m

upto

public final IRubyObject upto(ThreadContext context,
 IRubyObject end,
 IRubyObject excl,
 Block block)

include_p

public RubyBoolean include_p(ThreadContext context,
 IRubyObject obj)

rb_str_include

chr

public IRubyObject chr(ThreadContext context)

getbyte

public IRubyObject getbyte(ThreadContext context,
 IRubyObject index)

setbyte

public IRubyObject setbyte(ThreadContext context,
 IRubyObject index,
 IRubyObject val)

to_i

@Deprecated(since="10.0.0.0")
public IRubyObject to_i()

Deprecated.

to_i

public IRubyObject to_i(ThreadContext context)

to_i

@Deprecated(since="10.0.0.0")
public IRubyObject to_i(IRubyObject arg0)

Deprecated.

to_i

public IRubyObject to_i(ThreadContext context,
 IRubyObject arg0)

rb_str_to_i

stringToInum

public IRubyObject stringToInum(int base,
 boolean badcheck)

rb_str_to_inum

stringToInum

public final IRubyObject stringToInum(int base)

oct

public IRubyObject oct(ThreadContext context)

rb_str_oct

hex

public IRubyObject hex(ThreadContext context)

rb_str_hex

to_f

@Deprecated(since="10.0.0.0")
public IRubyObject to_f()

Deprecated.

to_f

public IRubyObject to_f(ThreadContext context)

split

public RubyArray split(ThreadContext context)

split

public RubyArray split(ThreadContext context,
 IRubyObject arg0)

splitWithBlock

public IRubyObject splitWithBlock(ThreadContext context,
 Block block)

rb_str_split_m

splitWithBlock

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

split

public RubyArray split(ThreadContext context,
 IRubyObject pattern,
 IRubyObject limit)

splitWithBlock

public IRubyObject splitWithBlock(ThreadContext context,
 IRubyObject pattern,
 IRubyObject limit,
 Block block)

split

@Deprecated(since="10.0.0.0")
public RubyArray split(RubyRegexp delimiter)

Deprecated.

Split for ext (Java) callers (does not write $~).

Parameters:

delimiter -

Returns:

splited entries

split

@Deprecated(since="10.0.0.0")
public RubyArray split(RubyRegexp delimiter,
 int limit)

Deprecated.

split

public RubyArray split(ThreadContext context,
 RubyRegexp delimiter,
 int limit)

Split for ext (Java) callers (does not write $~).

Parameters:

context - the thread context

delimiter -

limit -

Returns:

splited entries

split

@Deprecated(since="10.0.0.0")
public RubyArray split(RubyString delimiter)

Deprecated.

split

@Deprecated(since="10.0.0.0")
public RubyArray split(RubyString delimiter,
 int limit)

Deprecated.

split

public RubyArray split(ThreadContext context,
 RubyString delimiter,
 int limit)

Split for ext (Java) callers (does not write $~).

Parameters:

context - the thread context

delimiter -

limit -

Returns:

splited entries

singletonClass

public RubyClass singletonClass(ThreadContext context)

Description copied from class: RubyBasicObject

Will either return the existing singleton class for this object, or create a new one and return that. For a few types a singleton class is not possible so it will throw an error.

Specified by:

singletonClass in interface IRubyObject

Overrides:

singletonClass in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the singleton of this type

scan

public IRubyObject scan(ThreadContext context,
 IRubyObject pat,
 Block block)

rb_str_scan

start_with_p

public IRubyObject start_with_p(ThreadContext context)

start_with_p

public IRubyObject start_with_p(ThreadContext context,
 IRubyObject arg)

start_with_p

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

startsWith

public boolean startsWith(RubyString str)

end_with_p

public IRubyObject end_with_p(ThreadContext context)

end_with_p

public IRubyObject end_with_p(ThreadContext context,
 IRubyObject arg)

end_with_p

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

endWith

protected boolean endWith(IRubyObject tmp)

endsWithAsciiChar

public boolean endsWithAsciiChar(char c)

delete_prefix

public IRubyObject delete_prefix(ThreadContext context,
 IRubyObject prefix)

delete_suffix

public IRubyObject delete_suffix(ThreadContext context,
 IRubyObject suffix)

delete_prefix_bang

public IRubyObject delete_prefix_bang(ThreadContext context,
 IRubyObject prefix)

delete_suffix_bang

public IRubyObject delete_suffix_bang(ThreadContext context,
 IRubyObject suffix)

ljust

@Deprecated(since="10.0.0.0")
public IRubyObject ljust(IRubyObject arg0)

Deprecated.

ljust

public IRubyObject ljust(ThreadContext context,
 IRubyObject arg0)

rb_str_ljust

ljust

@Deprecated(since="10.0.0.0")
public IRubyObject ljust(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

ljust

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

rjust

@Deprecated(since="10.0.0.0")
public IRubyObject rjust(IRubyObject arg0)

Deprecated.

rjust

public IRubyObject rjust(ThreadContext context,
 IRubyObject arg0)

rb_str_rjust

rjust

@Deprecated(since="10.0.0.0")
public IRubyObject rjust(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

rjust

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

center

@Deprecated(since="10.0.0.0")
public IRubyObject center(IRubyObject arg0)

Deprecated.

center

public IRubyObject center(ThreadContext context,
 IRubyObject arg0)

rb_str_center

center

@Deprecated(since="10.0.0.0")
public IRubyObject center(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

center

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

partition

public IRubyObject partition(ThreadContext context,
 Block block)

partition

public IRubyObject partition(ThreadContext context,
 IRubyObject arg,
 Block block)

rpartition

public IRubyObject rpartition(ThreadContext context,
 IRubyObject arg)

append_as_bytes

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

append_as_bytes

public IRubyObject append_as_bytes(ThreadContext context)

append_as_bytes

public IRubyObject append_as_bytes(ThreadContext context,
 IRubyObject arg0)

chop

public IRubyObject chop(ThreadContext context)

rb_str_chop / rb_str_chop_bang

chop_bang

public IRubyObject chop_bang(ThreadContext context)

chomp19

@Deprecated(since="10.0.0.0")
public RubyString chomp19(ThreadContext context)

Deprecated.

chomp19

@Deprecated(since="10.0.0.0")
public RubyString chomp19(ThreadContext context,
 IRubyObject arg0)

Deprecated.

chomp_bang19

@Deprecated(since="10.0.0.0")
public IRubyObject chomp_bang19(ThreadContext context)

Deprecated.

chomp_bang19

@Deprecated(since="10.0.0.0")
public IRubyObject chomp_bang19(ThreadContext context,
 IRubyObject arg0)

Deprecated.

chomp

public RubyString chomp(ThreadContext context)

rb_str_chomp_bang In the common case, removes CR and LF characters in various ways depending on the value of the optional args[0]. If args.length==0 removes one instance of CR, CRLF or LF from the end of the string. If args.length>0 and args[0] is "\n" then same behaviour as args.length==0 . If args.length>0 and args[0] is "" then removes trailing multiple LF or CRLF (but no CRs at all(!)).

chomp

public RubyString chomp(ThreadContext context,
 IRubyObject arg0)

chomp_bang

public IRubyObject chomp_bang(ThreadContext context)

chomp_bang

public IRubyObject chomp_bang(ThreadContext context,
 IRubyObject arg0)

lstrip

public IRubyObject lstrip(ThreadContext context)

rb_str_lstrip / rb_str_lstrip_bang

lstrip_bang

public IRubyObject lstrip_bang(ThreadContext context)

rstrip

public IRubyObject rstrip(ThreadContext context)

rb_str_rstrip / rb_str_rstrip_bang

rstrip_bang

public IRubyObject rstrip_bang(ThreadContext context)

strip

public IRubyObject strip(ThreadContext context)

rb_str_strip / rb_str_strip_bang

strip_bang

public IRubyObject strip_bang(ThreadContext context)

count

public IRubyObject count(ThreadContext context)

count

public IRubyObject count(ThreadContext context,
 IRubyObject arg)

count

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

delete

public IRubyObject delete(ThreadContext context)

rb_str_delete / rb_str_delete_bang

delete

public IRubyObject delete(ThreadContext context,
 IRubyObject arg)

delete

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

delete_bang

public IRubyObject delete_bang(ThreadContext context)

delete_bang

public IRubyObject delete_bang(ThreadContext context,
 IRubyObject arg)

delete_bang

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

squeeze

public IRubyObject squeeze(ThreadContext context)

rb_str_squeeze / rb_str_squeeze_bang

squeeze

public IRubyObject squeeze(ThreadContext context,
 IRubyObject arg)

squeeze

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

squeeze_bang

public IRubyObject squeeze_bang(ThreadContext context)

squeeze_bang

public IRubyObject squeeze_bang(ThreadContext context,
 IRubyObject arg)

squeeze_bang

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

tr

public IRubyObject tr(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

rb_str_tr / rb_str_tr_bang

tr_bang

public IRubyObject tr_bang(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

tr_s19

@Deprecated(since="10.0.0.0")
public IRubyObject tr_s19(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

Deprecated.

tr_s_bang19

@Deprecated(since="10.0.0.0")
public IRubyObject tr_s_bang19(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

Deprecated.

tr_s

public IRubyObject tr_s(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

rb_str_tr_s / rb_str_tr_s_bang

tr_s_bang

public IRubyObject tr_s_bang(ThreadContext context,
 IRubyObject src,
 IRubyObject repl)

each_line

public IRubyObject each_line(ThreadContext context,
 Block block)

rb_str_each_line

each_line

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

each_line

public IRubyObject each_line(ThreadContext context,
 IRubyObject arg,
 IRubyObject opts,
 Block block)

lines

public IRubyObject lines(ThreadContext context,
 Block block)

lines

public IRubyObject lines(ThreadContext context,
 IRubyObject arg,
 Block block)

lines

public IRubyObject lines(ThreadContext context,
 IRubyObject arg,
 IRubyObject opts,
 Block block)

each_byte

public IRubyObject each_byte(ThreadContext context,
 Block block)

rb_str_each_byte

bytes

public IRubyObject bytes(ThreadContext context,
 Block block)

each_char

public IRubyObject each_char(ThreadContext context,
 Block block)

chars

public IRubyObject chars(ThreadContext context,
 Block block)

each_codepoint

public IRubyObject each_codepoint(ThreadContext context,
 Block block)

rb_str_each_codepoint

codepoints

public IRubyObject codepoints(ThreadContext context,
 Block block)

grapheme_clusters

public IRubyObject grapheme_clusters(ThreadContext context,
 Block block)

each_grapheme_cluster

public IRubyObject each_grapheme_cluster(ThreadContext context,
 Block block)

intern

@Deprecated(since="10.0.0.0")
public RubySymbol intern()

Deprecated.

intern

public RubySymbol intern(ThreadContext context)

ord

public IRubyObject ord(ThreadContext context)

sum

public IRubyObject sum(ThreadContext context)

sum

public IRubyObject sum(ThreadContext context,
 IRubyObject arg)

sumCommon

public IRubyObject sumCommon(ThreadContext context,
 long bits)

to_c

public IRubyObject to_c(ThreadContext context)

string_to_c

to_r

public IRubyObject to_r(ThreadContext context)

string_to_r

unmarshalFrom

@Deprecated(since="10.0.0.0",
            forRemoval=true)
public static RubyString unmarshalFrom(UnmarshalStream input)
                                throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

unmarshalFrom

public static RubyString unmarshalFrom(ThreadContext context,
 RubyInputStream in,
 MarshalLoader input)

unpack

public RubyArray unpack(ThreadContext context,
 IRubyObject obj,
 Block block)

See Also:

• Pack.unpack(org.jruby.runtime.ThreadContext, org.jruby.util.ByteList, org.jruby.util.ByteList)

unpack

public RubyArray unpack(ThreadContext context,
 IRubyObject obj,
 IRubyObject opt,
 Block block)

unpack1

public IRubyObject unpack1(ThreadContext context,
 IRubyObject obj,
 Block block)

unpack1

public IRubyObject unpack1(ThreadContext context,
 IRubyObject obj,
 IRubyObject opt,
 Block block)

empty

public void empty()

encoding

public IRubyObject encoding(ThreadContext context)

encode_bang

public IRubyObject encode_bang(ThreadContext context)

encode_bang

public IRubyObject encode_bang(ThreadContext context,
 IRubyObject arg0)

encode_bang

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

encode_bang

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

encode

public IRubyObject encode(ThreadContext context)

encode

public IRubyObject encode(ThreadContext context,
 IRubyObject arg)

encode

public IRubyObject encode(ThreadContext context,
 IRubyObject toEncoding,
 IRubyObject arg)

encode

public IRubyObject encode(ThreadContext context,
 IRubyObject toEncoding,
 IRubyObject forcedEncoding,
 IRubyObject opts)

force_encoding

public IRubyObject force_encoding(ThreadContext context,
 IRubyObject enc)

valid_encoding_p

public IRubyObject valid_encoding_p(ThreadContext context)

ascii_only_p

public IRubyObject ascii_only_p(ThreadContext context)

b

public IRubyObject b(ThreadContext context)

scrub

public IRubyObject scrub(ThreadContext context,
 Block block)

scrub

public IRubyObject scrub(ThreadContext context,
 IRubyObject repl,
 Block block)

scrub_bang

public IRubyObject scrub_bang(ThreadContext context,
 Block block)

scrub_bang

public IRubyObject scrub_bang(ThreadContext context,
 IRubyObject repl,
 Block block)

freeze

public IRubyObject freeze(ThreadContext context)

Overrides:

freeze in class RubyBasicObject

chill

public RubyString chill()

chill_symbol_string

public RubyString chill_symbol_string()

setValue

@Deprecated(since="10.0.0.0")
public void setValue(CharSequence value)

Deprecated.

setValue

public void setValue(ByteList value)

getValue

public CharSequence getValue()

getBytes

public byte[] getBytes()

getByteList

public ByteList getByteList()

Get the ByteList which backs this Ruby String

Specified by:

getByteList in interface ByteListHolder

Returns:

The byte list

getUnicodeValue

public String getUnicodeValue()

used by ar-jdbc

encodeBytelist

public static ByteList encodeBytelist(CharSequence value,
 org.jcodings.Encoding encoding)

toJava

public <T> T toJava(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

Type Parameters:

T - type

Parameters:

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

Returns:

java type

See Also:

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

strScrub

public IRubyObject strScrub(ThreadContext context,
 IRubyObject repl,
 Block block)

Scrub the contents of this string, replacing invalid characters as appropriate. MRI: rb_str_scrub

encStrScrub

public IRubyObject encStrScrub(ThreadContext context,
 org.jcodings.Encoding enc,
 IRubyObject repl,
 Block block)

encStrScrub

public IRubyObject encStrScrub(ThreadContext context,
 org.jcodings.Encoding enc,
 IRubyObject repl,
 int cr,
 Block block)

rbStrOffset

public int rbStrOffset(int pos)

includeRange

public static IRubyObject includeRange(ThreadContext context,
 RubyString _beg,
 RubyString _end,
 IRubyObject _val,
 boolean exclusive)

isBare

@Deprecated(since="10.0.0.0")
public boolean isBare(Ruby runtime)

Deprecated.

isBare

public boolean isBare(ThreadContext context)

Is this a "bare" string, i.e. has no instance vars, and class == String.

strDup

@Deprecated(since="9.0.0.0")
public final RubyString strDup()

Deprecated.

Deprecated but still used by JIT, see ArrayDerefInvokeSite.STRDUP_FILTER

unpack

@Deprecated(since="9.4.6.0")
public RubyArray unpack(IRubyObject obj)

Deprecated.

encode_bang

@Deprecated(since="9.4.6.0")
public IRubyObject encode_bang(ThreadContext context,
 IRubyObject[] args)

Deprecated.