org.gradle.openapi.external.foundation.favorites

Interface FavoritesEditorVersion1

All Known Implementing Classes:

FavoritesEditorWrapper

public interface FavoritesEditorVersion1

This is an abstraction from Gradle that allows you to obtain and edit favorites.

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

Author:

mhunsicker

Method Summary

Methods

Modifier and Type	Method and Description
FavoriteTaskVersion1	addFavorite(java.lang.String fullCommandLine, java.lang.String displayName, boolean alwaysShowOutput) Adds the specified favorite.
java.lang.String	editFavorite(FavoriteTaskVersion1 favoriteTask, java.lang.String newFullCommandLine, java.lang.String newDisplayName, boolean newAlwaysShowOutput) Sets new values on the specified favorite task.
FavoriteTaskVersion1	getFavorite(java.lang.String fullCommandLine) Returns the favorite with the specified command line
FavoriteTaskVersion1	getFavorite(TaskVersion1 task) Returns the favorite with the specified task
FavoriteTaskVersion1	getFavoriteByDisplayName(java.lang.String displayName) Returns the favorite with the specified display name
java.util.List<FavoriteTaskVersion1>	getFavoriteTasks()
FavoriteTaskVersion1	promptUserToAddFavorite(java.awt.Window parent) Display a Swing dialog prompting the user to enter a favorite.
boolean	promptUserToEditFavorite(java.awt.Window parent, FavoriteTaskVersion1 favorite) Display a Swing dialog prompting the user to edit the specified favorite
void	removeFavorites(java.util.List<FavoriteTaskVersion1> favoritesToRemove) Removes the specified favorites.

Method Detail

addFavorite

FavoriteTaskVersion1 addFavorite(java.lang.String fullCommandLine,
                               java.lang.String displayName,
                               boolean alwaysShowOutput)

Adds the specified favorite.

Parameters:

fullCommandLine - the command line that this favorite executes

displayName - a more user-friendly name for the command

alwaysShowOutput - true to always show output when this favorite is executed. False to only show output when errors occur.

Returns:

the favorite added

editFavorite

java.lang.String editFavorite(FavoriteTaskVersion1 favoriteTask,
                            java.lang.String newFullCommandLine,
                            java.lang.String newDisplayName,
                            boolean newAlwaysShowOutput)

Sets new values on the specified favorite task. This provides a simple way to programmatically edit favorite tasks.

Parameters:

favoriteTask - the favorite to edit

newFullCommandLine - the new command line

newDisplayName - the new display name

newAlwaysShowOutput - the new value for whether or not to always show output (vs only showing it when an error occurs).

getFavoriteTasks

java.util.List<FavoriteTaskVersion1> getFavoriteTasks()

Returns:

a list of all favorites in the system

getFavorite

FavoriteTaskVersion1 getFavorite(java.lang.String fullCommandLine)

Returns the favorite with the specified command line

Parameters:

fullCommandLine - the command line of the sought favorite

Returns:

the matching favorite or null if no match found.

getFavoriteByDisplayName

FavoriteTaskVersion1 getFavoriteByDisplayName(java.lang.String displayName)

Returns the favorite with the specified display name

Parameters:

displayName - the display name of the sought favorite

Returns:

the matching favorite or null if no match found.

getFavorite

FavoriteTaskVersion1 getFavorite(TaskVersion1 task)

Returns the favorite with the specified task

Parameters:

task - the task of the sought favorite

Returns:

the matching favorite or null if no match found.

promptUserToAddFavorite

FavoriteTaskVersion1 promptUserToAddFavorite(java.awt.Window parent)

Display a Swing dialog prompting the user to enter a favorite.

Parameters:

parent - the parent window of the dialog.

Returns:

the favorite that was added or null if the user canceled

promptUserToEditFavorite

boolean promptUserToEditFavorite(java.awt.Window parent,
                               FavoriteTaskVersion1 favorite)

Display a Swing dialog prompting the user to edit the specified favorite

Parameters:

parent - the parent window of the dialog

favorite - the favorite to edit

Returns:

true if the user made changes and accepted them, false if the user canceled.

removeFavorites

void removeFavorites(java.util.List<FavoriteTaskVersion1> favoritesToRemove)

Removes the specified favorites.

Parameters:

favoritesToRemove - the favorites to remove