Package com.zerog.ia.api.pub

Class PreviousRequestException

  • All Implemented Interfaces:
    java.io.Serializable
    public class PreviousRequestException
extends java.lang.Exception

    Thrown when the end-user of a console-based interactive installer requests that the installer return to a previous console step.

    This exception may be thrown by any method that directly or indirectly invokes ZGSys$IAConsoleReader.readLine(). This includes the following examples:

    IASys.in.readLine()
    ConsoleUtils.enterToContinue()
    ConsoleUtils.promptAndGetValue()
    ConsoleUtils.createChoiceListAndGetValue()
    ConsoleUtils.createChoiceListAndGetMultipleValues
    etc.

    If this exception is allowed to propagate out of the custom code console action, it will cause the installer to attempt to proceed back to a previous step in the installation.

    An action can 'veto' the request to proceed to a previous step by catching the exception and not rethrowing it. If an action wants to be notified of a previous request from the end-user (e.g., to perform some clean up), it should first catch the exception, do whatever processing is needed, and then rethrow the exception.

    To facilitate the ease of use of this method of previous request notification, CustomCodeConsoleAction.executeConsoleAction() throws PreviousRequestException. Therefore, it is not necessary to catch this exception from within this method if the console action does not have an objection to the installer proceeding to a previous step

    See Also:
    CustomCodeConsoleAction.executeConsoleAction(), Serialized Form

    • Method Summary

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PreviousRequestException

        public PreviousRequestException()
        Constructor

      • PreviousRequestException

        public PreviousRequestException​(java.lang.String s)
        Constructor