org.gradle.gradleplugin.foundation.favorites

Class FavoritesEditor

java.lang.Object

org.gradle.gradleplugin.foundation.favorites.FavoritesEditor

All Implemented Interfaces:

SettingsSerializable

public class FavoritesEditor
extends Object
implements SettingsSerializable

This holds onto and edits favorite tasks. 'Favorite tasks' provides a quick way to run frequently used tasks.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FavoritesEditor.AddMultipleFavoritesInteraction
static class	FavoritesEditor.AddMultipleResult
static interface	FavoritesEditor.EditFavoriteInteraction
class	FavoritesEditor.EditibleFavoriteTask This is what you actually edit when you want to edit a favorite.
static interface	FavoritesEditor.FavoriteTasksObserver
static interface	FavoritesEditor.ValidationInteraction

Constructor Summary

Constructors

Constructor and Description
FavoritesEditor()

Method Summary

Methods

Modifier and Type	Method and Description
FavoriteTask	addFavorite(FavoritesEditor.EditFavoriteInteraction addFavoriteInteraction) Call this to add a favorite that isn't in the task list.
FavoriteTask	addFavorite(String fullCommandLine, boolean alwaysShowOutput)
FavoriteTask	addFavorite(String fullCommandLine, String displayName, boolean alwaysShowOutput)
FavoriteTask	addFavorite(TaskView task, boolean alwaysShowOutput)
void	addFavorites(List<TaskView> tasks, boolean alwaysShowOutput) Call this to add the specified tasks as favorite tasks
void	addFavoriteTasksObserver(FavoritesEditor.FavoriteTasksObserver observer, boolean inEventQueue)
void	addMutlipleFavorites(List<TaskView> tasks, boolean alwaysShowOutput, FavoritesEditor.AddMultipleFavoritesInteraction interaction) Call this to add tasks as favorites.
static String	combineFavoriteCommandLines(List<FavoriteTask> favoriteTasks) This combines all the command lines of the favorites list into a single command line.
FavoriteTask	duplicateFavorite(FavoriteTask taskToCopy, FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction) This makes a copy of the selected task.
void	duplicateFavorites(List<FavoriteTask> tasksToCopy, FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction) This makes a copy of all the selected tasks.
boolean	editFavorite(FavoriteTask favoriteTask, FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction) Edits the specified favorite task.
void	exportToFile(DOM4JSerializer.ExportInteraction exportInteraction) Call this to save favorites to a file.
FavoriteTask	getFavorite(String fullCommandLine)
FavoriteTask	getFavorite(TaskView task)
FavoriteTask	getFavoriteByDisplayName(String displayName)
List<FavoriteTask>	getFavoriteTasks()
boolean	importFromFile(DOM4JSerializer.ImportInteraction importInteraction) Call this to read favorites from a file.
void	moveFavoritesAfter(List<FavoriteTask> favoritesToMove)
void	moveFavoritesBefore(List<FavoriteTask> favoritesToMove) This moves the specified favorites up.
void	removeFavorites(List<FavoriteTask> favoritesToRemove) Call this to remove the specified favorites from the favorite tasks.
void	removeFavoriteTasksObserver(FavoritesEditor.FavoriteTasksObserver observer)
void	serializeIn(SettingsNode settings) Call this to read in this object's settings.
void	serializeOut(SettingsNode settings) Call this to saves the current settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

FavoritesEditor

public FavoritesEditor()

Method Detail

getFavoriteTasks

public List<FavoriteTask> getFavoriteTasks()

addFavoriteTasksObserver

public void addFavoriteTasksObserver(FavoritesEditor.FavoriteTasksObserver observer,
                            boolean inEventQueue)

removeFavoriteTasksObserver

public void removeFavoriteTasksObserver(FavoritesEditor.FavoriteTasksObserver observer)

getFavorite

public FavoriteTask getFavorite(String fullCommandLine)

getFavoriteByDisplayName

