Add template Javadocs. Needs actual documentation yet.

This commit is contained in:
bspeice
2013-11-20 11:55:39 -05:00
parent 6ee303e123
commit c6e0587f1d
23 changed files with 693 additions and 0 deletions

View File

@ -14,11 +14,21 @@ import android.util.Log;
import com.uncc.gameday.R;
// TODO: Auto-generated Javadoc
/**
* The Class AlertFetcher.
*/
public class AlertFetcher {
// Class responsible for fetching all alerts as necessary.
/** The max tweets. */
private int maxTweets = 5;
/**
* Fetch alerts.
*
* @param ctx the ctx
*/
public void fetchAlerts(Context ctx) {
// Fetch all alerts. Responsible for discovering what sources need to be fetched.
@ -41,6 +51,12 @@ public class AlertFetcher {
}
}
/**
* Fetch organization alerts.
*
* @param ctx the ctx
* @throws TwitterException the twitter exception
*/
private void fetchOrganizationAlerts(Context ctx) throws TwitterException {
// Process fetching organization alerts (alerts retweeted by us)
// Will not necessarily fetch `maxTweets` tweets.
@ -58,6 +74,12 @@ public class AlertFetcher {
// List contains all valid alerts now
}
/**
* Fetch university alerts.
*
* @param ctx the ctx
* @throws TwitterException the twitter exception
*/
private void fetchUniversityAlerts(Context ctx) throws TwitterException {
// Process fetching university alerts
// Guaranteed to get `maxTweets` tweets
@ -68,6 +90,12 @@ public class AlertFetcher {
// List contains all valid alerts now
}
/**
* Fetch gameday alerts.
*
* @param ctx the ctx
* @throws TwitterException the twitter exception
*/
private void fetchGamedayAlerts(Context ctx) throws TwitterException {
// Process fetching alerts generated by staff of UNCCGameDay
// Not guaranteed to get `maxTweets` tweets
@ -86,6 +114,12 @@ public class AlertFetcher {
}
/**
* Creates the timed alerts.
*
* @param ctx the ctx
* @return the list
*/
public static List<Alert> createTimedAlerts(Context ctx) {
// Create the timed alerts so we can add or remove them from the DB
return null;