Package org.jruby

Class RubySymbol

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubySymbol

All Implemented Interfaces:

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

public class RubySymbol
extends RubyObject
implements MarshalEncoding, EncodingCapable, Constantizable

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>
private 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
private Object	constant
private String	decodedString
private final int	hashCode
private final int	id
private final String	symbol
private final ByteList	symbolBytes
static final long	symbolHashSeedK0	Deprecated.
private SymbolNameType	type

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

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

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

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RubySymbol(Ruby runtime, String internedSymbol)
private	RubySymbol(Ruby runtime, String internedSymbol, ByteList symbolBytes)

Method Summary

Modifier and Type	Method	Description
static IRubyObject	all_symbols(IRubyObject recv)	Deprecated.
static IRubyObject	all_symbols(ThreadContext context, IRubyObject recv)
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, infects it with the current taint 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)
int	compareTo(IRubyObject that)	Compares this Ruby object with another.
Object	constant()
static RubyClass	createSymbolClass(Ruby runtime)
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)
final boolean	eql(IRubyObject other)	short circuit for Symbol key comparison
boolean	equals(Object other)	This override does not do a "checked" dispatch.
final ByteList	getBytes()
org.jcodings.Encoding	getEncoding()
int	getId()
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.
RubyClass	getSingletonClass()	rb_singleton_class Note: this method is specialized for RubyFixnum, RubySymbol, RubyNil and RubyBoolean Will either return the existing singleton class for this object, or create a new one and return that.
static RubySymbol	getSymbolLong(Ruby runtime, long id)
RubyFixnum	hash()	Deprecated.
RubyFixnum	hash(ThreadContext context)
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
IRubyObject	id2name()
IRubyObject	id2name(ThreadContext context)
String	idString()	Return an id string (e.g.
IRubyObject	inspect()	rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
(package private) final RubyString	inspect(Ruby runtime)
IRubyObject	inspect(ThreadContext context)
IRubyObject	inspect19(ThreadContext context)	Deprecated.
private static boolean	isIdentChar(char c)
private static boolean	isIdentifier(String s)
private static boolean	isIdentStart(char c)
boolean	isImmediate()	Is object immediate (def: Fixnum, Symbol, true, false, nil?).
private boolean	isPrintable(Ruby runtime)
private static boolean	isSpecialGlobalName(String s)	is_special_global_name from parse.c.
private static boolean	isSymbolLocal(String str, char first, int length)
private static boolean	isSymbolName(String str)
private static boolean	isSymbolNameCommon(String str, char first, int length)
private static int	javaStringHashCode(String str)
static int	javaStringHashCode(ByteList iso8859)
IRubyObject	length()
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)
static RubySymbol	newConstantSymbol(Ruby runtime, 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.
private RubyString	newShared(Ruby runtime)
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 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 before any new symbol is added to the symbol table.
void	setEncoding(org.jcodings.Encoding e)
boolean	shouldMarshalEncoding()
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)	rb_obj_taint call-seq: obj.taint -> obj Marks obj as tainted---if the $SAFE level is set appropriately, many method calls which might alter the running programs environment will refuse to accept tainted strings.
IRubyObject	to_proc(ThreadContext context)
IRubyObject	to_s()	rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
(package private) final RubyString	to_s(Ruby runtime)
IRubyObject	to_s(ThreadContext context)
IRubyObject	to_sym()
IRubyObject	to_sym19()	Deprecated.
<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	unmarshalFrom(UnmarshalStream input, UnmarshalStream.MarshalState state)
IRubyObject	upcase(ThreadContext context)
IRubyObject	upcase(ThreadContext context, IRubyObject arg)
IRubyObject	upcase(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
boolean	validClassVariableName()	Is the string this constant represents a valid constant identifier name.
boolean	validConstantName()	Is the string this constant represents a valid constant identifier name.
boolean	validInstanceVariableName()	Is the string this constant 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, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, inspect, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

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

Methods inherited from class java.lang.Object

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

Field Details

symbolHashSeedK0

@Deprecated
public static final long symbolHashSeedK0

Deprecated.

See Also:

• Constant Field Values

symbol

private final String symbol

id

private final int id

symbolBytes

private final ByteList symbolBytes

hashCode

private final int hashCode

decodedString

private String decodedString

constant

private transient Object constant

type

private SymbolNameType type

Constructor Details

RubySymbol

private RubySymbol(Ruby runtime,
 String internedSymbol,
 ByteList symbolBytes)

Parameters:

runtime -

internedSymbol - the String value of the new Symbol. This must have been previously interned

symbolBytes - the ByteList of the symbol's string representation

RubySymbol

private RubySymbol(Ruby runtime,
 String internedSymbol)

Method Details

createSymbolClass

public static RubyClass createSymbolClass(Ruby runtime)

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

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

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

• ClassIndex

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 before any new symbol is added to the symbol table. This can be used for verifying 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

validConstantName

public boolean validConstantName()

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

validInstanceVariableName

public boolean validInstanceVariableName()

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

validClassVariableName

public boolean validClassVariableName()

Is the string this constant represents a valid constant identifier 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:

getSingletonClass

public RubyClass getSingletonClass()

Description copied from class: RubyBasicObject

rb_singleton_class Note: this method is specialized for RubyFixnum, RubySymbol, RubyNil and RubyBoolean Will either return the existing singleton class for this object, or create a new one and return that.

Specified by:

getSingletonClass in interface IRubyObject

Overrides:

getSingletonClass in class RubyBasicObject

Returns:

the Ruby singleton class

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)

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