public FavoriteTask getFavoriteByDisplayName(String displayName)

getFavorite

public FavoriteTask getFavorite(TaskView task)

addMutlipleFavorites

public void addMutlipleFavorites(List<TaskView> tasks,
                        boolean alwaysShowOutput,
                        FavoritesEditor.AddMultipleFavoritesInteraction interaction)

Call this to add tasks as favorites. If you pass in multiple tasks, we'll prompt the user whether or not the tasks should be added as one favorite with multiple tasks or separate tasks.

Parameters:

tasks - the tasks to add. Their order in the list becomes the order in the single task if the user chooses this.

interaction - how we interact with the user or other UI.

addFavorite

public FavoriteTask addFavorite(TaskView task,
                       boolean alwaysShowOutput)

addFavorite

public FavoriteTask addFavorite(String fullCommandLine,
                       boolean alwaysShowOutput)

addFavorite

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

addFavorites

public void addFavorites(List<TaskView> tasks,
                boolean alwaysShowOutput)

Call this to add the specified tasks as favorite tasks

Parameters:

tasks - the task to make a favorite.

addFavorite

public FavoriteTask addFavorite(FavoritesEditor.EditFavoriteInteraction addFavoriteInteraction)

Call this to add a favorite that isn't in the task list. This exists because you can add functionality to gradle that isn't really a task.

Parameters:

addFavoriteInteraction - allows us to interact with the user

Returns:

the favorite that was added, or null if the user canceled

editFavorite

public boolean editFavorite(FavoriteTask favoriteTask,
                   FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction)

Edits the specified favorite task.

Parameters:

favoriteTask - the task to edit.

editFavoriteInteraction - how we interact with the user

Returns:

true if we made changes, false if not.

removeFavorites

public void removeFavorites(List<FavoriteTask> favoritesToRemove)

Call this to remove the specified favorites from the favorite tasks.

Parameters:

favoritesToRemove - the favorite tasks to remove

moveFavoritesBefore

public void moveFavoritesBefore(List<FavoriteTask> favoritesToMove)

This moves the specified favorites up.

Parameters:

favoritesToMove - .

moveFavoritesAfter

public void moveFavoritesAfter(List<FavoriteTask> favoritesToMove)

exportToFile

public void exportToFile(DOM4JSerializer.ExportInteraction exportInteraction)

Call this to save favorites to a file.

importFromFile

public boolean importFromFile(DOM4JSerializer.ImportInteraction importInteraction)

Call this to read favorites from a file. I'm going to use FavoritesSerializable rather than ourselves (even though we're a JDOMSerializable) so if something goes wrong, we won't wipe out our current settings.

serializeOut

public void serializeOut(SettingsNode settings)

Call this to saves the current settings.

Specified by:

serializeOut in interface SettingsSerializable

Parameters:

settings - where you save the settings.

serializeIn

public void serializeIn(SettingsNode settings)

Call this to read in this object's settings. The reverse of serializeOut.

Specified by:

serializeIn in interface SettingsSerializable

Parameters:

settings - where you read your settings.

duplicateFavorites

public void duplicateFavorites(List<FavoriteTask> tasksToCopy,
                      FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction)

This makes a copy of all the selected tasks.

Parameters:

tasksToCopy - the tasks to copy

duplicateFavorite

public FavoriteTask duplicateFavorite(FavoriteTask taskToCopy,
                             FavoritesEditor.EditFavoriteInteraction editFavoriteInteraction)

This makes a copy of the selected task.

Parameters:

taskToCopy - the task to copy

combineFavoriteCommandLines

public static String combineFavoriteCommandLines(List<FavoriteTask> favoriteTasks)

This combines all the command lines of the favorites list into a single command line. This is useful for allowing a user to execute multiple favorites at once. Note: this doesn't do anything intelligent by trying to weed out duplicates. Gradle handles that nicely already.

Parameters:

favoriteTasks - the favorite tasks to combine

Returns:

a single String of all the command combined.