JRuby Base 10.0.0.0 · org.jruby.RubyInstanceConfig · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static enum	RubyInstanceConfig.CompileMode
public static interface	RubyInstanceConfig.LoadServiceCreator
public static enum	RubyInstanceConfig.ProfilingMode
public static enum	RubyInstanceConfig.Verbosity

Field Summary

Modifier and Type	Field and Description
private boolean	_classloaderDelegate
private boolean	_nativeEnabled Whether native code is enabled for this configuration.
private boolean	allowUppercasePackageNames
private String[]	argv
private boolean	argvGlobalsOn
private boolean	assumeLoop
private boolean	assumePrinting
private boolean	backtraceColor
private Integer	backtraceLimit
private boolean	backtraceMask
public static final boolean	CAN_SET_ACCESSIBLE Deprecated
public static final boolean	CEXT_ENABLED Deprecated
public static final int	CHAINED_COMPILE_LINE_COUNT Deprecated
public static final int	CHAINED_COMPILE_LINE_COUNT_DEFAULT Deprecated Default size for chained compilation.
public static final String	COMPILE_EXCLUDE Comma-separated list of methods to exclude from JIT compilation.
private RubyInstanceConfig.CompileMode	compileMode
public static final boolean	CONSISTENT_HASHING_ENABLED Whether to calculate consistent hashes across JVM instances, or to ensure un-predicatable hash values using SecureRandom.
public static final boolean	COROUTINE_FIBERS Deprecated
private RubyInstanceConfig.LoadServiceCreator	creator
private String	currentDirectory
private boolean	debug
public static final boolean	DEBUG_LAUNCHING Turn on debugging of subprocess launching.
public static final boolean	DEBUG_LOAD_SERVICE Turn on debugging of the load service (requires and loads).
public static final boolean	DEBUG_LOAD_TIMINGS Turn on timings of the load service (requires and loads).
public static final boolean	DEBUG_PARSER
public static final boolean	DEBUG_SCRIPT_RESOLUTION Turn on debugging of script resolution with "-S".
private boolean	debuggingFrozenStringLiteral
private boolean	disableDidYouMean
private boolean	disableErrorHighlight
private boolean	disableGems
private boolean	disableRUBYOPT
private boolean	disableSyntaxSuggest
private Map<String, String>	environment Environment variables; defaults to System.getenv() in constructor
public static final boolean	ERRNO_BACKTRACE
private PrintStream	error
private Set<String>	excludedMethods
private String	externalEncoding
private final List<String>	extraGemPaths
private final List<Loader>	extraLoaders
private final List<String>	extraLoadPaths
public static boolean	FAST_MULTIPLE_ASSIGNMENT Deprecated
public static final boolean	FASTEST_COMPILE_ENABLED Deprecated
public static final boolean	FASTOPS_COMPILE_ENABLED Deprecated
public static boolean	FASTSEND_COMPILE_ENABLED Deprecated
public static final int	FIBER_POOL_TTL Fiber thread pool time-to-live in seconds.
private boolean	forceStdin
private Boolean	frozenStringLiteral
public static boolean	FULL_TRACE_ENABLED Enable tracing of method calls.
private boolean	globalRequireLock Deprecated
private boolean	hardExit
private boolean	hasInlineScript
private boolean	hasScriptArgv
private boolean	hasShebangLine Indicates whether the script has a shebang line or not
private final StringBuffer	inlineScript
private String	inPlaceBackupExtension
private InputStream	input
private String	inputFieldSeparator
public static final boolean	INTERFACES_USE_PROXY
private String	internalEncoding
private final boolean	interruptibleRegexps
public static boolean	IR_COMPILER_DEBUG
public static final String	IR_COMPILER_PASSES
public static boolean	IR_DEBUG
public static final String	IR_DEBUG_IGV
public static final boolean	IR_DEBUG_IGV_STDOUT
public static String	IR_INLINE_COMPILER_PASSES
public static final String	IR_JIT_PASSES
public static String	IR_PRINT_PATTERN
public static final boolean	IR_PROFILE
public static final boolean	IR_READING
public static final boolean	IR_READING_DEBUG
public static final boolean	IR_UNBOXING
public static final boolean	IR_VISUALIZER
public static final boolean	IR_WRITING
public static final boolean	IR_WRITING_DEBUG
private final boolean	isSecurityRestricted
public static final int	JAVA_VERSION The version to use for generated classes.
public static final boolean	JIT_CACHE_ENABLED Deprecated
public static final String	JIT_CODE_CACHE Deprecated
public static final boolean	JIT_LOADING_DEBUG Deprecated
public static final int	JIT_MAX_METHODS_LIMIT Deprecated The max count of active methods eligible for JIT-compilation.
public static final int	JIT_MAX_SIZE_LIMIT Deprecated The max size of JIT-compiled methods (full class size) allowed.
public static final int	JIT_THRESHOLD Deprecated The JIT threshold to the specified method invocation count.
private boolean	jitBackground
private final boolean	jitDumping Deprecated
private int	jitLogEvery
private final boolean	jitLogging
private final boolean	jitLoggingVerbose
private int	jitMax
private int	jitMaxSize
private int	jitThreshold
private String	jrubyHome
public static final boolean	JUMPS_HAVE_BACKTRACE
private KCode	kcode
private boolean	kernelGsubDefined
private static volatile boolean	loadedNativeExtensions
private ClassLoader	loader
private boolean	loadGemfile
private List<String>	loadPaths
public static final boolean	LOG_BACKTRACES
public static final boolean	LOG_CALLERS
public static final boolean	LOG_EXCEPTIONS
public static final boolean	LOG_WARNINGS
private boolean	managementEnabled
public static final boolean	NATIVE_ENABLED Indicates the global default for whether native code is enabled.
public static final boolean	NATIVE_NET_PROTOCOL Deprecated
public static final boolean	nativeEnabled Deprecated
public static final boolean	NO_UNWRAP_PROCESS_STREAMS
public static boolean	NOGUARDS_COMPILE_ENABLED Deprecated
private boolean	objectSpaceEnabled
private final Map<String, String>	optionGlobals
private PrintStream	output
private boolean	parserDebug
public static final boolean	PEEPHOLE_OPTZ Deprecated
public static final int	POOL_MAX Maximum thread pool size (integer, default Integer.MAX_VALUE).
public static final int	POOL_MIN Minimum thread pool size (integer, default 0).
public static final int	POOL_TTL Thread pool time-to-live in seconds.
public static final boolean	POOLING_ENABLED Enable a thread pool.
private boolean	processLineEnds
private Profile	profile
private int	profileMaxMethods
private ProfileOutput	profileOutput
private RubyInstanceConfig.ProfilingMode	profilingMode
private String	profilingService
public static boolean	RECORD_LEXICAL_HIERARCHY
private String	recordSeparator
public static final boolean	REFLECTED_HANDLES Deprecated
public static final boolean	REIFY_LOG_ERRORS Log errors that occur during reification.
public static final boolean	REIFY_RUBY_CLASSES Whether to reify (pre-compile and generate) a Java class per Ruby class.
private final Collection<String>	requiredLibraries
private static final Pattern	RUBY_SHEBANG
private boolean	runRubyInProcess Deprecated
private String	scriptFileName
public static final boolean	SET_ACCESSIBLE
private transient boolean	setEnvRuby
private boolean	shouldCheckSyntax
private boolean	shouldPrintProperties
private boolean	shouldPrintUsage
private boolean	shouldRunInterpreter
private boolean	showBytecode
private boolean	showCopyright
private boolean	showVersion
private boolean	siphashEnabled
private String	sourceEncoding
private boolean	split
public static final boolean	STOPITERATION_BACKTRACE
private String	threadDumpSignal Deprecated
public static boolean	THREADLESS_COMPILE_ENABLED Deprecated
private TraceType	traceType
private boolean	updateNativeENVEnabled
public static final boolean	USE_GENERATED_HANDLES Deprecated
private RubyInstanceConfig.Verbosity	verbosity
private final Set<RubyWarnings.Category>	warningCategories
private boolean	xFlag Indicates whether the script must be extracted from script source

