Package org.jruby

Class RubySymbol

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubySymbol

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Appendable, Constantizable, InstanceVariables, InternalVariables, IRubyObject, EncodingCapable, MarshalEncoding, CoreObjectType

public class RubySymbol
extends RubyObject
implements MarshalEncoding, EncodingCapable, Constantizable, Appendable

Represents a Ruby symbol (e.g. :bar)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RubySymbol.ObjBooleanConsumer<T>
static final class	RubySymbol.SymbolProcBody
static final class	RubySymbol.SymbolTable

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
static final long	symbolHashSeedK0	Deprecated.

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, 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

Method Summary

Modifier and Type	Method	Description
static IRubyObject	all_symbols(IRubyObject recv)	Deprecated.
static IRubyObject	all_symbols(ThreadContext context, IRubyObject recv)
void	appendIntoString(RubyString target)
RubySymbol	asInstanceVariable()
final String	asJavaString()	rb_to_id
void	associateEncoding(org.jcodings.Encoding encoding)	RubySymbol is created by passing in a String and bytes are extracted from that.
RubyString	asString()	rb_obj_as_string First converts this object into a String using the "to_s" method and returns it.
RubySymbol	asWriter()	Make an instance variable out of this symbol (e.g.
IRubyObject	capitalize(ThreadContext context)
IRubyObject	capitalize(ThreadContext context, IRubyObject arg)
IRubyObject	capitalize(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	casecmp(ThreadContext context, IRubyObject other)
IRubyObject	casecmp_p(ThreadContext context, IRubyObject other)
static String	checkID(IRubyObject object)	Deprecated.
int	compareTo(IRubyObject that)	Compares this Ruby object with another.
Object	constant()
static RubyClass	createSymbolClass(ThreadContext context, RubyClass Object, RubyModule Comparable)
IRubyObject	downcase(ThreadContext context)
IRubyObject	downcase(ThreadContext context, IRubyObject arg)
IRubyObject	downcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	empty_p(ThreadContext context)
IRubyObject	encoding(ThreadContext context)
IRubyObject	end_with_p(ThreadContext context)
IRubyObject	end_with_p(ThreadContext context, IRubyObject arg)
IRubyObject	end_with_p(ThreadContext context, IRubyObject[] args)
final boolean	eql(IRubyObject other)	short circuit for Symbol key comparison
boolean	equals(Object other)	This override does not do a "checked" dispatch.
RubyString	fstring()
final ByteList	getBytes()
org.jcodings.Encoding	getEncoding()
int	getId()
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.
static RubySymbol	getSymbolLong(Ruby runtime, long id)
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.
IRubyObject	id2name()	Deprecated.
IRubyObject	id2name(ThreadContext context)
String	idString()	Return an id string (e.g.
static String	idStringFromObject(ThreadContext context, IRubyObject object)
static RubySymbol	idSymbolFromObject(ThreadContext context, IRubyObject object)
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
boolean	isImmediate()	Is object immediate (def: Fixnum, Symbol, true, false, nil?).
static int	javaStringHashCode(ByteList iso8859)
IRubyObject	length()	Deprecated. Use length(ThreadContext) instead.
IRubyObject	length(ThreadContext context)
IRubyObject	match_m(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	match_m(ThreadContext context, IRubyObject other, Block block)
IRubyObject	match_m(ThreadContext context, IRubyObject other, IRubyObject pos, Block block)
IRubyObject	match_p(ThreadContext context, IRubyObject other)
IRubyObject	match_p(ThreadContext context, IRubyObject other, IRubyObject pos)
IRubyObject	name(ThreadContext context)
static RubySymbol	newCalleeSymbolFromCompound(Ruby runtime, String compoundName)
static RubySymbol	newConstantSymbol(Ruby runtime, IRubyObject fqn, ByteList bytes)	Deprecated.
static RubySymbol	newConstantSymbol(ThreadContext context, IRubyObject fqn, ByteList bytes)	Create a symbol whose intention is to be used as a constant.
static RubySymbol	newHardSymbol(Ruby runtime, String name)
static RubySymbol	newHardSymbol(Ruby runtime, String name, org.jcodings.Encoding encoding)
static RubySymbol	newHardSymbol(Ruby runtime, IRubyObject name)
static RubySymbol	newHardSymbol(Ruby runtime, ByteList bytes)
static RubySymbol	newHardSymbol(Ruby runtime, ByteList bytes, RubySymbol.ObjBooleanConsumer<RubySymbol> handler)
static RubySymbol	newIDSymbol(Ruby runtime, ByteList bytes)	Generic identifier symbol creation (or retrieval) method.
static RubySymbol	newIDSymbol(Ruby runtime, ByteList bytes, RubySymbol.ObjBooleanConsumer<RubySymbol> handler)	Generic identifier symbol creation (or retrieval) method that invokes a handler before storing new symbols.
static RubySymbol	newMethodSymbolFromCompound(Ruby runtime, String compoundName)
static RubySymbol	newSymbol(Ruby runtime, String name)
static RubySymbol	newSymbol(Ruby runtime, String name, org.jcodings.Encoding encoding)
static RubySymbol	newSymbol(Ruby runtime, IRubyObject name)	Deprecated.
static RubySymbol	newSymbol(Ruby runtime, ByteList bytes)
static RubySymbol	newSymbol(Ruby runtime, ByteList bytes, RubySymbol.ObjBooleanConsumer<RubySymbol> handler)	Return the symbol in the symbol table if it exists, null otherwise.
static String	objectToSymbolString(IRubyObject object)	Properly stringify an object for the current "raw bytes" representation of a symbol.
IRubyObject	op_aref(ThreadContext context, IRubyObject arg)
IRubyObject	op_aref(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
IRubyObject	op_cmp(ThreadContext context, IRubyObject other)
IRubyObject	op_eqq(ThreadContext context, IRubyObject other)	rb_equal The Ruby "===" method is used by default in case/when statements.
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_match(ThreadContext context, IRubyObject other)	rb_obj_pattern_match call-seq: obj =~ other => nil Pattern Match---Overridden by descendents (notably Regexp and String) to provide meaningful pattern-match semantics.
static IRubyObject	prepareID(ThreadContext context, IRubyObject object)	Return the given object if it is a Symbol or String, or convert it to a String.
static RubySymbol	retrieveIDSymbol(IRubyObject name)	When we know we need an entry in the symbol table because the provided name will be needed to be accessed as a valid identifier later we can call this.
static RubySymbol	retrieveIDSymbol(IRubyObject name, RubySymbol.ObjBooleanConsumer<RubySymbol> handler)	Retrieve an ID symbol but call the handler to verify the symbol is valid.
void	setEncoding(org.jcodings.Encoding e)
boolean	shouldMarshalEncoding()
RubyClass	singletonClass(ThreadContext context)	Will either return the existing singleton class for this object, or create a new one and return that.
IRubyObject	start_with_p(ThreadContext context)
IRubyObject	start_with_p(ThreadContext context, IRubyObject arg)
IRubyObject	start_with_p(ThreadContext context, IRubyObject[] args)
IRubyObject	succ(ThreadContext context)
IRubyObject	swapcase(ThreadContext context)
IRubyObject	swapcase(ThreadContext context, IRubyObject arg)
IRubyObject	swapcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
static ByteList	symbolBytesFromString(Ruby runtime, String internedSymbol)
IRubyObject	taint(ThreadContext context)	Deprecated.
IRubyObject	to_proc(ThreadContext context)
IRubyObject	to_s(ThreadContext context)
IRubyObject	to_sym()
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
IRubyObject	toRefinedProc(ThreadContext context, StaticScope scope)
final String	toString()	Print a string for internal debugging purposes.
static RubySymbol	toSymbol(ThreadContext context, IRubyObject name)
static RubySymbol	unmarshalFrom(UnmarshalStream input, UnmarshalStream.MarshalState state)	Deprecated, for removal: This API element is subject to removal in a future version.
IRubyObject	upcase(ThreadContext context)
IRubyObject	upcase(ThreadContext context, IRubyObject arg)
IRubyObject	upcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
boolean	validAttrsetName()	Is the string this symbol represents a valid attribute setter name.
boolean	validClassVariableName()	Is the string this symbol represents a valid constant identifier name.
boolean	validConstantName()	Is the string this symbol represents a valid constant identifier name.
boolean	validInstanceVariableName()	Is the string this symbol represents a valid constant identifier name.
boolean	validLocalVariableName()

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize_copy, inspect, 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, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, 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, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

checkStringType19, dup, marshalLiveVariables

Field Details

symbolHashSeedK0

@Deprecated
public static final long symbolHashSeedK0

Deprecated.

See Also:

• Constant Field Values

Method Details

createSymbolClass

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

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

asJavaString

public final String asJavaString()

rb_to_id

Specified by:

asJavaString in interface IRubyObject

Overrides:

asJavaString in class RubyBasicObject

Returns:

a String representation of the symbol

idString

public String idString()

Return an id string (e.g. raw ISO-8859_1 charset String) for use with our method tables etc.

toString

public final String toString()

Print a string for internal debugging purposes. This does a half-hearted attempt at representing the string in a displayable fashion for for error messages you should use RubyStringBuilder.str + ids + types to build up the error message. For identifier strings you should use idString(). For non-identifier strings where you want a raw String you should use asJavaString().

Overrides:

toString in class RubyObject

Returns:

a String

getBytes

public final ByteList getBytes()

asWriter

public RubySymbol asWriter()

Make an instance variable out of this symbol (e.g. :foo will generate :foo=).

Returns:

the new symbol

asInstanceVariable

public RubySymbol asInstanceVariable()

retrieveIDSymbol

public static RubySymbol retrieveIDSymbol(IRubyObject name)

When we know we need an entry in the symbol table because the provided name will be needed to be accessed as a valid identifier later we can call this. If there is not already an entry we will return a new symbol. Otherwise, the existing entry.

Parameters:

name - to get symbol table entry for (it may be a symbol already)

Returns:

the symbol table entry.

retrieveIDSymbol

public static RubySymbol retrieveIDSymbol(IRubyObject name,
 RubySymbol.ObjBooleanConsumer<RubySymbol> handler)

Retrieve an ID symbol but call the handler to verify the symbol is valid.

Parameters:

name - to get symbol table entry for (it may be a symbol already)

Returns:

the symbol table entry.

associateEncoding

public void associateEncoding(org.jcodings.Encoding encoding)

RubySymbol is created by passing in a String and bytes are extracted from that. We will pass in encoding of that string after construction but before use so it does not forget what it is.

eql

public final boolean eql(IRubyObject other)

short circuit for Symbol key comparison

Specified by:

eql in interface IRubyObject

Overrides:

eql in class RubyBasicObject

Returns:

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

validConstantName

public boolean validConstantName()

Is the string this symbol represents a valid constant identifier name.

validInstanceVariableName

public boolean validInstanceVariableName()

Is the string this symbol represents a valid constant identifier name.

validClassVariableName

public boolean validClassVariableName()

Is the string this symbol represents a valid constant identifier name.

validAttrsetName

public boolean validAttrsetName()

Is the string this symbol represents a valid attribute setter name.

validLocalVariableName

public boolean validLocalVariableName()

isImmediate

public boolean isImmediate()

Description copied from class: RubyBasicObject

Is object immediate (def: Fixnum, Symbol, true, false, nil?).

Specified by:

isImmediate in interface IRubyObject

Overrides:

isImmediate in class RubyBasicObject

Returns:

boolean

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

getSymbolLong

public static RubySymbol getSymbolLong(Ruby runtime,
 long id)

newSymbol

@Deprecated
public static RubySymbol newSymbol(Ruby runtime,
 IRubyObject name)

Deprecated.

newHardSymbol

public static RubySymbol newHardSymbol(Ruby runtime,
 IRubyObject name)

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
 String name)

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
 ByteList bytes)

newHardSymbol

public static RubySymbol newHardSymbol(Ruby runtime,
 ByteList bytes)

newHardSymbol

public static RubySymbol newHardSymbol(Ruby runtime,
 ByteList bytes,
 RubySymbol.ObjBooleanConsumer<RubySymbol> handler)

newHardSymbol

public static RubySymbol newHardSymbol(Ruby runtime,
 String name)

newMethodSymbolFromCompound

public static RubySymbol newMethodSymbolFromCompound(Ruby runtime,
 String compoundName)

newCalleeSymbolFromCompound

public static RubySymbol newCalleeSymbolFromCompound(Ruby runtime,
 String compoundName)

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
 ByteList bytes,
 RubySymbol.ObjBooleanConsumer<RubySymbol> handler)

Return the symbol in the symbol table if it exists, null otherwise. This method will not create the symbol if it does not exist.

Parameters:

runtime -

bytes -

Returns:

newIDSymbol

public static RubySymbol newIDSymbol(Ruby runtime,
 ByteList bytes)

Generic identifier symbol creation (or retrieval) method.

Parameters:

runtime - of this Ruby instance.

bytes - to be made into a symbol (or to help retreive existing symbol)

Returns:

a new or existing symbol

newIDSymbol

public static RubySymbol newIDSymbol(Ruby runtime,
 ByteList bytes,
 RubySymbol.ObjBooleanConsumer<RubySymbol> handler)

Generic identifier symbol creation (or retrieval) method that invokes a handler before storing new symbols.

Parameters:

runtime - of this Ruby instance.

bytes - to be made into a symbol (or to help retreive existing symbol)

Returns:

a new or existing symbol

newConstantSymbol

@Deprecated(since="10.0")
public static RubySymbol newConstantSymbol(Ruby runtime,
 IRubyObject fqn,
 ByteList bytes)

Deprecated.

newConstantSymbol

public static RubySymbol newConstantSymbol(ThreadContext context,
 IRubyObject fqn,
 ByteList bytes)

Create a symbol whose intention is to be used as a constant. This will not only guarantee a symbol entry in the table but it will also verify the symbol conforms as a valid constant identifier.

Parameters:

context - the current thread context

fqn - if this constant symbol is part of a broader chain this is used for full name error reporting.

bytes - to be made into a symbol (or to help retreive existing symbol)

Returns:

a new or existing symbol

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
 String name,
 org.jcodings.Encoding encoding)

newHardSymbol

public static RubySymbol newHardSymbol(Ruby runtime,
 String name,
 org.jcodings.Encoding encoding)

toSymbol

public static RubySymbol toSymbol(ThreadContext context,
 IRubyObject name)

constant

public Object constant()

Specified by:

constant in interface Constantizable

See Also:

• Constantizable

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

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

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

to_s

public IRubyObject to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

name

public IRubyObject name(ThreadContext context)

id2name

@Deprecated(since="9.4-")
public IRubyObject id2name()

Deprecated.

id2name

public IRubyObject id2name(ThreadContext context)

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, RubyBasicObject.anyToString() is used instead.

Specified by:

asString in interface IRubyObject

Overrides:

asString in class RubyBasicObject

Returns:

string representation

fstring

public RubyString fstring()

op_eqq

public IRubyObject op_eqq(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyObject

rb_equal The Ruby "===" method is used by default in case/when statements. The Object implementation first checks Java identity equality and then calls the "==" method too.

Specified by:

op_eqq in interface IRubyObject

Overrides:

op_eqq in class RubyObject

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

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()

getId

public int getId()

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)

compareTo

public int compareTo(IRubyObject that)

Description copied from class: RubyBasicObject

Compares this Ruby object with another.

Specified by:

compareTo in interface Comparable<IRubyObject>

Overrides:

compareTo in class RubyBasicObject

Parameters:

that - another IRubyObject

Returns:

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

See Also:

• RubyBasicObject.compareTo(IRubyObject)

to_sym

public IRubyObject to_sym()

succ

public IRubyObject succ(ThreadContext context)

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject other)

