Top Description Inners Fields Constructors Methods
org.jruby

public Class RubySymbol

extends RubyObject
implements MarshalEncoding, EncodingCapable, Constantizable
Class Inheritance
All Implemented Interfaces
org.jruby.compiler.Constantizable, org.jruby.runtime.encoding.EncodingCapable, org.jruby.runtime.encoding.MarshalEncoding
Annotations
@JRubyClass
name:Symbol
include:Enumerable
Imports
org.jcodings.Encoding, org.jcodings.specific.ASCIIEncoding, .USASCIIEncoding, org.jruby.anno.JRubyClass, .JRubyMethod, org.jruby.ast.util.ArgsUtil, org.jruby.compiler.Constantizable, org.jruby.parser.StaticScope, org.jruby.runtime.ArgumentDescriptor, .Block, .BlockBody, .CallSite, .CallType, .ClassIndex, .ContextAwareBlockBody, .Helpers, .MethodIndex, .ObjectAllocator, .Signature, .ThreadContext, org.jruby.runtime.builtin.IRubyObject, org.jruby.runtime.callsite.RefinedCachingCallSite, org.jruby.runtime.encoding.EncodingCapable, .MarshalEncoding, org.jruby.runtime.marshal.UnmarshalStream, org.jruby.runtime.opto.OptoFactory, org.jruby.util.ByteList, .IdUtil, .PerlHash, .SipHashInline, .SymbolNameType, .TypeConverter, java.lang.ref.WeakReference, java.util.concurrent.locks.ReentrantLock
Represents a Ruby symbol (e.g. :bar)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
RubySymbol.ObjBooleanConsumer<T>

public static class
RubySymbol.SymbolProcBody

public static class
RubySymbol.SymbolTable

Field Summary

Modifier and TypeField and Description
private transient Object
constant

private String
decodedString

private final int
hashCode

private final int
id

private RubyString
rubyString

private final String
symbol

private final ByteList
symbolBytes

public static final long
symbolHashSeedK0

Deprecated
private SymbolNameType
type

Inherited from org.jruby.RubyObject:
IVAR_INSPECTING_OBJECT_ALLOCATOROBJECT_ALLOCATORREIFYING_OBJECT_ALLOCATOR

Constructor Summary

AccessConstructor and Description
private
RubySymbol(Ruby runtime, String
the String value of the new Symbol. This must have been previously interned
internedSymbol, ByteList
the ByteList of the symbol's string representation
symbolBytes)

private
RubySymbol(Ruby runtime, String internedSymbol)

Method Summary

Modifier and TypeMethod and Description
public static IRubyObject
all_symbols(ThreadContext context, IRubyObject recv)

public static IRubyObject
all_symbols(IRubyObject recv)
Deprecated

public RubySymbol
asInstanceVariable()

public final String

Returns:

a String representation of the symbol
asJavaString()

Overrides org.jruby.RubyBasicObject.asJavaString.

Implements org.jruby.runtime.builtin.IRubyObject.asJavaString.

rb_to_id

public void
associateEncoding(Encoding encoding)

RubySymbol is created by passing in a String and bytes are extracted from that.

public RubyString
asString()

Overrides org.jruby.RubyBasicObject.asString.

Implements org.jruby.runtime.builtin.IRubyObject.asString.

rb_obj_as_string First converts this object into a String using the "to_s" method and returns it.

public RubySymbol

Returns:

the new symbol
asWriter()

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

public IRubyObject
capitalize(ThreadContext context)

public IRubyObject
capitalize(ThreadContext context, IRubyObject arg)

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

public IRubyObject
casecmp(ThreadContext context, IRubyObject other)

public IRubyObject
casecmp_p(ThreadContext context, IRubyObject other)

public static String
checkID(IRubyObject object)

public int
compareTo(final IRubyObject
another IRubyObject
that)

Overrides org.jruby.RubyBasicObject.compareTo.

Implements java.lang.Comparable.compareTo.

Compares this Ruby object with another.

public Object
constant()

Implements org.jruby.compiler.Constantizable.constant.

