Package hudson.plugins.favorite

Class Favorites

java.lang.Object

hudson.plugins.favorite.Favorites

public final class Favorites
extends Object

Public API for Favorites

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Favorites.FavoriteException	Exception for Favorite operations

Constructor Summary

Constructors

Constructor	Description
Favorites()

Method Summary

Modifier and Type	Method	Description
static void	addFavorite(User user, Item item)	Add an item as a favorite for a user Fires FavoriteListener.fireOnAddFavourite(Item, User)
static Iterable<Item>	getFavorites(User user)	Get all items that the provided user has favorited
static boolean	hasFavorite(User user, Item item)	Check if the item has a favorite entry regardless of its state This is useful for checking if a favorite/unfavorite operation has ever been performed against this user
static boolean	isFavorite(User user, Item item)	Check if the item is favorited
static void	removeFavorite(User user, Item item)	Remove an item as a favorite for a user Fires FavoriteListener.fireOnRemoveFavourite(Item, User)
static boolean	toggleFavorite(User user, Item item)	Toggles the favorite for a job

Methods inherited from class java.lang.Object

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

Constructor Details

Favorites

public Favorites()

Method Details

toggleFavorite

public static boolean toggleFavorite(@NonNull
 User user,
 @NonNull
 Item item)
                              throws Favorites.FavoriteException

Toggles the favorite for a job

Parameters:

user - that the favorite belongs to

item - to favorite

Returns:

favorite state

Throws:

Favorites.FavoriteException

isFavorite

public static boolean isFavorite(@NonNull
 User user,
 @NonNull
 Item item)

Check if the item is favorited

Parameters:

user - to check

item - to check

Returns:

favorite state

hasFavorite

public static boolean hasFavorite(@NonNull
 User user,
 @NonNull
 Item item)
                           throws Favorites.FavoriteException

Check if the item has a favorite entry regardless of its state This is useful for checking if a favorite/unfavorite operation has ever been performed against this user

Parameters:

user - to check

item - to check

Returns:

favorite state

Throws:

Favorites.FavoriteException

addFavorite

public static void addFavorite(@NonNull
 User user,
 @NonNull
 Item item)
                        throws Favorites.FavoriteException

Add an item as a favorite for a user Fires FavoriteListener.fireOnAddFavourite(Item, User)

Parameters:

user - to add the favorite to

item - to favorite

Throws:

Favorites.FavoriteException

removeFavorite

public static void removeFavorite(@NonNull
 User user,
 @NonNull
 Item item)
                           throws Favorites.FavoriteException

Remove an item as a favorite for a user Fires FavoriteListener.fireOnRemoveFavourite(Item, User)

Parameters:

user - to remove the favorite from

item - to favorite

Throws:

Favorites.FavoriteException

getFavorites

public static Iterable<Item> getFavorites(@NonNull
 User user)

Get all items that the provided user has favorited

Parameters:

user - to lookup favorites for

Returns:

favorite items