Package com.zerog.ia.api.pub

Class IASys

  • public class IASys
extends java.lang.Object

    The IASys class contains useful static class fields and methods for working with console-based interactive installer I/O.

    IASys cannot not be instantiated.

    The facilities provided by the IASys class are the installer's 'standard' input, 'standard' output, 'error' output, and 'log' output streams.

    This class should only be used with actions that extend CustomCodeConsoleAction.

    See Also:
    CustomCodeConsoleAction, ConsoleUtils

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.io.PrintStream err
      The installer's "standard" error output stream.
      static com.zerog.util.ZGSys.IAConsoleReader in
      The installer's "standard" input (similar to a BufferedReader).
      static java.io.PrintStream log
      The installer's "standard" log output stream.
      static java.io.PrintStream out
      The installer's "standard" output stream.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void setPreviousEnabled​(boolean enable)
      Enables or disables the user's ability to go back to a previous custom code console action from the current console action, depending on the value of the parameter enabled.
      static void setQuitEnabled​(boolean enable)
      Enables or disables the user's ability to quit the installer from a console prompt, depending on the value of the parameter enabled.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • out

        public static final java.io.PrintStream out

        The installer's "standard" output stream.

        See Also:
        PrintStream

      • in

        public static final com.zerog.util.ZGSys.IAConsoleReader in

        The installer's "standard" input (similar to a BufferedReader).

        IAConsoleReader in  provides a readLine() method which reads a line of text. The readLine method throws PreviousRequestException.

        A line is considered to be terminated by any one of the following: a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

        A return value of null signals an I/O Error.

        See Also:
        PreviousRequestException, CustomCodeConsoleAction.executeConsoleAction()

      • err

        public static final java.io.PrintStream err

        The installer's "standard" error output stream.

        As of the current version of IA (version 4.x), this stream is redirected to a null output stream during the normal run of an installer. When run in debug mode, output to this stream will be seen in stderr.

        See Also:
        PrintStream

      • log

        public static final java.io.PrintStream log

        The installer's "standard" log output stream.

        As of the current version of IA (version 4.x), this stream is redirected to a null output stream during the normal run of an installer. When run in debug mode, output to this stream will be seen in stderr.

        See Also:
        PrintStream

    • Method Detail

      • setPreviousEnabled

        public static void setPreviousEnabled​(boolean enable)

        Enables or disables the user's ability to go back to a previous custom code console action from the current console action, depending on the value of the parameter enabled.

        'Previous' functionality is enabled by default for each custom code console action. If an action turns off this functionality, it will automatically be reactivated for the next console action.

        Parameters:
        enable - whether the 'Previous' functionality is enabled.

      • setQuitEnabled

        public static void setQuitEnabled​(boolean enable)

        Enables or disables the user's ability to quit the installer from a console prompt, depending on the value of the parameter enabled.

        'Quit' functionality is enabled by default for each custom code console action. If an action turns off this functionality, it will automatically be reactivated for the next console action.

        Parameters:
        enable - whether the 'Quit' functionality is enabled.