Module org.jruby.base

Package org.jruby

Class RubyNil

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyNil

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Constantizable, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, SimpleHash

public class RubyNil
extends RubyObject
implements Constantizable, SimpleHash

See Also:

• Serialized Form

Nested Class Summary

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 int	ID

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, ERR_INSECURE_SET_INST_VAR, FALSE_F, flags, FROZEN_F, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyNil(Ruby runtime, RubyClass Nil)

Method Summary

Modifier and Type	Method	Description
RubyInteger	__id__(ThreadContext context)	rb_obj_id Return the internal id of an object.
Object	constant()
static void	finishNilClass(ThreadContext context, RubyClass Nil)
Class<?>	getJavaClass()	Will return the Java interface that most closely can represent this object, when working through Java integration translations.
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
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.
RubyFixnum	id()	Deprecated.
IRubyObject	inspect(ThreadContext context)	nil_inspect
boolean	isImmediate()	Is object immediate (def: Fixnum, Symbol, true, false, nil?).
RubyBoolean	nil_p(ThreadContext context)	rb_false call_seq: nil.nil? => true <anything_else>.nil? => false Only the object nil responds true to nil?.
static RubyBoolean	op_and(ThreadContext context, IRubyObject recv, IRubyObject obj)	nil_and
IRubyObject	op_match(ThreadContext context, IRubyObject arg)	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 RubyBoolean	op_or(ThreadContext context, IRubyObject recv, IRubyObject obj)	nil_or
static RubyBoolean	op_xor(ThreadContext context, IRubyObject recv, IRubyObject obj)	nil_xor
static IRubyObject	rationalize(ThreadContext context, IRubyObject recv, IRubyObject[] args)	nilclass_rationalize
RubyClass	singletonClass(ThreadContext context)	Will either return the existing singleton class for this object, or create a new one and return that.
IRubyObject	taint(ThreadContext context)	Deprecated.
static RubyArray	to_a(ThreadContext context, IRubyObject recv)	nil_to_a
static IRubyObject	to_c(ThreadContext context, IRubyObject recv)	nilclass_to_c
static RubyFloat	to_f(ThreadContext context, IRubyObject recv)	nil_to_f
static RubyHash	to_h(ThreadContext context, IRubyObject recv)
static RubyFixnum	to_i(ThreadContext context, IRubyObject recv)	nil_to_i
static IRubyObject	to_r(ThreadContext context, IRubyObject recv)	nilclass_to_r
static RubyString	to_s(ThreadContext context, IRubyObject recv)	nil_to_s
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableList, getVariableNameList, hash, hashyInspect, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, 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, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setTaint, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, to_s, type, untaint, validateInstanceVariable, variableTableContains, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

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

checkStringType19, dup, marshalLiveVariables

Methods inherited from interface org.jruby.runtime.SimpleHash

longHashCode

Field Details

ID

public static final int ID

See Also:

• Constant Field Values

Constructor Details

RubyNil

public RubyNil(Ruby runtime,
 RubyClass Nil)

Method Details

finishNilClass

public static void finishNilClass(ThreadContext context,
 RubyClass Nil)

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

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

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

constant

public Object constant()

Specified by:

constant in interface Constantizable

See Also:

• Constantizable

to_i

public static RubyFixnum to_i(ThreadContext context,
 IRubyObject recv)

nil_to_i

to_f

public static RubyFloat to_f(ThreadContext context,
 IRubyObject recv)

nil_to_f

to_s

public static RubyString to_s(ThreadContext context,
 IRubyObject recv)

nil_to_s

to_a

public static RubyArray to_a(ThreadContext context,
 IRubyObject recv)

nil_to_a

to_h

public static RubyHash to_h(ThreadContext context,
 IRubyObject recv)

inspect

public IRubyObject inspect(ThreadContext context)

nil_inspect

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

op_match

public IRubyObject op_match(ThreadContext context,
 IRubyObject arg)

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

arg - arg

Returns:

true if matches (always nil)

op_and

public static RubyBoolean op_and(ThreadContext context,
 IRubyObject recv,
 IRubyObject obj)

nil_and

op_or

public static RubyBoolean op_or(ThreadContext context,
 IRubyObject recv,
 IRubyObject obj)

nil_or

op_xor

public static RubyBoolean op_xor(ThreadContext context,
 IRubyObject recv,
 IRubyObject obj)

nil_xor

nil_p

public RubyBoolean nil_p(ThreadContext context)

Description copied from class: RubyBasicObject

rb_false call_seq: nil.nil? => true <anything_else>.nil? => false Only the object nil responds true to nil?.

Overrides:

nil_p in class RubyBasicObject

Parameters:

context - the thread context

Returns:

true if nil

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

id

@Deprecated(since="10.0.3.0")
public RubyFixnum id()

Deprecated.

Specified by:

id in interface IRubyObject

Overrides:

id in class RubyBasicObject

__id__

public RubyInteger __id__(ThreadContext context)

Description copied from class: RubyBasicObject

rb_obj_id Return the internal id of an object.

Specified by:

__id__ in interface IRubyObject

Overrides:

__id__ in class RubyBasicObject

Returns:

the object id

to_c

public static IRubyObject to_c(ThreadContext context,
 IRubyObject recv)

nilclass_to_c

to_r

public static IRubyObject to_r(ThreadContext context,
 IRubyObject recv)

nilclass_to_r

rationalize

public static IRubyObject rationalize(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

nilclass_rationalize

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

taint

@Deprecated(since="9.4.0.0")
public IRubyObject taint(ThreadContext context)

Deprecated.

Overrides:

taint in class RubyBasicObject