Overrides:

op_cmp in class RubyBasicObject

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)

Description copied from class: RubyBasicObject

rb_obj_pattern_match call-seq: obj =~ other => nil Pattern Match---Overridden by descendents (notably Regexp and String) to provide meaningful pattern-match semantics.

Overrides:

op_match in class RubyBasicObject

Parameters:

context - the thread context

other - arg

Returns:

true if matches (always nil)

match_m

public IRubyObject match_m(ThreadContext context,
 IRubyObject other,
 Block block)

match_m

public IRubyObject match_m(ThreadContext context,
 IRubyObject other,
 IRubyObject pos,
 Block block)

match_m

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

match_p

public IRubyObject match_p(ThreadContext context,
 IRubyObject other)

match_p

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

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject arg)

op_aref

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

length

@Deprecated(since="10.0")
public IRubyObject length()

Deprecated.

Use length(ThreadContext) instead.

Returns:

""

length

public IRubyObject length(ThreadContext context)

empty_p

public IRubyObject empty_p(ThreadContext context)

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)

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)

upcase

public IRubyObject upcase(ThreadContext context)

upcase

public IRubyObject upcase(ThreadContext context,
 IRubyObject arg)

upcase

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

downcase

public IRubyObject downcase(ThreadContext context)

downcase

