Added custom exceptions and CTA interface

Author: widavies

src/main/java/main/CTBA.java

@@ -13,6 +13,7 @@
 import models.standard.Match;
 import models.standard.Team;
 import requests.*;
+import utils.Constants;
 
 /**
  * This is the main interface for the API, let's talk about that.
@@ -45,6 +46,15 @@ public TBA() {
         tr = new TeamRequest();
     }
 
+    /**
+     * Sets the authentication token for the API, required for all calls!
+     * Obtain an auth token from your account page on thebluealliance.com
+     * @param authToken the auth token to set
+     */
+    public static void setAuthToken(String authToken) {
+        Constants.AUTH_TOKEN = authToken;
+    }
+
     /**
      * Mirror of: /district/{district_key}/teams
      *

src/main/java/main/TBA.java

@@ -33,7 +33,7 @@ public class Event extends SEvent {
     /**
      * The FIRST internal Event ID, used to link to the event on the FRC webpage.
      */
-    private long firstEventID;
+    private String firstEventID;
     /**
      * The TBA Event key that represents the event’s parent. Used to link back to the event from a division event. It is also the inverse relation of divison_keys.
      */

src/main/java/models/standard/Event.java

@@ -9,6 +9,7 @@
 import utils.IO;
 import utils.Parser;
 import utils.Utils;