public static RubyClass
createSymbolClass(Ruby runtime)

public IRubyObject
downcase(ThreadContext context)

public IRubyObject
downcase(ThreadContext context, IRubyObject arg)

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

public IRubyObject
empty_p(ThreadContext context)

public IRubyObject
encoding(ThreadContext context)

public IRubyObject
end_with_p(ThreadContext context)

public IRubyObject
end_with_p(ThreadContext context, IRubyObject arg)

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

public final boolean
eql(IRubyObject other)

Overrides org.jruby.RubyBasicObject.eql.

Implements org.jruby.runtime.builtin.IRubyObject.eql.

short circuit for Symbol key comparison

public boolean
equals(Object
the reference object with which to compare.
other)

Overrides org.jruby.RubyObject.equals.

This override does not do a "checked" dispatch.

public final ByteList
getBytes()

public Encoding
getEncoding()

Implements org.jruby.runtime.encoding.EncodingCapable.getEncoding.

public int
getId()

public Class<T>
getJavaClass()

Overrides org.jruby.RubyBasicObject.getJavaClass.

Implements org.jruby.runtime.builtin.IRubyObject.getJavaClass.

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

public Encoding
getMarshalEncoding()

Implements org.jruby.runtime.encoding.MarshalEncoding.getMarshalEncoding.

public ClassIndex
getNativeClassIndex()

Overrides org.jruby.RubyObject.getNativeClassIndex.

Implements org.jruby.runtime.marshal.CoreObjectType.getNativeClassIndex.

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.

public RubyClass
getSingletonClass()

Overrides org.jruby.RubyBasicObject.getSingletonClass.

Implements org.jruby.runtime.builtin.IRubyObject.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.

public static RubySymbol
getSymbolLong(Ruby runtime, long id)

public RubyFixnum
hash()

Overrides org.jruby.RubyBasicObject.hash.

Deprecated

rb_obj_id Will return the hash code of this object.

public RubyFixnum
hash(ThreadContext context)

public int
hashCode()

Overrides org.jruby.RubyObject.hashCode.

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

public IRubyObject
id2name()

public IRubyObject
id2name(ThreadContext context)

public String
idString()

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

public IRubyObject
inspect()

Overrides org.jruby.RubyBasicObject.inspect.

Implements org.jruby.runtime.builtin.IRubyObject.inspect.

rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.

public IRubyObject
inspect(ThreadContext context)

pack-priv final RubyString
inspect(final Ruby runtime)

public IRubyObject
inspect19(ThreadContext context)
Deprecated

private static boolean
isIdentChar(char c)

private static boolean
isIdentifier(String s)

private static boolean
isIdentStart(char c)

public boolean
isImmediate()

Overrides org.jruby.RubyBasicObject.isImmediate.

Implements org.jruby.runtime.builtin.IRubyObject.isImmediate.

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

private boolean
isPrintable(final Ruby runtime)

private static boolean
isSpecialGlobalName(String s)

is_special_global_name from parse.c.

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

private static boolean
isSymbolName(final String str)

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

private static int
javaStringHashCode(String str)

public static int
javaStringHashCode(ByteList iso8859)

public IRubyObject
length()

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

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

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

public IRubyObject
match_p(ThreadContext context, IRubyObject other)

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

public IRubyObject
name(ThreadContext context)

public static RubySymbol

Returns:

a new or existing symbol
newConstantSymbol(Ruby
of this Ruby instance.
runtime, IRubyObject
if this constant symbol is part of a broader chain this is used for full name error reporting.
fqn, ByteList
to be made into a symbol (or to help retreive existing symbol)
bytes)

Create a symbol whose intention is to be used as a constant.

public static RubySymbol
newHardSymbol(Ruby runtime, IRubyObject name)

public static RubySymbol
newHardSymbol(Ruby runtime, ByteList bytes)

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

public static RubySymbol
newHardSymbol(Ruby runtime, String name)

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

public static RubySymbol

Returns:

