org.gradle.openapi.external.ui

Interface OutputObserverVersion1

public interface OutputObserverVersion1

This interface informs you when the output pane is displaying requests. This is NOT for general output of gradle commands.

This is a mirror of OutputUILord.OutputObserver inside Gradle, but this is meant to aid backward and forward compatibility by shielding you from direct changes within gradle.

Method Summary

Methods

Modifier and Type	Method and Description
void	executionRequestAdded(long requestID, String fullCommandLine, String displayName, boolean forceOutputToBeShown) Notification that a request was added to the output.
void	outputTabClosed(long requestID) Notification that an output tab was closed, possibly because it was canceled.
void	refreshRequestAdded(long requestID, boolean forceOutputToBeShown) Notification that a refresh task list request was added to the output.
void	requestComplete(long requestID, boolean wasSuccessful) Notification that a request is complete.

Method Detail

executionRequestAdded

void executionRequestAdded(long requestID,
                         String fullCommandLine,
                         String displayName,
                         boolean forceOutputToBeShown)

Notification that a request was added to the output. This means we've got some output that is useful to display.

Parameters:

requestID - an ID you can use to identify this request when it is complete.

fullCommandLine - the command line for the request that was added

displayName - the display name of this command (often the same as the full command line)

forceOutputToBeShown - true if this request wants to force its output to be shown

refreshRequestAdded

void refreshRequestAdded(long requestID,
                       boolean forceOutputToBeShown)

Notification that a refresh task list request was added to the output. This means we've got some output that is useful to display.

Parameters:

requestID - an ID you can use to identify this request when it is complete.

forceOutputToBeShown - true if this request wants to force its output to be shown

requestComplete

void requestComplete(long requestID,
                   boolean wasSuccessful)

Notification that a request is complete. Note: if its canceled, you'll just get an outputTabClosed notification.

Parameters:

requestID - the ID of the request that is complete. It is given to you in executionRequestAdded or refreshRequestAdded.

wasSuccessful - true if was successful, false if not or was cancelled.

outputTabClosed

void outputTabClosed(long requestID)

Notification that an output tab was closed, possibly because it was canceled. You might want to know this if you want to close your IDE output window when all tabs are closed.

Parameters:

requestID - the ID of the request associated with this tab. It is given to you in executionRequestAdded or refreshRequestAdded.