| java.lang.Object
 java.lang.Runtime
| Runtime | | public class Runtime (Code) | | Every Java application has a single instance of class
Runtime that allows the application to interface with
the environment in which the application is running. The current
runtime can be obtained from the getRuntime method.
An application cannot create its own instance of this class.
author:
unascribed
version:
1.84, 05/05/07
See Also: java.lang.Runtime.getRuntime
since:
JDK1.0 |
| Method Summary | |
| public void | addShutdownHook(Thread hook)
Registers a new virtual-machine shutdown hook.
The Java virtual machine shuts down in response to two kinds
of events:
- The program exits normally, when the last non-daemon
thread exits or when the
Runtime.exit exit (equivalently,
System.exit(int) System.exit ) method is invoked, or
- The virtual machine is terminated in response to a
user interrupt, such as typing ^C, or a system-wide event,
such as user logoff or system shutdown.
A shutdown hook is simply an initialized but unstarted
thread. | | native public int | availableProcessors()
Returns the number of processors available to the Java virtual machine.
This value may change during a particular invocation of the virtual
machine. | | public Process | exec(String command)
Executes the specified string command in a separate process.
This is a convenience method. | | public Process | exec(String command, String[] envp)
Executes the specified string command in a separate process with the
specified environment.
This is a convenience method. | | public Process | exec(String command, String[] envp, File dir)
Executes the specified string command in a separate process with the
specified environment and working directory.
This is a convenience method. | | public Process | exec(String cmdarray)
Executes the specified command and arguments in a separate process.
This is a convenience method. | | public Process | exec(String[] cmdarray, String[] envp)
Executes the specified command and arguments in a separate process
with the specified environment.
This is a convenience method. | | public Process | exec(String[] cmdarray, String[] envp, File dir)
Executes the specified command and arguments in a separate process with
the specified environment and working directory.
Given an array of strings cmdarray, representing the
tokens of a command line, and an array of strings envp,
representing "environment" variable settings, this method creates
a new process in which to execute the specified command.
This method checks that cmdarray is a valid operating
system command. | | public void | exit(int status)
Terminates the currently running Java virtual machine by initiating its
shutdown sequence. | | native public long | freeMemory()
Returns the amount of free memory in the Java Virtual Machine. | | native public void | gc()
Runs the garbage collector.
Calling this method suggests that the Java virtual machine expend
effort toward recycling unused objects in order to make the memory
they currently occupy available for quick reuse. | | public InputStream | getLocalizedInputStream(InputStream in)
Creates a localized version of an input stream. | | public OutputStream | getLocalizedOutputStream(OutputStream out)
Creates a localized version of an output stream. | | public static Runtime | getRuntime()
Returns the runtime object associated with the current Java application.
Most of the methods of class Runtime are instance
methods and must be invoked with respect to the current runtime object. | | public void | halt(int status)
Forcibly terminates the currently running Java virtual machine. | | public void | load(String filename)
Loads the specified filename as a dynamic library. | | synchronized void | load0(Class fromClass, String filename)
| | public void | loadLibrary(String libname)
Loads the dynamic library with the specified library name. | | synchronized void | loadLibrary0(Class fromClass, String libname)
| | native public long | maxMemory()
Returns the maximum amount of memory that the Java virtual machine will
attempt to use. | | public boolean | removeShutdownHook(Thread hook)
De-registers a previously-registered virtual-machine shutdown hook. | | public void | runFinalization()
Runs the finalization methods of any objects pending finalization.
Calling this method suggests that the Java virtual machine expend
effort toward running the finalize methods of objects
that have been found to be discarded but whose finalize
methods have not yet been run. | | public static void | runFinalizersOnExit(boolean value)
Enable or disable finalization on exit; doing so specifies that the
finalizers of all objects that have finalizers that have not yet been
automatically invoked are to be run before the Java runtime exits.
By default, finalization on exit is disabled.
If there is a security manager,
its checkExit method is first called
with 0 as its argument to ensure the exit is allowed. | | native public long | totalMemory()
Returns the total amount of memory in the Java virtual machine. | | native public void | traceInstructions(boolean on)
Enables/Disables tracing of instructions.
If the boolean argument is true, this
method suggests that the Java virtual machine emit debugging
information for each instruction in the virtual machine as it
is executed. | | native public void | traceMethodCalls(boolean on)
Enables/Disables tracing of method calls.
If the boolean argument is true, this
method suggests that the Java virtual machine emit debugging
information for each method in the virtual machine as it is
called. |
| addShutdownHook | | public void addShutdownHook(Thread hook)(Code) | | Registers a new virtual-machine shutdown hook.
The Java virtual machine shuts down in response to two kinds
of events:
- The program exits normally, when the last non-daemon
thread exits or when the
Runtime.exit exit (equivalently,
System.exit(int) System.exit ) method is invoked, or
- The virtual machine is terminated in response to a
user interrupt, such as typing ^C, or a system-wide event,
such as user logoff or system shutdown.
A shutdown hook is simply an initialized but unstarted
thread. When the virtual machine begins its shutdown sequence it will
start all registered shutdown hooks in some unspecified order and let
them run concurrently. When all the hooks have finished it will then
run all uninvoked finalizers if finalization-on-exit has been enabled.
Finally, the virtual machine will halt. Note that daemon threads will
continue to run during the shutdown sequence, as will non-daemon threads
if shutdown was initiated by invoking the
Runtime.exit exit
method.
Once the shutdown sequence has begun it can be stopped only by
invoking the
Runtime.halt halt method, which forcibly
terminates the virtual machine.
Once the shutdown sequence has begun it is impossible to register a
new shutdown hook or de-register a previously-registered hook.
Attempting either of these operations will cause an
IllegalStateException to be thrown.
Shutdown hooks run at a delicate time in the life cycle of a virtual
machine and should therefore be coded defensively. They should, in
particular, be written to be thread-safe and to avoid deadlocks insofar
as possible. They should also not rely blindly upon services that may
have registered their own shutdown hooks and therefore may themselves in
the process of shutting down. Attempts to use other thread-based
services such as the AWT event-dispatch thread, for example, may lead to
deadlocks.
Shutdown hooks should also finish their work quickly. When a
program invokes
Runtime.exit exit the expectation is
that the virtual machine will promptly shut down and exit. When the
virtual machine is terminated due to user logoff or system shutdown the
underlying operating system may only allow a fixed amount of time in
which to shut down and exit. It is therefore inadvisable to attempt any
user interaction or to perform a long-running computation in a shutdown
hook.
Uncaught exceptions are handled in shutdown hooks just as in any
other thread, by invoking the
ThreadGroup.uncaughtExceptionuncaughtException method of the thread's
ThreadGroup object. The default implementation of this method
prints the exception's stack trace to
System.err and
terminates the thread; it does not cause the virtual machine to exit or
halt.
In rare circumstances the virtual machine may abort, that is,
stop running without shutting down cleanly. This occurs when the
virtual machine is terminated externally, for example with the
SIGKILL signal on Unix or the TerminateProcess call on
Microsoft Windows. The virtual machine may also abort if a native
method goes awry by, for example, corrupting internal data structures or
attempting to access nonexistent memory. If the virtual machine aborts
then no guarantee can be made about whether or not any shutdown hooks
will be run.
Parameters:
hook - An initialized but unstarted Thread object
throws:
IllegalArgumentException - If the specified hook has already been registered,or if it can be determined that the hook is already running orhas already been run
throws:
IllegalStateException - If the virtual machine is already in the processof shutting down
throws:
SecurityException - If a security manager is present and it deniesRuntimePermission("shutdownHooks")
See Also: Runtime.removeShutdownHook
See Also: Runtime.halt(int)
See Also: Runtime.exit(int)
since:
1.3 |
| availableProcessors | | native public int availableProcessors()(Code) | | Returns the number of processors available to the Java virtual machine.
This value may change during a particular invocation of the virtual
machine. Applications that are sensitive to the number of available
processors should therefore occasionally poll this property and adjust
their resource usage appropriately.
the maximum number of processors available to the virtualmachine; never smaller than one
since:
1.4 |
| exec | | public Process exec(String command, String[] envp) throws IOException(Code) | | Executes the specified string command in a separate process with the
specified environment.
This is a convenience method. An invocation of the form
exec(command, envp)
behaves in exactly the same way as the invocation
Runtime.exec(String,String[],File) exec (command, envp, null).
Parameters:
command - a specified system command.
Parameters:
envp - array of strings, each element of whichhas environment variable settings in the formatname=value, ornull if the subprocess should inheritthe environment of the current process. A new Process object for managing the subprocess
throws:
SecurityException - If a security manager exists and itsSecurityManager.checkExec checkExecmethod doesn't allow creation of the subprocess
throws:
IOException - If an I/O error occurs
throws:
NullPointerException - If command is null,or one of the elements of envp is null
throws:
IllegalArgumentException - If command is empty
See Also: Runtime.exec(String[],String[],File)
See Also: ProcessBuilder |
| exec | | public Process exec(String command, String[] envp, File dir) throws IOException(Code) | | Executes the specified string command in a separate process with the
specified environment and working directory.
This is a convenience method. An invocation of the form
exec(command, envp, dir)
behaves in exactly the same way as the invocation
Runtime.exec(String[],String[],File) exec (cmdarray, envp, dir),
where cmdarray is an array of all the tokens in
command.
More precisely, the command string is broken
into tokens using a
StringTokenizer created by the call
new
StringTokenizer (command) with no
further modification of the character categories. The tokens
produced by the tokenizer are then placed in the new string
array cmdarray, in the same order.
Parameters:
command - a specified system command.
Parameters:
envp - array of strings, each element of whichhas environment variable settings in the formatname=value, ornull if the subprocess should inheritthe environment of the current process.
Parameters:
dir - the working directory of the subprocess, ornull if the subprocess should inheritthe working directory of the current process. A new Process object for managing the subprocess
throws:
SecurityException - If a security manager exists and itsSecurityManager.checkExec checkExecmethod doesn't allow creation of the subprocess
throws:
IOException - If an I/O error occurs
throws:
NullPointerException - If command is null,or one of the elements of envp is null
throws:
IllegalArgumentException - If command is empty
See Also: ProcessBuilder
since:
1.3 |
| exec | | public Process exec(String[] cmdarray, String[] envp) throws IOException(Code) | | Executes the specified command and arguments in a separate process
with the specified environment.
This is a convenience method. An invocation of the form
exec(cmdarray, envp)
behaves in exactly the same way as the invocation
Runtime.exec(String[],String[],File) exec (cmdarray, envp, null).
Parameters:
cmdarray - array containing the command to call andits arguments.
Parameters:
envp - array of strings, each element of whichhas environment variable settings in the formatname=value, ornull if the subprocess should inheritthe environment of the current process. A new Process object for managing the subprocess
throws:
SecurityException - If a security manager exists and itsSecurityManager.checkExec checkExecmethod doesn't allow creation of the subprocess
throws:
IOException - If an I/O error occurs
throws:
NullPointerException - If cmdarray is null,or one of the elements of cmdarray is null,or one of the elements of envp is null
throws:
IndexOutOfBoundsException - If cmdarray is an empty array(has length 0)
See Also: ProcessBuilder |
| exec | | public Process exec(String[] cmdarray, String[] envp, File dir) throws IOException(Code) | | Executes the specified command and arguments in a separate process with
the specified environment and working directory.
Given an array of strings cmdarray, representing the
tokens of a command line, and an array of strings envp,
representing "environment" variable settings, this method creates
a new process in which to execute the specified command.
This method checks that cmdarray is a valid operating
system command. Which commands are valid is system-dependent,
but at the very least the command must be a non-empty list of
non-null strings.
If envp is null, the subprocess inherits the
environment settings of the current process.
ProcessBuilder.start is now the preferred way to
start a process with a modified environment.
The working directory of the new subprocess is specified by dir.
If dir is null, the subprocess inherits the
current working directory of the current process.
If a security manager exists, its
SecurityManager.checkExec checkExec method is invoked with the first component of the array
cmdarray as its argument. This may result in a
SecurityException being thrown.
Starting an operating system process is highly system-dependent.
Among the many things that can go wrong are:
- The operating system program file was not found.
- Access to the program file was denied.
- The working directory does not exist.
In such cases an exception will be thrown. The exact nature
of the exception is system-dependent, but it will always be a
subclass of
IOException .
Parameters:
cmdarray - array containing the command to call andits arguments.
Parameters:
envp - array of strings, each element of whichhas environment variable settings in the formatname=value, ornull if the subprocess should inheritthe environment of the current process.
Parameters:
dir - the working directory of the subprocess, ornull if the subprocess should inheritthe working directory of the current process. A new Process object for managing the subprocess
throws:
SecurityException - If a security manager exists and itsSecurityManager.checkExec checkExecmethod doesn't allow creation of the subprocess
throws:
IOException - If an I/O error occurs
throws:
NullPointerException - If cmdarray is null,or one of the elements of cmdarray is null,or one of the elements of envp is null
throws:
IndexOutOfBoundsException - If cmdarray is an empty array(has length 0)
See Also: ProcessBuilder
since:
1.3 |
| exit | | public void exit(int status)(Code) | | Terminates the currently running Java virtual machine by initiating its
shutdown sequence. This method never returns normally. The argument
serves as a status code; by convention, a nonzero status code indicates
abnormal termination.
The virtual machine's shutdown sequence consists of two phases. In
the first phase all registered
Runtime.addShutdownHook shutdown hooks ,
if any, are started in some unspecified order and allowed to run
concurrently until they finish. In the second phase all uninvoked
finalizers are run if
Runtime.runFinalizersOnExit finalization-on-exit has been enabled. Once this is done the virtual machine
Runtime.halthalts .
If this method is invoked after the virtual machine has begun its
shutdown sequence then if shutdown hooks are being run this method will
block indefinitely. If shutdown hooks have already been run and on-exit
finalization has been enabled then this method halts the virtual machine
with the given status code if the status is nonzero; otherwise, it
blocks indefinitely.
The
System.exit(int) System.exit method is the
conventional and convenient means of invoking this method.
Parameters:
status - Termination status. By convention, a nonzero status codeindicates abnormal termination.
throws:
SecurityException - If a security manager is present and its SecurityManager.checkExit checkExit method does not permitexiting with the specified status
See Also: java.lang.SecurityException
See Also: java.lang.SecurityManager.checkExit(int)
See Also: Runtime.addShutdownHook
See Also: Runtime.removeShutdownHook
See Also: Runtime.runFinalizersOnExit
See Also: Runtime.halt(int) |
| freeMemory | | native public long freeMemory()(Code) | | Returns the amount of free memory in the Java Virtual Machine.
Calling the
gc method may result in increasing the value returned
by freeMemory.
an approximation to the total amount of memory currentlyavailable for future allocated objects, measured in bytes. |
| gc | | native public void gc()(Code) | | Runs the garbage collector.
Calling this method suggests that the Java virtual machine expend
effort toward recycling unused objects in order to make the memory
they currently occupy available for quick reuse. When control
returns from the method call, the virtual machine has made
its best effort to recycle all discarded objects.
The name gc stands for "garbage
collector". The virtual machine performs this recycling
process automatically as needed, in a separate thread, even if the
gc method is not invoked explicitly.
The method
System.gc is the conventional and convenient
means of invoking this method.
|
| getRuntime | | public static Runtime getRuntime()(Code) | | Returns the runtime object associated with the current Java application.
Most of the methods of class Runtime are instance
methods and must be invoked with respect to the current runtime object.
the Runtime object associated with the currentJava application. |
| halt | | public void halt(int status)(Code) | | Forcibly terminates the currently running Java virtual machine. This
method never returns normally.
This method should be used with extreme caution. Unlike the
Runtime.exit exit method, this method does not cause shutdown
hooks to be started and does not run uninvoked finalizers if
finalization-on-exit has been enabled. If the shutdown sequence has
already been initiated then this method does not wait for any running
shutdown hooks or finalizers to finish their work.
Parameters:
status - Termination status. By convention, a nonzero status codeindicates abnormal termination. If the Runtime.exitexit (equivalently, System.exit(int)System.exit) method has already been invoked then thisstatus code will override the status code passed to that method.
throws:
SecurityException - If a security manager is present and its SecurityManager.checkExit checkExit method does not permitan exit with the specified status
See Also: Runtime.exit
See Also: Runtime.addShutdownHook
See Also: Runtime.removeShutdownHook
since:
1.3 |
| loadLibrary | | public void loadLibrary(String libname)(Code) | | Loads the dynamic library with the specified library name.
A file containing native code is loaded from the local file system
from a place where library files are conventionally obtained. The
details of this process are implementation-dependent. The
mapping from a library name to a specific filename is done in a
system-specific manner.
First, if there is a security manager, its checkLink
method is called with the libname as its argument.
This may result in a security exception.
The method
System.loadLibrary(String) is the conventional
and convenient means of invoking this method. If native
methods are to be used in the implementation of a class, a standard
strategy is to put the native code in a library file (call it
LibFile) and then to put a static initializer:
static { System.loadLibrary("LibFile"); }
within the class declaration. When the class is loaded and
initialized, the necessary native code implementation for the native
methods will then be loaded as well.
If this method is called more than once with the same library
name, the second and subsequent calls are ignored.
Parameters:
libname - the name of the library.
exception:
SecurityException - if a security manager exists and its checkLink method doesn't allow loading of the specified dynamic library
exception:
UnsatisfiedLinkError - if the library does not exist.
exception:
NullPointerException - if libname isnull
See Also: java.lang.SecurityException
See Also: java.lang.SecurityManager.checkLink(java.lang.String) |
| maxMemory | | native public long maxMemory()(Code) | | Returns the maximum amount of memory that the Java virtual machine will
attempt to use. If there is no inherent limit then the value
java.lang.Long.MAX_VALUE will be returned.
the maximum amount of memory that the virtual machine willattempt to use, measured in bytes
since:
1.4 |
| removeShutdownHook | | public boolean removeShutdownHook(Thread hook)(Code) | | De-registers a previously-registered virtual-machine shutdown hook.
Parameters:
hook - the hook to remove true if the specified hook had previously beenregistered and was successfully de-registered, falseotherwise.
throws:
IllegalStateException - If the virtual machine is already in the process of shuttingdown
throws:
SecurityException - If a security manager is present and it deniesRuntimePermission("shutdownHooks")
See Also: Runtime.addShutdownHook
See Also: Runtime.exit(int)
since:
1.3 |
| runFinalization | | public void runFinalization()(Code) | | Runs the finalization methods of any objects pending finalization.
Calling this method suggests that the Java virtual machine expend
effort toward running the finalize methods of objects
that have been found to be discarded but whose finalize
methods have not yet been run. When control returns from the
method call, the virtual machine has made a best effort to
complete all outstanding finalizations.
The virtual machine performs the finalization process
automatically as needed, in a separate thread, if the
runFinalization method is not invoked explicitly.
The method
System.runFinalization is the conventional
and convenient means of invoking this method.
See Also: java.lang.Object.finalize |
| runFinalizersOnExit | | public static void runFinalizersOnExit(boolean value)(Code) | | Enable or disable finalization on exit; doing so specifies that the
finalizers of all objects that have finalizers that have not yet been
automatically invoked are to be run before the Java runtime exits.
By default, finalization on exit is disabled.
If there is a security manager,
its checkExit method is first called
with 0 as its argument to ensure the exit is allowed.
This could result in a SecurityException.
Parameters:
value - true to enable finalization on exit, false to disable
throws:
SecurityException - if a security manager exists and its checkExit method doesn't allow the exit.
See Also: java.lang.Runtime.exit(int)
See Also: java.lang.Runtime.gc
See Also: java.lang.SecurityManager.checkExit(int)
since:
JDK1.1 |
| totalMemory | | native public long totalMemory()(Code) | | Returns the total amount of memory in the Java virtual machine.
The value returned by this method may vary over time, depending on
the host environment.
Note that the amount of memory required to hold an object of any
given type may be implementation-dependent.
the total amount of memory currently available for current and future objects, measured in bytes. |
| traceInstructions | | native public void traceInstructions(boolean on)(Code) | | Enables/Disables tracing of instructions.
If the boolean argument is true, this
method suggests that the Java virtual machine emit debugging
information for each instruction in the virtual machine as it
is executed. The format of this information, and the file or other
output stream to which it is emitted, depends on the host environment.
The virtual machine may ignore this request if it does not support
this feature. The destination of the trace output is system
dependent.
If the boolean argument is false, this
method causes the virtual machine to stop performing the
detailed instruction trace it is performing.
Parameters:
on - true to enable instruction tracing;false to disable this feature. |
| traceMethodCalls | | native public void traceMethodCalls(boolean on)(Code) | | Enables/Disables tracing of method calls.
If the boolean argument is true, this
method suggests that the Java virtual machine emit debugging
information for each method in the virtual machine as it is
called. The format of this information, and the file or other output
stream to which it is emitted, depends on the host environment. The
virtual machine may ignore this request if it does not support
this feature.
Calling this method with argument false suggests that the
virtual machine cease emitting per-call debugging information.
Parameters:
on - true to enable instruction tracing;false to disable this feature. |
|
|
