org.gradle.openapi.wrappers.foundation.favorites

Class FavoritesEditorWrapper

java.lang.Object

org.gradle.openapi.wrappers.foundation.favorites.FavoritesEditorWrapper

All Implemented Interfaces:

FavoritesEditorVersion1

public class FavoritesEditorWrapper
extends Object
implements FavoritesEditorVersion1

Implementation of FavoritesEditorVersion1 meant to help shield external users from internal changes.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
FavoritesEditorWrapper(FavoritesEditor favoritesEditor)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FavoritesEditorWrapper

public FavoritesEditorWrapper(FavoritesEditor favoritesEditor)

Method Detail

addFavorite

public FavoriteTaskVersion1 addFavorite(String fullCommandLine,
                               String displayName,
                               boolean alwaysShowOutput)

Description copied from interface: FavoritesEditorVersion1

Adds the specified favorite.

Specified by:

addFavorite in interface FavoritesEditorVersion1

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

public String editFavorite(FavoriteTaskVersion1 favoriteTaskVersion1,
                  String newFullCommandLine,
                  String newDisplayName,
                  boolean newAlwaysShowOutput)

Description copied from interface: FavoritesEditorVersion1

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

Specified by:

editFavorite in interface FavoritesEditorVersion1

Parameters:

favoriteTaskVersion1 - 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

public List<FavoriteTaskVersion1> getFavoriteTasks()

Specified by:

getFavoriteTasks in interface FavoritesEditorVersion1

Returns:

a list of all favorites in the system

getFavorite

public FavoriteTaskVersion1 getFavorite(String fullCommandLine)

Description copied from interface: FavoritesEditorVersion1

Returns the favorite with the specified command line

Specified by:

getFavorite in interface FavoritesEditorVersion1

Parameters:

fullCommandLine - the command line of the sought favorite

Returns:

the matching favorite or null if no match found.

getFavoriteByDisplayName

public FavoriteTaskVersion1 getFavoriteByDisplayName(String displayName)

Description copied from interface: FavoritesEditorVersion1

Returns the favorite with the specified display name

Specified by:

getFavoriteByDisplayName in interface FavoritesEditorVersion1

Parameters:

displayName - the display name of the sought favorite

Returns:

the matching favorite or null if no match found.

getFavorite

public FavoriteTaskVersion1 getFavorite(TaskVersion1 task)

Description copied from interface: FavoritesEditorVersion1

Returns the favorite with the specified task

Specified by:

getFavorite in interface FavoritesEditorVersion1

Parameters:

task - the task of the sought favorite

Returns:

the matching favorite or null if no match found.

promptUserToAddFavorite

public FavoriteTaskVersion1 promptUserToAddFavorite(Window parent)

Description copied from interface: FavoritesEditorVersion1

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

Specified by:

promptUserToAddFavorite in interface FavoritesEditorVersion1

Parameters:

parent - the parent window of the dialog.

Returns:

the favorite that was added or null if the user canceled

promptUserToEditFavorite

public boolean promptUserToEditFavorite(Window parent,
                               FavoriteTaskVersion1 favorite)

Description copied from interface: FavoritesEditorVersion1

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

Specified by:

promptUserToEditFavorite in interface FavoritesEditorVersion1

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

public void removeFavorites(List<FavoriteTaskVersion1> favoritesToRemove)

Description copied from interface: FavoritesEditorVersion1

Removes the specified favorites.

Specified by:

removeFavorites in interface FavoritesEditorVersion1

Parameters:

favoritesToRemove - the favorites to remove