Package hudson.plugins.favorite.listener
Class FavoriteListener
- java.lang.Object
-
- hudson.plugins.favorite.listener.FavoriteListener
-
- All Implemented Interfaces:
ExtensionPoint
public abstract class FavoriteListener extends Object implements ExtensionPoint
Allows plugins to listen to favoriting
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description FavoriteListener()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static Iterable<FavoriteListener>
all()
static void
fireOnAddFavourite(Item item, User user)
static void
fireOnLocationChangedFavorite(Item item, User user, String oldName, String newName)
static void
fireOnRemoveFavourite(Item item, User user)
abstract void
onAddFavourite(Item item, User user)
Fired when a favorite has been addedfor the uservoid
onLocationChangedFavorite(Item item, User user, String oldName, String newName)
Fired when a favorite has been renamed/moved for the userabstract void
onRemoveFavourite(Item item, User user)
Fired when a favorite has been removed for the user
-
-
-
Method Detail
-
all
public static Iterable<FavoriteListener> all()
-
fireOnLocationChangedFavorite
public static void fireOnLocationChangedFavorite(Item item, User user, String oldName, String newName)
-
onAddFavourite
public abstract void onAddFavourite(Item item, User user)
Fired when a favorite has been addedfor the user- Parameters:
item
- that was favouriteduser
- that the favorite was recorded for
-
onRemoveFavourite
public abstract void onRemoveFavourite(Item item, User user)
Fired when a favorite has been removed for the user- Parameters:
item
- that was favouriteduser
- that the favorite was recorded for
-
onLocationChangedFavorite
public void onLocationChangedFavorite(Item item, User user, String oldName, String newName)
Fired when a favorite has been renamed/moved for the user- Parameters:
item
- that was renamed/moveduser
- that the favorite was recorded foroldName
- of the favoritenewName
- of the favorite
-
-