Top Constructors Methods
org.jruby.api

public Class Access

extends Object
Class Inheritance
Imports
org.jruby.RubyClass, .RubyInstanceConfig, .RubyModule, org.jruby.internal.runtime.GlobalVariables, org.jruby.runtime.ThreadContext, org.jruby.runtime.builtin.IRubyObject, org.jruby.runtime.encoding.EncodingService, org.jruby.runtime.load.LoadService

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static IRubyObject

Returns:

the instance
argsFile
(ThreadContext
the current thread context
context
)

Retrieve ARGF (RubyArgsFile) instance

public static RubyClass

Returns:

the Class
argumentErrorClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class ArgumentError

public static RubyClass

Returns:

the Class
arrayClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Array

public static RubyClass

Returns:

the Class
basicObjectClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class BasicObject

public static RubyClass

Returns:

the Class
classClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Class

public static RubyModule

Returns:

the Module
comparableModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module Comparable.

public static RubyClass

Returns:

the Class
dirClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Dir

public static EncodingService

Returns:

the object
encodingService
(ThreadContext
the current thread context
context
)

Retrieve the encoding service object

public static RubyModule

Returns:

the Module
enumerableModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module Enumerable.

public static RubyClass

Returns:

the Class
enumeratorClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Enumerator

public static RubyModule

Returns:

the Module
errnoModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module Errno.

public static RubyClass

Returns:

the Class
exceptionClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Exception

public static RubyClass

Returns:

the Class
fileClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class File

public static RubyModule

Returns:

the Module
fileTestModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module FileTest.

public static RubyClass

Returns:

the Class
fixnumClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Fixnum

public static RubyClass

Returns:

the Class
floatClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Float

public static RubyClass

Returns:

the eventual class found
getClass
(ThreadContext
the current context
context
,
String
to be resolved
name
)

Return a class instance based on the name of the class in Object.

public static RubyClass

Returns:

the eventual class found
getClass
(ThreadContext
the current context
context
,
String...
to be resolved
names
)

Return a class instance based on a chain of module/classes starting at Object.

public static RubyModule

Returns:

the Module
getModule
(ThreadContext
the current thread context
context
,
String
of the module to return
name
)

Retrieve the instance of the module by name

public static GlobalVariables

Returns:

the object
globalVariables
(ThreadContext
the current thread context
context
)

Retrieve the object containing Ruby Global Variables.

public static RubyClass

Returns:

the Class
hashClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Hash

public static RubyInstanceConfig

Returns:

the object
instanceConfig
(ThreadContext
the current thread context
context
)

Retrieve our runtimes instance config which holds many configurable options which are set up from command-line properties or Java system properties.

public static RubyClass

Returns:

the Class
integerClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Integer

public static RubyClass

Returns:

the Class
ioClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class IO

public static RubyModule

Returns:

the Module
kernelModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module Kernel.

public static LoadService

Returns:

the instance
loadService
(ThreadContext
the current thread context
context
)

Retrieve LoadService instance

public static RubyClass

Returns:

the Class
moduleClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Module

public static RubyClass

Returns:

the Class
nilClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class NilClass

public static RubyClass

Returns:

the Class
objectClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Object

public static RubyClass

Returns:

the Class
procClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Proc

public static RubyModule

Returns:

the Class
processModule
(ThreadContext
the current thread context
context
)

Retrieve the instance of the module Process

public static RubyClass

Returns:

the Class
randomClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Random

public static RubyClass

Returns:

the Class
rangeClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Range

public static RubyClass

Returns:

the Class
regexpClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Regexp

public static RubyClass

Returns:

the Class
runtimeErrorClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class RuntimeError

public static RubyClass

Returns:

the Class
standardErrorClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class StandardError

public static RubyClass

Returns:

the Class
stringClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class String

public static RubyClass

Returns:

the Class
structClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Struct

public static RubyClass

Returns:

the Class
symbolClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Symbol

public static RubyClass

Returns:

the Class
timeClass
(ThreadContext
the current thread context
context
)

Retrieve the instance of the class Time

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Accessback to summary
public Access()

Method Detail

argsFileback to summary
public static IRubyObject argsFile(ThreadContext context)

Retrieve ARGF (RubyArgsFile) instance

Parameters
context:ThreadContext

the current thread context

Returns:IRubyObject

the instance

argumentErrorClassback to summary
public static RubyClass argumentErrorClass(ThreadContext context)

Retrieve the instance of the class ArgumentError

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

arrayClassback to summary
public static RubyClass arrayClass(ThreadContext context)

Retrieve the instance of the class Array

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

basicObjectClassback to summary
public static RubyClass basicObjectClass(ThreadContext context)

Retrieve the instance of the class BasicObject

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

classClassback to summary
public static RubyClass classClass(ThreadContext context)

Retrieve the instance of the class Class

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

comparableModuleback to summary
public static RubyModule comparableModule(ThreadContext context)

Retrieve the instance of the module Comparable.

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Module

dirClassback to summary
public static RubyClass dirClass(ThreadContext context)

