Interface StatusWriter

  • Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface StatusWriter
    Writes an operation status tree in a stream. This class can be used to generate a log of operation execution, so that a developer can then analyze it on post-execution.

    It is highly recommended to use one of the default implementations (e.g. Factory.createHTML()).

    Clients may implement this interface.

    Since:
    3.5.1
    See Also:
    StatusWriter.Factory.createHTML(), Operation.getStatus()
    • Method Detail

      • write

        void write​(OperationStatus status,
                   OutputStream os)
            throws CoreException
        Writes the specified operation status into the stream.
        Parameters:
        status - the operation status
        os - the stream where to write the status information
        Throws:
        CoreException - if the status could not be written in the stream.