Access	Constructor and Description
public	RubyInstanceConfig()
public	RubyInstanceConfig(boolean isSecurityRestricted)
public	RubyInstanceConfig(RubyInstanceConfig parentConfig)
public	RubyInstanceConfig(final InputStream in, final PrintStream out, final PrintStream err)

Method Summary

Modifier and Type	Method and Description
public void	addLoader(ClassLoader loader) adds a given ClassLoader to jruby.
public void	addLoader(Loader bundle) adds a given "bundle" to jruby.
private String	calculateJRubyHome()
public LoadService	createLoadService(Ruby runtime)
public static ClassLoader	defaultClassLoader()
public String	displayedFileName()
private void	eatToShebang(InputStream in)
private static InputStream	findScript(InputStream is)
public boolean	getAllowUppercasePackageNames() get whether uppercase package names will be honored
public String[]	getArgv()
public boolean	getBacktraceColor() True if colorized backtraces are enabled.
public Integer	getBacktraceLimit()
public boolean	Returns: true if masking; false otherwise getBacktraceMask() Whether to mask .java lines in the Ruby backtrace, as MRI does for C calls.
public String	getBasicUsageHelp() Deprecated
public RubyInstanceConfig.CompileMode	getCompileMode()
public String	getCopyrightString() Deprecated
public String	getCurrentDirectory()
public ClassLoader	getCurrentThreadClassLoader()
public Map<String, String>	getEnvironment()
public PrintStream	getError()
public Set<String>	getExcludedMethods()
public String	getExtendedHelp() Deprecated
public String	getExternalEncoding()
public List<String>	getExtraGemPaths()
public List<Loader>	getExtraLoaders()
public List<String>	getExtraLoadPaths()
public boolean	getHasScriptArgv()
public StringBuffer	getInlineScript()
public String	getInPlaceBackupExtension()
public String	getInPlaceBackupExtention() Deprecated
public InputStream	getInput()
public String	getInputFieldSeparator()
public String	getInternalEncoding()
public boolean	Returns: whether the JIT compiler will run in a background thread getJitBackground() Get whether the JIT compiler will run in a background thread.
public int	getJitLogEvery()
public int	getJitMax()
public int	getJitMaxSize()
public int	getJitThreshold()
public String	getJRubyHome()
public KCode	getKCode()
public boolean	getKernelGsubDefined() Get Kernel#gsub is defined or not
public ClassLoader	getLoader()
public boolean	getLoadGemfile() Whether to load and setup bundler on startup.
public List<String>	getLoadPaths()
public RubyInstanceConfig.LoadServiceCreator	getLoadServiceCreator()
public Map<String, String>	getOptionGlobals()
public PrintStream	getOutput()
public boolean	getParserDebug()
public Profile	getProfile()
public int	getProfileMaxMethods() Get the maximum number of methods to consider when profiling.
public ProfileOutput	getProfileOutput()
public RubyInstanceConfig.ProfilingMode	getProfilingMode()
public String	getProfilingService()
public String	getPropertyHelp() Deprecated
public String	getRecordSeparator()
public Collection<String>	getRequiredLibraries()
public int	getSafeLevel()
public String	getScriptFileName()
public InputStream	getScriptSource()
public boolean	getShouldCheckSyntax()
public boolean	getShouldPrintProperties()
public boolean	getShouldPrintUsage()
public boolean	getShouldRunInterpreter()
public String	getSourceEncoding()
public String	getThreadDumpSignal() Deprecated
public TraceType	getTraceType()
public Boolean	getVerbose() Deprecated
public RubyInstanceConfig.Verbosity	getVerbosity()
public String	getVersionString() Deprecated
public Set<RubyWarnings.Category>	Returns: the set of enabled warning categories getWarningCategories() Get the set of enabled warning categories.
public boolean	hasInlineScript()
public static boolean	hasLoadedNativeExtensions()
public boolean	hasShebangLine()
private void	initEnvironment()
private static int	initJavaBytecodeVersion()
public byte[]	inlineScript()
public boolean	isArgvGlobalsOn()
public boolean	isAssumeLoop()
public boolean	isAssumePrinting()
public boolean	isBenchmarking() Deprecated
public boolean	isCextEnabled() Deprecated
public boolean	Returns: true if self-first classloader is used; false otherwise. isClassloaderDelegate() Get whether to use the self-first jruby classloader.
public boolean	isDebug()
public boolean	isDebuggingFrozenStringLiteral()
public boolean	isDisableDidYouMean()
public boolean	isDisableErrorHighlight()
public boolean	isDisableGems()
public boolean	isDisableSyntaxSuggest()
public boolean	isForceStdin() True if we are only using source from stdin and not from a -e or file argument.
public Boolean	isFrozenStringLiteral()
public boolean	isGlobalRequireLock() Deprecated
public boolean	isHardExit()
public boolean	isInlineScript()
public boolean	isInterruptibleRegexps()
public boolean	isJitDumping() Deprecated
public boolean	Returns: true if JIT compilation is enabled isJitEnabled()
public boolean	isJitLogging()
public boolean	isJitLoggingVerbose()
public boolean	isManagementEnabled()
public boolean	Returns: true if native code is enabled; false otherwise. isNativeEnabled() Get whether native code is enabled for this config.
public boolean	isObjectSpaceEnabled()
public boolean	isParserDebug()
public boolean	isProcessLineEnds()
public boolean	isProfiling()
public boolean	isProfilingEntireRun()
protected static boolean	isRubyShebangLine(String line)
public boolean	isRunRubyInProcess()
public boolean	isSamplingEnabled() Deprecated
private boolean	isShebang(InputStreamMarkCursor cursor)
public boolean	isShouldRunInterpreter() Deprecated
public boolean	isShowBytecode()
public boolean	isShowCopyright()
public boolean	isShowVersion()
public boolean	isSiphashEnabled()
public boolean	isSplit()
public boolean	isUpdateNativeENVEnabled() Indicates whether the JVM process' native environment will be updated when ENV[...] is set from Ruby.
public boolean	isVerbose()
public boolean	isXFlag()
public boolean	isxFlag() Deprecated
public List<String>	loadPaths() Deprecated
public String[]	parseShebangOptions(InputStream in) The intent here is to gather up any options that might have been specified in the shebang line and return them so they can be merged into the ones specified on the command-line.
public void	processArguments(String[] arguments)
public void	processArgumentsWithRubyopts()
public Collection<String>	requiredLibraries() Deprecated
private void	resetEnvRuby()
public void	setAllowUppercasePackageNames(boolean allow) set whether uppercase package names will be honored
public void	setArgv(String[] argv)
public void	setArgvGlobalsOn(boolean argvGlobalsOn)
public void	setAssumeLoop(boolean assumeLoop)
public void	setAssumePrinting(boolean assumePrinting)
public void	setBacktraceColor(boolean backtraceColor) Set to true to enable colorized backtraces.
public void	setBacktraceLimit(Integer limit)
public void	setBacktraceMask(boolean true to mask; false otherwise backtraceMask) Set whether to mask .java lines in the Ruby backtrace.
public void	setBenchmarking(boolean benchmarking) Deprecated
public void	setCextEnabled(boolean b) Deprecated
public void	setClassloaderDelegate(boolean new value indicating whether self-first classloader is used b) Set whether to use the self-first jruby classloader.
public void	setCompileMode(RubyInstanceConfig.CompileMode compileMode)
public void	setCurrentDirectory(String newCurrentDirectory)
public void	setDebug(boolean debug)
public void	setDebuggingFrozenStringLiteral(boolean debuggingFrozenStringLiteral)
public void	setDisableDidYouMean(boolean ddym)
public void	setDisableErrorHighlight(boolean eh)
public void	setDisableGems(boolean dg)
public void	setDisableRUBYOPT(boolean dr)
public void	setDisableSyntaxSuggest(boolean ss)
public void	setEnvironment(Map<String, String> newEnvironment)
public void	setError(PrintStream newError)
public void	setExternalEncoding(String externalEncoding)
public void	setForceStdin(boolean forceStdin) Set whether we should only look at stdin for source.
public void	setFrozenStringLiteral(boolean frozenStringLiteral)
public void	setGlobalRequireLock(boolean globalRequireLock) Deprecated
public void	setHardExit(boolean hardExit)
public void	setHasInlineScript(boolean hasInlineScript)
public void	setHasScriptArgv(boolean argvRemains)
public void	setHasShebangLine(boolean hasShebangLine)
public void	setInPlaceBackupExtension(String inPlaceBackupExtension)
public void	setInput(InputStream newInput)
public void	setInputFieldSeparator(String inputFieldSeparator)
public void	setInternalEncoding(String internalEncoding)
public void	setJitBackground(boolean whether to run the JIT compiler in a background thread jitBackground) Set whether the JIT compiler should run in a background thread (Executor-based).
public void	setJitLogEvery(int jitLogEvery)
public void	setJitMax(int jitMax)
public void	setJitMaxSize(int jitMaxSize)
public void	setJitThreshold(int jitThreshold)
public void	setJRubyHome(String home)
public void	setKCode(KCode kcode)
public void	setKernelGsubDefined(boolean setDefineKernelGsub) Set whether Kernel#gsub should be defined
public static void	setLoadedNativeExtensions(boolean loadedNativeExtensions)
public void	setLoader(ClassLoader loader)
public void	setLoadGemfile(boolean loadGemfile) Set whether to load and setup bundler on startup.
public void	setLoadPaths(List<String> loadPaths)
public void	setLoadServiceCreator(RubyInstanceConfig.LoadServiceCreator creator)
public void	setNativeEnabled(boolean new value indicating whether native code is enabled b) Set whether native code is enabled for this config.
public void	setObjectSpaceEnabled(boolean newObjectSpaceEnabled)
public void	setOutput(PrintStream newOutput)
public void	setParserDebug(boolean parserDebug)
public void	setProcessLineEnds(boolean processLineEnds)
public void	setProfile(Profile newProfile)
public void	setProfileMaxMethods(int profileMaxMethods) Set the maximum number of methods to consider when profiling.
public void	setProfileOutput(ProfileOutput output)
public void	setProfilingMode(RubyInstanceConfig.ProfilingMode profilingMode)
public void	setProfilingService(String service)
public void	setRecordSeparator(String recordSeparator)
public void	setRunRubyInProcess(boolean flag)
public void	setSafeLevel(int safeLevel) Deprecated
public void	setScriptFileName(String scriptFileName)
public void	setShouldCheckSyntax(boolean shouldSetSyntax)
public void	setShouldPrintProperties(boolean shouldPrintProperties)
public void	setShouldPrintUsage(boolean shouldPrintUsage)
public void	setShouldRunInterpreter(boolean shouldRunInterpreter)
public void	setShowBytecode(boolean showBytecode)
public void	setShowCopyright(boolean showCopyright)
public void	setShowVersion(boolean showVersion)
public void	setSiphashEnabled(boolean newSiphashEnabled)
public void	setSourceEncoding(String sourceEncoding)
public void	setSplit(boolean split)
public void	setTraceType(TraceType traceType)
public void	setUpdateNativeENVEnabled(boolean updateNativeENVEnabled) Ensure that the JVM process' native environment will be updated when ENV is modified .
public void	setVerbosity(RubyInstanceConfig.Verbosity verbosity)
public void	setXFlag(boolean xFlag)
public boolean	shouldPrintProperties() Deprecated
public boolean	shouldPrintUsage() Deprecated
public boolean	shouldRunInterpreter() Deprecated
private boolean	skipToNextLine(InputStreamMarkCursor cursor)
public void	tryProcessArgumentsWithRubyopts()
private static String	verifyHome(String home, PrintStream error)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class RubyInstanceConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary