hudson.plugins.favorite.user

Class FavoriteUserProperty

java.lang.Object

hudson.model.UserProperty

hudson.plugins.favorite.user.FavoriteUserProperty

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.UserProperty>, hudson.model.ReconfigurableDescribable<hudson.model.UserProperty>

@ExportedBean(defaultVisibility=999)
public class FavoriteUserProperty
extends hudson.model.UserProperty

Do not use directly. Instead @Inject Favorites.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.model.UserPropertyDescriptor	DESCRIPTOR

Fields inherited from class hudson.model.UserProperty

user

Constructor Summary

Constructors

Constructor and Description
FavoriteUserProperty()

Method Summary

Modifier and Type	Method and Description
void	addFavorite(String job)
Set<String>	getAllFavorites()
hudson.model.UserPropertyDescriptor	getDescriptor()
List<String>	getFavorites() Deprecated.
boolean	hasFavorite(String job) Checks if the user has a favorite entry for this job e.g.
boolean	isJobFavorite(String job)
hudson.model.UserProperty	reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)
void	removeFavorite(String job)
boolean	toggleFavorite(String job)

Methods inherited from class hudson.model.UserProperty

all

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final hudson.model.UserPropertyDescriptor DESCRIPTOR

Constructor Detail

FavoriteUserProperty

@DataBoundConstructor
public FavoriteUserProperty()

Method Detail

getFavorites

@Deprecated
public List<String> getFavorites()

Deprecated.

Use {#getAllFavorites()}

Returns:

favorites

getAllFavorites

public Set<String> getAllFavorites()

addFavorite

public void addFavorite(String job)
                 throws IOException

Throws:

IOException

removeFavorite

public void removeFavorite(String job)
                    throws IOException

Throws:

IOException

toggleFavorite

public boolean toggleFavorite(String job)
                       throws IOException

Throws:

IOException

reconfigure

public hudson.model.UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req,
                                             net.sf.json.JSONObject form)
                                      throws hudson.model.Descriptor.FormException

Specified by:

reconfigure in interface hudson.model.ReconfigurableDescribable<hudson.model.UserProperty>

Overrides:

reconfigure in class hudson.model.UserProperty

Throws:

hudson.model.Descriptor.FormException

isJobFavorite

public boolean isJobFavorite(String job)

hasFavorite

public boolean hasFavorite(String job)

Checks if the user has a favorite entry for this job e.g. this is true when the user has favoriteted or unfavoriteted a job but not true for when a job has not been favorited by this user

Parameters:

job - path

Returns:

favorite

getDescriptor

public hudson.model.UserPropertyDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.UserProperty>

Overrides:

getDescriptor in class hudson.model.UserProperty