JBoss STDIO 1.0.0.GA

org.jboss.stdio
Class StdioContext

java.lang.Object
  extended by org.jboss.stdio.StdioContext

public final class StdioContext
extends Object

A context for console input and output.


Method Summary
static StdioContext create(InputStream in, OutputStream out, OutputStream err)
          Create a console I/O context.
static StdioContext create(InputStream in, PrintStream out, PrintStream err)
          Create a console I/O context.
 PrintStream getErr()
          Get the error stream for this context.
 InputStream getIn()
          Get the input stream for this context.
 PrintStream getOut()
          Get the output stream for this context.
static StdioContext getStdioContext()
          Get the current console I/O context.
static void install()
          Install the StdioContext streams.
static void setStdioContextSelector(StdioContextSelector stdioContextSelector)
          Set the standard I/O context selector.
static void uninstall()
          Uninstall the StdioContext streams.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static StdioContext create(InputStream in,
                                  PrintStream out,
                                  PrintStream err)
                           throws SecurityException
Create a console I/O context.

Parameters:
in - the input stream for this context
out - the output stream for this context
err - the error stream for this context
Returns:
the new context
Throws:
SecurityException - if the caller does not have the createStdioContext RuntimePermission

create

public static StdioContext create(InputStream in,
                                  OutputStream out,
                                  OutputStream err)
                           throws SecurityException
Create a console I/O context. The given output streams are wrapped in PrintStream instances.

Parameters:
in - the input stream for this context
out - the output stream for this context
err - the error stream for this context
Returns:
the new context
Throws:
SecurityException - if the caller does not have the createStdioContext RuntimePermission

getStdioContext

public static StdioContext getStdioContext()
Get the current console I/O context.

Returns:
the current context

getIn

public InputStream getIn()
Get the input stream for this context.

Returns:
the input stream

getOut

public PrintStream getOut()
Get the output stream for this context.

Returns:
the output stream

getErr

public PrintStream getErr()
Get the error stream for this context.

Returns:
the error stream

install

public static void install()
                    throws SecurityException,
                           IllegalStateException
Install the StdioContext streams.

Throws:
SecurityException - if the caller does not have the installStdioContextSelector RuntimePermission
IllegalStateException - if the streams are already installed

uninstall

public static void uninstall()
                      throws SecurityException,
                             IllegalStateException
Uninstall the StdioContext streams.

Throws:
SecurityException - if the caller does not have the installStdioContextSelector RuntimePermission
IllegalStateException - if the streams are already uninstalled

setStdioContextSelector

public static void setStdioContextSelector(StdioContextSelector stdioContextSelector)
                                    throws SecurityException
Set the standard I/O context selector. You must have the setStdioContextSelector RuntimePermission in order to invoke this method.

Parameters:
stdioContextSelector - the selector to use
Throws:
SecurityException - if the caller does not have the installStdioContextSelector RuntimePermission

JBoss STDIO 1.0.0.GA

Copyright © 2010 JBoss, a division of Red Hat, Inc.