org.gradle.openapi.wrappers.ui

Class AlternateUIInteractionVersionWrapper

java.lang.Object

org.gradle.openapi.wrappers.ui.AlternateUIInteractionVersionWrapper

All Implemented Interfaces:

AlternateUIInteraction

public class AlternateUIInteractionVersionWrapper
extends Object
implements AlternateUIInteraction

Wrapper to shield version changes in AlternateUIInteraction from an external user of gradle open API.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
AlternateUIInteractionVersionWrapper(AlternateUIInteractionVersion1 alternateUIInteractionVersion1, SettingsNode settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToExecuteCommand(String fullCommandLine)
boolean	doesSupportEditingOpeningFiles() Determines if we can call editFile or openFile.
void	editFile(File file, int line)
void	openFile(File file, int line) Notification that you should open the specified file and go to the specified line.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlternateUIInteractionVersionWrapper

public AlternateUIInteractionVersionWrapper(AlternateUIInteractionVersion1 alternateUIInteractionVersion1,
                                    SettingsNode settings)

Method Detail

openFile

public void openFile(File file,
            int line)

Description copied from interface: AlternateUIInteraction

Notification that you should open the specified file and go to the specified line. Its up to the application to determine if this file should be opened for editing or simply displayed. The difference comes into play for things like xml or html files where a user may want to open them in a browser vs a source code file where they may want to open it directly in an IDE.

Specified by:

openFile in interface AlternateUIInteraction

Parameters:

file - the file to opened

line - the line to go to. -1 if no line is specified.

editFile

public void editFile(File file,
            int line)

Specified by:

editFile in interface AlternateUIInteraction

doesSupportEditingOpeningFiles

public boolean doesSupportEditingOpeningFiles()

Description copied from interface: AlternateUIInteraction

Determines if we can call editFile or openFile. This is not a dynamic answer and should always return either true of false. If you want to change the answer, return true and then handle the files differently in editFiles.

Specified by:

doesSupportEditingOpeningFiles in interface AlternateUIInteraction

Returns:

true if support editing files, false otherwise.

aboutToExecuteCommand

public void aboutToExecuteCommand(String fullCommandLine)