public IRubyObject downcase(ThreadContext context,
 IRubyObject arg)

downcase

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

swapcase

public IRubyObject swapcase(ThreadContext context)

swapcase

public IRubyObject swapcase(ThreadContext context,
 IRubyObject arg)

swapcase

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

capitalize

public IRubyObject capitalize(ThreadContext context)

capitalize

public IRubyObject capitalize(ThreadContext context,
 IRubyObject arg)

capitalize

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

encoding

public IRubyObject encoding(ThreadContext context)

to_proc

public IRubyObject to_proc(ThreadContext context)

toRefinedProc

public IRubyObject toRefinedProc(ThreadContext context,
 StaticScope scope)

all_symbols

public static IRubyObject all_symbols(ThreadContext context,
 IRubyObject recv)

all_symbols

@Deprecated
public static IRubyObject all_symbols(IRubyObject recv)

Deprecated.

unmarshalFrom

@Deprecated(since="10.0",
            forRemoval=true)
public static RubySymbol unmarshalFrom(UnmarshalStream input,
 UnmarshalStream.MarshalState state)
                                throws IOException

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

Throws:

IOException

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>)

symbolBytesFromString

public static ByteList symbolBytesFromString(Ruby runtime,
 String internedSymbol)

getEncoding

public org.jcodings.Encoding getEncoding()

