Added more JavaDocs

This commit is contained in:
Steffen Schaefer committed 2016-07-12 10:23:15 +02:00
1 parent a1e9e8b1ea
commit 786488b28b
5 files changed
+27 -2

No files matched your search

@@ -12,13 +12,18 @@ import com.sap.sailing.server.impl.preferences.model.BoatClassNotificationPrefer
import com.sap.sse.security.PreferenceObjectBasedNotificationSet;
import com.sap.sse.security.UserStore;
/**
* {@link PreferenceObjectBasedNotificationSet} for associations of {@link BoatClass} to a set of users to notify about
* specific events for the {@link BoatClass}. Subclasses define the concrete case of notification based on the flags in
* {@link BoatClassNotificationPreference} via implementing {@link #shouldNotifyFor(BoatClassNotificationPreference)}.
*/
public abstract class AbstractBoatClassNotificationSet
extends PreferenceObjectBasedNotificationSet<BoatClassNotificationPreferences, BoatClass> {
public AbstractBoatClassNotificationSet(UserStore store) {
super(BoatClassNotificationPreferences.PREF_NAME, store);
}
/**
* Constructor used to automatically track {@link UserStore} as OSGi service.
*/
@@ -12,13 +12,18 @@ import com.sap.sailing.server.impl.preferences.model.CompetitorNotificationPrefe
import com.sap.sse.security.PreferenceObjectBasedNotificationSet;
import com.sap.sse.security.UserStore;
/**
* {@link PreferenceObjectBasedNotificationSet} for associations of {@link Competitor} to a set of users to notify about
* specific events for the {@link Competitor}. Subclasses define the concrete case of notification based on the flags in
* {@link CompetitorNotificationPreference} via implementing {@link #shouldNotifyFor(CompetitorNotificationPreference)}.
*/
public abstract class AbstractCompetitorNotificationSet
extends PreferenceObjectBasedNotificationSet<CompetitorNotificationPreferences, Competitor> {
public AbstractCompetitorNotificationSet(UserStore store) {
super(CompetitorNotificationPreferences.PREF_NAME, store);
}
/**
* Constructor used to automatically track {@link UserStore} as OSGi service.
*/
@@ -2,9 +2,14 @@ package com.sap.sailing.server.impl.preferences;
import org.osgi.framework.BundleContext;
import com.sap.sailing.domain.base.BoatClass;
import com.sap.sailing.server.impl.preferences.model.BoatClassNotificationPreference;
import com.sap.sse.security.UserStore;
/**
* Notification set that defines the association of a {@link BoatClass} to the set of Users that need to be notified
* whenever new results are available for a {@link BoatClass}.
*/
public class BoatClassResultsNotificationSet extends AbstractBoatClassNotificationSet {
public BoatClassResultsNotificationSet(UserStore store) {
@@ -2,9 +2,14 @@ package com.sap.sailing.server.impl.preferences;
import org.osgi.framework.BundleContext;
import com.sap.sailing.domain.base.BoatClass;
import com.sap.sailing.server.impl.preferences.model.BoatClassNotificationPreference;
import com.sap.sse.security.UserStore;
/**
* Notification set that defines the association of a {@link BoatClass} to the set of Users that need to be notified
* whenever a race is known to start in the near future for a {@link BoatClass}.
*/
public class BoatClassUpcomingRaceNotificationSet extends AbstractBoatClassNotificationSet {
public BoatClassUpcomingRaceNotificationSet(UserStore store) {
@@ -2,9 +2,14 @@ package com.sap.sailing.server.impl.preferences;
import org.osgi.framework.BundleContext;
import com.sap.sailing.domain.base.Competitor;
import com.sap.sailing.server.impl.preferences.model.CompetitorNotificationPreference;
import com.sap.sse.security.UserStore;
/**
* Notification set that defines the association of a {@link Competitor} to the set of Users that need to be notified
* whenever new results are available for a {@link Competitor}.
*/
public class CompetitorResultsNotificationSet extends AbstractCompetitorNotificationSet {
public CompetitorResultsNotificationSet(UserStore store) {