public static RubySymbol newConstantSymbol(Ruby runtime,
 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:

runtime - of this Ruby instance.

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)

constant

public Object constant()

Specified by:

constant in interface Constantizable

See Also:

• Constantizable

inspect

public IRubyObject inspect()

Description copied from class: RubyBasicObject

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

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

inspect

public IRubyObject inspect(ThreadContext context)

inspect

final RubyString inspect(Ruby runtime)

inspect19

@Deprecated
public IRubyObject inspect19(ThreadContext context)

Deprecated.

to_s

public IRubyObject to_s()

Description copied from class: RubyBasicObject

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main.''

Overrides:

to_s in class RubyBasicObject

to_s

public IRubyObject to_s(ThreadContext context)

to_s

final RubyString to_s(Ruby runtime)

id2name

public IRubyObject id2name()

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, infects it with the current taint 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:

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

@Deprecated
public RubyFixnum hash()

Deprecated.

Description copied from class: RubyBasicObject

rb_obj_id 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

hash

public RubyFixnum hash(ThreadContext context)

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

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

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

to_sym19

@Deprecated
public IRubyObject to_sym19()

Deprecated.

taint

public IRubyObject taint(ThreadContext context)

Description copied from class: RubyBasicObject

rb_obj_taint call-seq: obj.taint -> obj Marks obj as tainted---if the $SAFE level is set appropriately, many method calls which might alter the running programs environment will refuse to accept tainted strings.

Overrides:

taint in class RubyBasicObject

newShared

private RubyString newShared(Ruby runtime)

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

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

public IRubyObject length()

empty_p

public IRubyObject empty_p(ThreadContext context)

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)

isIdentStart

private static boolean isIdentStart(char c)

isIdentChar

private static boolean isIdentChar(char c)

isIdentifier

private static boolean isIdentifier(String s)

isSpecialGlobalName

private static boolean isSpecialGlobalName(String s)

is_special_global_name from parse.c.

Parameters:

s -

Returns:

isPrintable

private boolean isPrintable(Ruby runtime)

isSymbolName

private static boolean isSymbolName(String str)

isSymbolNameCommon

private static boolean isSymbolNameCommon(String str,
 char first,
 int length)

isSymbolLocal

private static boolean isSymbolLocal(String str,
 char first,
 int length)

all_symbols

public static IRubyObject all_symbols(ThreadContext context,
 IRubyObject recv)

all_symbols

@Deprecated
public static IRubyObject all_symbols(IRubyObject recv)

Deprecated.

unmarshalFrom

public static RubySymbol unmarshalFrom(UnmarshalStream input,
 UnmarshalStream.MarshalState state)
                                throws IOException

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

Parameters:

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

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

private static int javaStringHashCode(String str)

javaStringHashCode

public static int javaStringHashCode(ByteList iso8859)

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