Specified by:

getEncoding in interface EncodingCapable

setEncoding

public void setEncoding(org.jcodings.Encoding e)

Specified by:

setEncoding in interface EncodingCapable

javaStringHashCode

public static int javaStringHashCode(ByteList iso8859)

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

shouldMarshalEncoding

public boolean shouldMarshalEncoding()

Specified by:

shouldMarshalEncoding in interface MarshalEncoding

getMarshalEncoding

public org.jcodings.Encoding getMarshalEncoding()

Specified by:

getMarshalEncoding in interface MarshalEncoding

objectToSymbolString

public static String objectToSymbolString(IRubyObject object)

Properly stringify an object for the current "raw bytes" representation of a symbol. Symbols are represented internally as a Java string, but decoded using raw bytes in ISO-8859-1 representation. This means they do not in their normal String form represent a readable Java string, but it does allow differently-encoded strings to map to different symbol objects. See #736

Parameters:

object - the object to symbolify

Returns:

the symbol string associated with the object's string representation

checkID

@Deprecated
public static String checkID(IRubyObject object)

Deprecated.

idStringFromObject

public static String idStringFromObject(ThreadContext context,
 IRubyObject object)

idSymbolFromObject

public static RubySymbol idSymbolFromObject(ThreadContext context,
 IRubyObject object)

prepareID

public static IRubyObject prepareID(ThreadContext context,
 IRubyObject object)

Return the given object if it is a Symbol or String, or convert it to a String. MRI: string_for_symbol

Parameters:

context - the current context

object - the object

Returns:

the object, if it is a Symbol or String, or a String produced by calling #to_str on the object.

appendIntoString

public void appendIntoString(RubyString target)

Specified by:

appendIntoString in interface Appendable

taint

@Deprecated
public IRubyObject taint(ThreadContext context)

Deprecated.

Overrides:

taint in class RubyBasicObject