a new or existing symbol
newIDSymbol(Ruby
of this Ruby instance.
runtime, ByteList
to be made into a symbol (or to help retreive existing symbol)
bytes)

Generic identifier symbol creation (or retrieval) method.

public static RubySymbol

Returns:

a new or existing symbol
newIDSymbol(Ruby
of this Ruby instance.
runtime, ByteList
to be made into a symbol (or to help retreive existing symbol)
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)

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

public static RubySymbol
newSymbol(Ruby runtime, String name)

public static RubySymbol
newSymbol(Ruby runtime, ByteList bytes)

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

Return the symbol in the symbol table if it exists, null otherwise.

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

public static String

Returns:

the symbol string associated with the object's string representation
objectToSymbolString(IRubyObject
the object to symbolify
object)

Properly stringify an object for the current "raw bytes" representation of a symbol.

public IRubyObject
op_aref(ThreadContext context, IRubyObject arg)

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

public IRubyObject
op_cmp(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyBasicObject.op_cmp.

public IRubyObject
op_eqq(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyObject.op_eqq.

Implements org.jruby.runtime.builtin.IRubyObject.op_eqq.

rb_equal The Ruby "===" method is used by default in case/when statements.

public IRubyObject
op_equal(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyBasicObject.op_equal.

Implements org.jruby.runtime.builtin.IRubyObject.op_equal.

rb_obj_equal Will by default use identity equality to compare objects.

public IRubyObject
op_match(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyBasicObject.op_match.

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

public static RubySymbol

Returns:

the symbol table entry.
retrieveIDSymbol(IRubyObject
to get symbol table entry for (it may be a symbol already)
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.

public static RubySymbol

Returns:

the symbol table entry.
retrieveIDSymbol(IRubyObject
to get symbol table entry for (it may be a symbol already)
name, RubySymbol.ObjBooleanConsumer<RubySymbol> handler)

Retrieve an ID symbol but call the handler before any new symbol is added to the symbol table.

public void
setEncoding(Encoding e)

Implements org.jruby.runtime.encoding.EncodingCapable.setEncoding.

public boolean
shouldMarshalEncoding()

Implements org.jruby.runtime.encoding.MarshalEncoding.shouldMarshalEncoding.

public IRubyObject
start_with_p(ThreadContext context)

public IRubyObject
start_with_p(ThreadContext context, IRubyObject arg)

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

public IRubyObject
succ(ThreadContext context)

public IRubyObject
swapcase(ThreadContext context)

public IRubyObject
swapcase(ThreadContext context, IRubyObject arg)

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

public static ByteList
symbolBytesFromString(Ruby runtime, String internedSymbol)

public IRubyObject
taint(ThreadContext context)

Overrides org.jruby.RubyBasicObject.taint.

Deprecated

public IRubyObject
to_proc(ThreadContext context)

public IRubyObject
to_s()

Overrides org.jruby.RubyBasicObject.to_s.

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.

public IRubyObject
to_s(ThreadContext context)

pack-priv final RubyString
to_s(Ruby runtime)

public IRubyObject
to_sym()

public IRubyObject
to_sym19()
Deprecated

public <T> T
toJava(Class<T>
The target type to which the object should be converted.
target)

Overrides org.jruby.RubyBasicObject.toJava.

Implements org.jruby.runtime.builtin.IRubyObject.toJava.

Convert the object to the specified Java class, if possible.

public IRubyObject
toRefinedProc(ThreadContext context, StaticScope scope)

public final String

Returns:

a String
toString()

Overrides org.jruby.RubyObject.toString.

Print a string for internal debugging purposes.

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

public IRubyObject
upcase(ThreadContext context)

public IRubyObject
upcase(ThreadContext context, IRubyObject arg)

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

public boolean
validClassVariableName()

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

public boolean
validConstantName()

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

public boolean
validInstanceVariableName()

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

public boolean
validLocalVariableName()

Inherited from org.jruby.RubyObject:
attachToObjectSpacecallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitconvertToTypecreateObjectClassdigdig1dig2eqlInternalequalInternalinspectputsspecificEvaltoRubyString