Retrieve the instance of the class Dir

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

encodingServiceback to summary
public static EncodingService encodingService(ThreadContext context)

Retrieve the encoding service object

Parameters
context:ThreadContext

the current thread context

Returns:EncodingService

the object

enumerableModuleback to summary
public static RubyModule enumerableModule(ThreadContext context)

Retrieve the instance of the module Enumerable.

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Module

enumeratorClassback to summary
public static RubyClass enumeratorClass(ThreadContext context)

Retrieve the instance of the class Enumerator

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

errnoModuleback to summary
public static RubyModule errnoModule(ThreadContext context)

Retrieve the instance of the module Errno.

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Module

exceptionClassback to summary
public static RubyClass exceptionClass(ThreadContext context)

Retrieve the instance of the class Exception

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

fileClassback to summary
public static RubyClass fileClass(ThreadContext context)

Retrieve the instance of the class File

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

fileTestModuleback to summary
public static RubyModule fileTestModule(ThreadContext context)

Retrieve the instance of the module FileTest.

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Module

fixnumClassback to summary
public static RubyClass fixnumClass(ThreadContext context)

Retrieve the instance of the class Fixnum

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

floatClassback to summary
public static RubyClass floatClass(ThreadContext context)

Retrieve the instance of the class Float

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

getClassback to summary
public static RubyClass getClass(ThreadContext context, String name)

Return a class instance based on the name of the class in Object.

Parameters
context:ThreadContext

the current context

name:String

to be resolved

Returns:RubyClass

the eventual class found

getClassback to summary
public static RubyClass getClass(ThreadContext context, String... names)

Return a class instance based on a chain of module/classes starting at Object.

Parameters
context:ThreadContext

the current context

names:String[]

to be resolved

Returns:RubyClass

the eventual class found

getModuleback to summary
public static RubyModule getModule(ThreadContext context, String name)

Retrieve the instance of the module by name

Parameters
context:ThreadContext

the current thread context

name:String

of the module to return

Returns:RubyModule

the Module

globalVariablesback to summary
public static GlobalVariables globalVariables(ThreadContext context)

Retrieve the object containing Ruby Global Variables.

Parameters
context:ThreadContext

the current thread context

Returns:GlobalVariables

the object

hashClassback to summary
public static RubyClass hashClass(ThreadContext context)

Retrieve the instance of the class Hash

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

instanceConfigback to summary
public static RubyInstanceConfig instanceConfig(ThreadContext context)

Retrieve our runtimes instance config which holds many configurable options which are set up from command-line properties or Java system properties.

Parameters
context:ThreadContext

the current thread context

Returns:RubyInstanceConfig

the object

integerClassback to summary
public static RubyClass integerClass(ThreadContext context)

Retrieve the instance of the class Integer

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

ioClassback to summary
public static RubyClass ioClass(ThreadContext context)

Retrieve the instance of the class IO

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

kernelModuleback to summary
public static RubyModule kernelModule(ThreadContext context)

Retrieve the instance of the module Kernel.

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Module

loadServiceback to summary
public static LoadService loadService(ThreadContext context)

Retrieve LoadService instance

Parameters
context:ThreadContext

the current thread context

Returns:LoadService

the instance

moduleClassback to summary
public static RubyClass moduleClass(ThreadContext context)

Retrieve the instance of the class Module

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

nilClassback to summary
public static RubyClass nilClass(ThreadContext context)

Retrieve the instance of the class NilClass

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

objectClassback to summary
public static RubyClass objectClass(ThreadContext context)

Retrieve the instance of the class Object

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

procClassback to summary
public static RubyClass procClass(ThreadContext context)

Retrieve the instance of the class Proc

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

processModuleback to summary
public static RubyModule processModule(ThreadContext context)

Retrieve the instance of the module Process

Parameters
context:ThreadContext

the current thread context

Returns:RubyModule

the Class

randomClassback to summary
public static RubyClass randomClass(ThreadContext context)

Retrieve the instance of the class Random

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

rangeClassback to summary
public static RubyClass rangeClass(ThreadContext context)

Retrieve the instance of the class Range

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

regexpClassback to summary
public static RubyClass regexpClass(ThreadContext context)

Retrieve the instance of the class Regexp

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

runtimeErrorClassback to summary
public static RubyClass runtimeErrorClass(ThreadContext context)

Retrieve the instance of the class RuntimeError

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

standardErrorClassback to summary
public static RubyClass standardErrorClass(ThreadContext context)

Retrieve the instance of the class StandardError

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

stringClassback to summary
public static RubyClass stringClass(ThreadContext context)

Retrieve the instance of the class String

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

structClassback to summary
public static RubyClass structClass(ThreadContext context)

Retrieve the instance of the class Struct

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

symbolClassback to summary
public static RubyClass symbolClass(ThreadContext context)

Retrieve the instance of the class Symbol

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class

timeClassback to summary
public static RubyClass timeClass(ThreadContext context)

Retrieve the instance of the class Time

Parameters
context:ThreadContext

the current thread context

Returns:RubyClass

the Class