+import utils.exceptions.DataNotFoundException;
 
 /**
  * In an attempt to keep this API organized, if you look at the blue alliance v3 documentation, all calls that start with /district/ or /districts/
@@ -30,7 +31,7 @@ public class DistrictRequest extends Parser {
      */
     public Team[] getDistrictTeams(String districtKey) {
         JSONArray teams = (JSONArray) IO.doRequest("district/"+districtKey+"/teams");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any teams in district with key: "+districtKey);
         Team[] toGet = new Team[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseTeam(teams.get(i));
         return toGet;
@@ -44,7 +45,7 @@ public Team[] getDistrictTeams(String districtKey) {
      */
     public STeam[] getDistrictSTeams(String districtKey) {
         JSONArray teams = (JSONArray) IO.doRequest("district/"+districtKey+"/teams/simple");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any simple teams in district with key: "+districtKey);
         STeam[] toGet = new STeam[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseSTeam(teams.get(i));
         return toGet;
@@ -59,6 +60,7 @@ public STeam[] getDistrictSTeams(String districtKey) {
      */
     public String[] getDistrictTeamKeys(String districtKey) {
         JSONArray keys = (JSONArray) IO.doRequest("district/"+districtKey+"/teams/keys");
+        if(keys == null) throw new DataNotFoundException("Couldn't find any team keys in district with key: "+districtKey);
         return Utils.jsonArrayToStringArray(keys);
     }
 
@@ -70,7 +72,7 @@ public String[] getDistrictTeamKeys(String districtKey) {
      */
     public Event[] getDistrictEvents(String districtKey) {
         JSONArray teams = (JSONArray) IO.doRequest("district/"+districtKey+"/events");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any events in district with key: "+districtKey);
         Event[] toGet = new Event[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseEvent(teams.get(i));
         return toGet;
@@ -84,7 +86,7 @@ public Event[] getDistrictEvents(String districtKey) {
      */
     public SEvent[] getDistrictSEvents(String districtKey) {
         JSONArray teams = (JSONArray) IO.doRequest("district/"+districtKey+"/events/simple");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any simple events in district with key: "+districtKey);
         SEvent[] toGet = new SEvent[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseSEvent(teams.get(i));
         return toGet;
@@ -99,6 +101,7 @@ public SEvent[] getDistrictSEvents(String districtKey) {
      */
     public String[] getDistrictEventKeys(String districtKey) {
         JSONArray keys = (JSONArray) IO.doRequest("district/"+districtKey+"/events/keys");
+        if(keys == null) throw new DataNotFoundException("Couldn't find any event keys in district with key: "+districtKey);
         return Utils.jsonArrayToStringArray(keys);
     }
 
@@ -111,7 +114,7 @@ public String[] getDistrictEventKeys(String districtKey) {
      */
     public District[] getDistricts(int year) {
         JSONArray districts = (JSONArray) IO.doRequest("districts/"+year);
-        if(districts == null) return null;
+        if(districts == null) throw new DataNotFoundException("Couldn't find any districts in year: "+year);
         District[] toReturn = new District[districts.size()];
         for(int i = 0; i < districts.size(); i++) toReturn[i] = parseDistrict(districts.get(i));
         return toReturn;

src/main/java/requests/DistrictRequest.java

@@ -12,6 +12,9 @@
 import utils.IO;
 import utils.Parser;
 import utils.Utils;
+import utils.exceptions.DataNotFoundException;
+
+import javax.xml.crypto.Data;
 
 /**
  * In an attempt to keep this API organized, if you look at the blue alliance v3 documentation, all calls that start with /events/ or /event/
@@ -37,7 +40,7 @@ public class EventRequest extends Parser {
      */
     public Team[] getEventTeams(String eventKey) {
         JSONArray teams = (JSONArray) IO.doRequest("event/"+eventKey+"/teams");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any teams in event with key: "+eventKey);
         Team[] toGet = new Team[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseTeam(teams.get(i));
         return toGet;
@@ -52,7 +55,7 @@ public Team[] getEventTeams(String eventKey) {
      */
     public STeam[] getSEventTeams(String eventKey) {
         JSONArray teams = (JSONArray) IO.doRequest("event/"+eventKey+"/teams/simple");
-        if(teams == null) return null;
+        if(teams == null) throw new DataNotFoundException("Couldn't find any simple teams in event with key: "+eventKey);
         STeam[] toGet = new STeam[teams.size()];
         for(int i = 0; i < teams.size(); i++) toGet[i] = parseSTeam(teams.get(i));
         return toGet;
@@ -67,6 +70,7 @@ public STeam[] getSEventTeams(String eventKey) {
      */
     public String[] getTeamKeys(String eventKey) {
         JSONArray keys = (JSONArray) IO.doRequest("event/"+eventKey+"/teams/keys");
+        if(keys == null) throw new DataNotFoundException("Couldn't find any team keys in event with key: "+eventKey);
         return Utils.jsonArrayToStringArray(keys);
     }
 
@@ -79,7 +83,7 @@ public String[] getTeamKeys(String eventKey) {
      */
     public Event[] getEvents(int year) {
         JSONArray events = (JSONArray) IO.doRequest("events/"+year);
-        if(events == null) return null;
+        if(events == null) throw new DataNotFoundException("Couldn't find any events in year: "+year);
         Event[] toGet = new Event[events.size()];
         for(int i = 0; i < events.size(); i++) toGet[i] = parseEvent(events.get(i));
         return toGet;
@@ -93,8 +97,8 @@ public Event[] getEvents(int year) {
      * @return SEvent[] containing all the events in the specified year
      */
     public SEvent[] getSEvents(int year) {
-        JSONArray events = (JSONArray) IO.doRequest("events/"+"year/simple");
-        if(events == null) return null;
+        JSONArray events = (JSONArray) IO.doRequest("events/"+year+"/simple");
+        if(events == null) throw new DataNotFoundException("Couldn't find any simple events in year: "+year);
         SEvent[] toGet = new SEvent[events.size()];
         for(int i = 0; i < events.size(); i++) toGet[i] = parseSEvent(events.get(i));
         return toGet;
@@ -109,6 +113,7 @@ public SEvent[] getSEvents(int year) {
      */
     public String[] getEventKeys(int year) {
         JSONArray keys = (JSONArray) IO.doRequest("events/"+year+"/keys");
+        if(keys == null) throw new DataNotFoundException("Couldn't find any event keys in year: "+year);
         return Utils.jsonArrayToStringArray(keys);
     }
 
@@ -120,7 +125,9 @@ public String[] getEventKeys(int year) {
      * @return Event model representing the event associated with the event key
      */
     public Event getEvent(String eventKey) {
-        return parseEvent(IO.doRequest("event/"+eventKey));
+        Event event = parseEvent(IO.doRequest("event/"+eventKey));
+        if(event == null) throw new DataNotFoundException("No event found with key: "+eventKey);
+        return event;
     }
 
     /**
@@ -131,7 +138,9 @@ public Event getEvent(String eventKey) {
      * @return Event model representing the event associated with the event key
      */
     public SEvent getSEvent(String eventKey) {
-        return parseSEvent(IO.doRequest("event/"+eventKey+"/simple"));
+        SEvent event = parseSEvent(IO.doRequest("event/"+eventKey+"/simple"));
+        if(event == null) throw new DataNotFoundException("No simple event found with key: "+eventKey);
+        return event;
     }
 
 
@@ -143,7 +152,9 @@ public SEvent getSEvent(String eventKey) {
      * @return EventOPR[] containing an EventOPR for each team
      */
     public EventOPR[] getOprs(String eventKey) {
-        return parseOPRs(IO.doRequest("event/"+eventKey+"/oprs"));
+        EventOPR[] oprs = parseOPRs(IO.doRequest("event/"+eventKey+"/oprs"));
+        if(oprs == null) throw new DataNotFoundException("No oprs found for event with key: "+eventKey);
+        return oprs;
     }
 
     /**
@@ -156,7 +167,9 @@ public EventOPR[] getOprs(String eventKey) {
      * @return JSON String containing prediction information
      */
     public String getPredictions(String eventKey) {
-        return (String) IO.doRequest("event/"+eventKey+"predictions");
+        String s =  (String) IO.doRequest("event/"+eventKey+"predictions");
+        if(s == null) throw new DataNotFoundException("No predictions found for event with key: "+eventKey);
+        return s;
     }
 
     /**
@@ -168,7 +181,7 @@ public String getPredictions(String eventKey) {
      */
     public Match[] getMatches(String eventKey) {
         JSONArray matches = (JSONArray) IO.doRequest("event/"+eventKey+"/matches");
-        if(matches == null) return null;
+        if(matches == null)  throw new DataNotFoundException("No matches found for event with key: "+eventKey);
         Match[] toGet = new Match[matches.size()];
         for(int i = 0; i < matches.size(); i++) toGet[i] = parseMatch(matches.get(i));
         return toGet;
@@ -182,8 +195,8 @@ public Match[] getMatches(String eventKey) {
      * @return Match[] containing a Match object for each match in the specified event
      */
     public SMatch[] getSMatches(String eventKey) {
-        JSONArray matches = (JSONArray) IO.doRequest("events/"+"year/simple");
-        if(matches == null) return null;
+        JSONArray matches = (JSONArray) IO.doRequest("event/"+eventKey+"/matches/simple");
+        if(matches == null)  throw new DataNotFoundException("No simple matches found for event with key: "+eventKey);
         SMatch[] toGet = new SMatch[matches.size()];
         for(int i = 0; i < matches.size(); i++) toGet[i] = parseSMatch(matches.get(i));
         return toGet;
@@ -198,6 +211,7 @@ public SMatch[] getSMatches(String eventKey) {
      */
     public String[] getMatchKeys(String eventKey) {
         JSONArray keys = (JSONArray) IO.doRequest("event/"+eventKey+"/matches/keys");
+        if(keys == null) throw new DataNotFoundException("No match keys found for event with key: "+eventKey);
         return Utils.jsonArrayToStringArray(keys);
     }
 
@@ -210,7 +224,7 @@ public String[] getMatchKeys(String eventKey) {
      */
     public Award[] getEventAwards(String eventKey) {
         JSONArray array = (JSONArray) IO.doRequest("event/"+eventKey+"/awards");
-        if(array == null) return null;
+        if(array == null)  throw new DataNotFoundException("No awards found for event with key: "+eventKey);
         Award[] toReturn = new Award[array.size()];
         for(int i = 0; i < array.size(); i++) toReturn[i] = parseAward(array.get(i));
         return toReturn;

src/main/java/requests/EventRequest.java

@@ -4,6 +4,7 @@
 import models.standard.Match;
 import utils.IO;
 import utils.Parser;
+import utils.exceptions.DataNotFoundException;
 
 /**
  * In an attempt to keep this API organized, if you look at the blue alliance v3 documentation, all calls that start with /match/
@@ -22,7 +23,9 @@ public class MatchRequest extends Parser {
      * @return Match object represented by the match key
      */
     public Match getMatch(String matchKey) {
-        return parseMatch(IO.doRequest("match/"+matchKey));
+        Match m = parseMatch(IO.doRequest("match/"+matchKey));
+        if(m == null) throw new DataNotFoundException("No match found with key: "+matchKey);
+        return m;
     }
 
     /**
@@ -33,7 +36,9 @@ public Match getMatch(String matchKey) {
      * @return SMatch object represented by the match key (simple model)
      */
     public SMatch getSMatch(String matchKey) {
-        return parseSMatch(IO.doRequest("match/"+matchKey));
+        SMatch m = parseSMatch(IO.doRequest("match/"+matchKey+"/simple"));
+        if(m == null) throw new DataNotFoundException("No match found with key: "+matchKey);
+        return m;
     }