org.jruby.ext.jruby

Class JRubyUtilLibrary

java.lang.Object

org.jruby.ext.jruby.JRubyUtilLibrary

All Implemented Interfaces:

Library

public class JRubyUtilLibrary
extends java.lang.Object
implements Library

Utilities library for all those methods that don't need the full 'java' library to be loaded. This is done mostly for performance reasons. For example, for those who only need to enable the object space, not loading 'java' might save 200-300ms of startup time, like in case of jirb.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JRubyUtilLibrary.StringUtils Deprecated.

Field Summary

Fields inherited from interface org.jruby.runtime.load.Library

DUMMY

Constructor Summary

Constructors

Constructor and Description
JRubyUtilLibrary()

Method Summary

Modifier and Type	Method and Description
static IRubyObject	cache_stats(ThreadContext context, IRubyObject self) Provide stats on how many method and constant invalidations have occurred globally.
static IRubyObject	class_loader_resources(ThreadContext context, IRubyObject recv, IRubyObject... args)
static IRubyObject	classpath_launcher(ThreadContext context, IRubyObject recv)
static IRubyObject	current_directory(ThreadContext context, IRubyObject recv)
static IRubyObject	extra_gem_paths(ThreadContext context, IRubyObject recv)
static IRubyObject	gc(ThreadContext context, IRubyObject recv)
static IRubyObject	getClassLoaderResources(IRubyObject recv, IRubyObject name) Deprecated.
static IRubyObject	getObjectSpaceEnabled(IRubyObject recv)
static RubyArray	internal_libraries(ThreadContext context, IRubyObject self) Deprecated.
static IRubyObject	load_ext(ThreadContext context, IRubyObject recv, IRubyObject klass) Preffered way to boot-up JRuby extensions (available as >JRuby.load_ext).
static IRubyObject	load_java_class(ThreadContext context, IRubyObject recv, IRubyObject name) Loads a (Java) class.
void	load(Ruby runtime, boolean wrap)
static IRubyObject	native_posix_p(ThreadContext context, IRubyObject self)
static IRubyObject	notify(ThreadContext context, IRubyObject recv, IRubyObject arg) Notify one waiter on a locked object, as in Object Object.notify() The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.
static IRubyObject	notifyAll(ThreadContext context, IRubyObject recv, IRubyObject arg) Notify all waiters on a locked object, as in Object Object.notifyAll() The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.
static IRubyObject	rbSynchronized(ThreadContext context, IRubyObject recv, IRubyObject arg, Block block) Invoke the given block under synchronized lock, using standard Java synchronization.
static IRubyObject	set_last_exit_status(ThreadContext context, IRubyObject recv, IRubyObject status, IRubyObject pid)
static IRubyObject	set_meta_class(ThreadContext context, IRubyObject recv, IRubyObject obj, IRubyObject klass)
static IRubyObject	setObjectSpaceEnabled(IRubyObject recv, IRubyObject arg)
static IRubyObject	wait(ThreadContext context, IRubyObject recv, IRubyObject arg) Wait for a locked object to notify, as in Object Object.wait().
static IRubyObject	wait(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject timeoutMillis) Wait for a locked object to notify, as in Object Object.wait(long).
static IRubyObject	wait(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject timeoutMillis, IRubyObject timeoutNanos) Wait for a locked object to notify, as in Object Object.wait(long, int).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JRubyUtilLibrary

public JRubyUtilLibrary()

Method Detail

load

public void load(Ruby runtime,
                 boolean wrap)

Specified by:

load in interface Library

gc

public static IRubyObject gc(ThreadContext context,
                             IRubyObject recv)

getObjectSpaceEnabled

public static IRubyObject getObjectSpaceEnabled(IRubyObject recv)

setObjectSpaceEnabled

public static IRubyObject setObjectSpaceEnabled(IRubyObject recv,
                                                IRubyObject arg)

native_posix_p

public static IRubyObject native_posix_p(ThreadContext context,
                                         IRubyObject self)

getClassLoaderResources

@Deprecated
public static IRubyObject getClassLoaderResources(IRubyObject recv,
                                                              IRubyObject name)

Deprecated.

load_java_class

public static IRubyObject load_java_class(ThreadContext context,
                                          IRubyObject recv,
                                          IRubyObject name)

Loads a (Java) class.

Parameters:

context -

recv -

name - the class name

