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

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 user
void	onLocationChangedFavorite(Item item, User user, String oldName, String newName)	Fired when a favorite has been renamed/moved for the user
abstract void	onRemoveFavourite(Item item, User user)	Fired when a favorite has been removed for the user

Methods inherited from class java.lang.Object

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

Constructor Details

FavoriteListener

public FavoriteListener()

Method Details

all

public static Iterable<FavoriteListener> all()

fireOnAddFavourite

public static void fireOnAddFavourite(Item item,
 User user)

fireOnRemoveFavourite

public static void fireOnRemoveFavourite(Item item,
 User user)

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 favourited

user - 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 favourited

user - 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/moved

user - that the favorite was recorded for

oldName - of the favorite

newName - of the favorite