Package org.zkoss.zk.ui.util

Interface ExecutionCleanup

public interface ExecutionCleanup
Used to clean up an execution.

How this interface is used.

  1. First, you specify a class that implements this interface in WEB-INF/zk.xml as a listener.
  2. Then, even time ZK loader is destroying an execution, an instance of the specified class is instantiated and cleanup(org.zkoss.zk.ui.Execution, org.zkoss.zk.ui.Execution, java.util.List<java.lang.Throwable>) is called.
Author:
tomyeh

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanup(Execution exec, Execution parent, List<Throwable> errs)
    called when an execution is about to be destroyed.

  • Method Details

    • cleanup

      void cleanup(Execution exec, Execution parent, List<Throwable> errs) throws Exception
      called when an execution is about to be destroyed.

      If this method throws an exception, the stack trace will be logged, and the error message will be displayed at the client.

      When this method is invoked, the execution is still activated, so you can create components here.

      Parameters:
      exec - the execution to clean up.
      parent - the previous execution, or null if no previous at all
      errs - a list of exceptions (java.lang.Throwable) if any exception occurred before this method is called, or null if no exception at all. Note: you can manipulate the list directly to add or clean up exceptions. For example, if exceptions are fixed correctly, you can call errs.clear() such that no error message will be displayed at the client.
      Throws:
      Exception