Returns:

Java class (wrapper) or raises a NameError if loading fails or class is not found

class_loader_resources

public static IRubyObject class_loader_resources(ThreadContext context,
                                                 IRubyObject recv,
                                                 IRubyObject... args)

Parameters:

context -

recv -

args - (name, raw: false, path: false)

Returns:

an enumerable of class-loader resources

classpath_launcher

public static IRubyObject classpath_launcher(ThreadContext context,
                                             IRubyObject recv)

extra_gem_paths

public static IRubyObject extra_gem_paths(ThreadContext context,
                                          IRubyObject recv)

current_directory

public static IRubyObject current_directory(ThreadContext context,
                                            IRubyObject recv)

set_last_exit_status

public static IRubyObject set_last_exit_status(ThreadContext context,
                                               IRubyObject recv,
                                               IRubyObject status,
                                               IRubyObject pid)

set_meta_class

public static IRubyObject set_meta_class(ThreadContext context,
                                         IRubyObject recv,
                                         IRubyObject obj,
                                         IRubyObject klass)

load_ext

public static IRubyObject load_ext(ThreadContext context,
                                   IRubyObject recv,
                                   IRubyObject klass)

Preffered way to boot-up JRuby extensions (available as >JRuby.load_ext).

Parameters:

context -

recv -

klass -

Returns:

loading outcome

rbSynchronized

public static IRubyObject rbSynchronized(ThreadContext context,
                                         IRubyObject recv,
                                         IRubyObject arg,
                                         Block block)

Invoke the given block under synchronized lock, using standard Java synchronization.

Parameters:

context - the current context

recv - the JRuby module

arg - the object against which to synchronize

block - the block to execute

Returns:

the return value of the block

wait

public static IRubyObject wait(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject arg)
                        throws java.lang.InterruptedException

Wait for a locked object to notify, as in Object Object.wait().

Parameters:

context - the current context

recv - the JRuby module

arg - the object to wait for

Returns:

the object given

Throws:

java.lang.InterruptedException - if interrupted

wait

public static IRubyObject wait(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject arg,
                               IRubyObject timeoutMillis)
                        throws java.lang.InterruptedException

Wait for a locked object to notify, as in Object Object.wait(long). The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.

Parameters:

context - the current context

recv - the JRuby module

arg - the object to wait for

timeoutMillis - the time in millis to wait (converted using #to_int)

Returns:

the object given

Throws:

java.lang.InterruptedException - if interrupted

wait

public static IRubyObject wait(ThreadContext context,
                               IRubyObject recv,
                               IRubyObject arg,
                               IRubyObject timeoutMillis,
                               IRubyObject timeoutNanos)
                        throws java.lang.InterruptedException

Wait for a locked object to notify, as in Object Object.wait(long, int). The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.

Parameters:

context - the current context

recv - the JRuby module

arg - the object to wait for

timeoutMillis - the time in millis to wait (converted using #to_int)

timeoutNanos - the time in nanos to wait (converted using #to_int, and truncated to a signed 32-bit integer)

Returns:

the object given

Throws:

java.lang.InterruptedException - if interrupted

notify

public static IRubyObject notify(ThreadContext context,
                                 IRubyObject recv,
                                 IRubyObject arg)

Notify one waiter on a locked object, as in Object Object.notify() The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.

Parameters:

context - the current context

recv - the JRuby module

arg - the object to notify

Returns:

the object given

notifyAll

public static IRubyObject notifyAll(ThreadContext context,
                                    IRubyObject recv,
                                    IRubyObject arg)

Notify all waiters on a locked object, as in Object Object.notifyAll() The object given must be locked using JRuby.synchronized or a similar Java monitor-based locking mechanism.

Parameters:

context - the current context

recv - the JRuby module

arg - the object to notify

Returns:

the object given

cache_stats

public static IRubyObject cache_stats(ThreadContext context,
                                      IRubyObject self)

Provide stats on how many method and constant invalidations have occurred globally. This was added for Pry in https://github.com/jruby/jruby/issues/4384

internal_libraries

@Deprecated
public static RubyArray internal_libraries(ThreadContext context,
                                                       IRubyObject self)

Deprecated.

Return a list of files and extensions that JRuby treats as internal (or "built-in"), skipping load path and filesystem search. This was added for Bootsnap in https://github.com/Shopify/bootsnap/issues/162