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

public class RubySymbol
extends RubyObject
implements MarshalEncoding, Constantizable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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 and Description
static long	symbolHashSeedK0

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_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

Method Summary

Methods

Modifier and Type	Method and Description
static IRubyObject	all_symbols(IRubyObject recv) Deprecated.
static IRubyObject	all_symbols(ThreadContext context, IRubyObject recv)
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.
IRubyObject	capitalize(ThreadContext context)
IRubyObject	casecmp(ThreadContext context, IRubyObject other)
Object	constant()
static RubyClass	createSymbolClass(Ruby runtime)
IRubyObject	downcase(ThreadContext context)
IRubyObject	empty_p(ThreadContext context)
IRubyObject	encoding(ThreadContext context)
boolean	eql(IRubyObject other) short circuit for Symbol key comparison
boolean	equals(Object other) This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.
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() Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects.
IRubyObject	id2name()
IRubyObject	id2name(ThreadContext context)
IRubyObject	inspect() Deprecated.
IRubyObject	inspect(ThreadContext context)
IRubyObject	inspect19(ThreadContext context)
boolean	isImmediate() Is object immediate (def: Fixnum, Symbol, true, false, nil?).
IRubyObject	length()
static RubySymbol	newSymbol(Ruby runtime, IRubyObject name)
static RubySymbol	newSymbol(Ruby runtime, String name)
static RubySymbol	newSymbol(Ruby runtime, String name, org.jcodings.Encoding encoding)
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)
IRubyObject	op_match19(ThreadContext context, IRubyObject other)
boolean	shouldMarshalEncoding()
IRubyObject	succ(ThreadContext context)
IRubyObject	swapcase(ThreadContext context)
static org.jruby.util.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.
IRubyObject	to_s(ThreadContext context)
IRubyObject	to_sym()
IRubyObject	to_sym19()
Object	toJava(Class 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.
static RubySymbol	unmarshalFrom(UnmarshalStream input)
IRubyObject	upcase(ThreadContext context)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, initialize, initialize, inspect, puts, specificEval

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, 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, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, OBJ_INIT_COPY, objInitCopy, op_equal_19, op_match, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, tainted_p, testFrozen, testFrozen, to_a, trust, type_deprecated, type, untaint, untrust, untrusted_p, 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 Detail

symbolHashSeedK0

public static final long symbolHashSeedK0

See Also:

Constant Field Values

Method Detail

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

rb_to_id

Specified by:

asJavaString in interface IRubyObject

Overrides:

asJavaString in class RubyBasicObject

Returns:

a String representation of the symbol

toString

public String toString()

Description copied from class: RubyObject

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

Overrides:

toString in class RubyObject

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

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:

RubyClass

getSymbolLong

public static RubySymbol getSymbolLong(Ruby runtime,
                       long id)

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
                   IRubyObject name)

newSymbol

public static RubySymbol newSymbol(Ruby runtime,
                   String name)

newSymbol

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

constant

public Object constant()

Specified by:

constant in interface Constantizable

See Also:

Constantizable

inspect

@Deprecated
public IRubyObject inspect()

Deprecated.

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)

inspect19

public IRubyObject inspect19(ThreadContext context)

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)

id2name

public IRubyObject id2name()

id2name

public IRubyObject id2name(ThreadContext context)

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)

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

Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects. If the Ruby "hash" method doesn't return a number, the Object#hashCode implementation will be used instead.

Overrides:

hashCode in class RubyObject

getId

public int getId()

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.

Overrides:

equals in class RubyObject

to_sym

public IRubyObject to_sym()

to_sym19

public IRubyObject to_sym19()

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

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)

op_match19

public IRubyObject op_match19(ThreadContext context,
                     IRubyObject other)

Overrides:

op_match19 in class RubyBasicObject

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)

downcase

public IRubyObject downcase(ThreadContext context)

capitalize

public IRubyObject capitalize(ThreadContext context)

swapcase

public IRubyObject swapcase(ThreadContext context)

encoding

public IRubyObject encoding(ThreadContext context)

to_proc

public IRubyObject to_proc(ThreadContext context)

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

Throws:

IOException

toJava

public Object toJava(Class 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)

symbolBytesFromString

public static org.jruby.util.ByteList symbolBytesFromString(Ruby runtime,
                                            String internedSymbol)

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