Beta release

pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>be.maximvdw</groupId>
 	<artifactId>spigotsite-api</artifactId>
-	<version>0.0.14-SNAPSHOT</version>
+	<version>0.1.0-SNAPSHOT</version>
 	<name>SpigotSite API</name>
 	<description>Spigot Site API</description>
 	<build>

src/main/java/be/maximvdw/spigotsite/api/SpigotSite.java

@@ -4,7 +4,7 @@ public final class SpigotSite {
 	/* Spigot Site API */
 	private static SpigotSiteAPI api = null;
 	/* Spigot Site API Version */
-	private static String version = "0.0.14-SNAPSHOT";
+	private static String version = "0.1.0-SNAPSHOT";
 
 	/**
 	 * Get spigot site API

src/main/java/be/maximvdw/spigotsite/api/SpigotSiteAPI.java

@@ -27,7 +27,7 @@ public interface SpigotSiteAPI {
 
 	/**
 	 * Get spigot forum manager
-	 * 
+	 *
 	 * @return {@link be.maximvdw.spigotsite.api.forum.ForumManager}
 	 */
 	ForumManager getForumManager();

src/main/java/be/maximvdw/spigotsite/api/forum/Forum.java

@@ -13,5 +13,5 @@ public interface Forum {
 	 * 
 	 * @return List of {{@link be.maximvdw.spigotsite.api.forum.Forum}
 	 */
-	public List<Forum> getSubForums();
+	List<Forum> getSubForums();
 }

src/main/java/be/maximvdw/spigotsite/api/forum/ForumCategory.java

@@ -13,5 +13,5 @@ public interface ForumCategory {
 	 * 
 	 * @return List of {@link be.maximvdw.spigotsite.api.forum.Forum}
 	 */
-	public List<Forum> getForums();
+	List<Forum> getForums();
 }

src/main/java/be/maximvdw/spigotsite/api/forum/ForumManager.java

@@ -1,5 +1,7 @@
 package be.maximvdw.spigotsite.api.forum;
 
+import be.maximvdw.spigotsite.api.exceptions.ConnectionFailedException;
+
 /**
  * Spigot forum manager
  *
@@ -11,6 +13,7 @@ public interface ForumManager {
      *
      * @param id Forum id
      * @return {@link be.maximvdw.spigotsite.api.forum.Forum}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    Forum getForumById(int id);
+    Forum getForumById(int id) throws ConnectionFailedException;
 }

src/main/java/be/maximvdw/spigotsite/api/forum/Thread.java

@@ -15,19 +15,19 @@ public interface Thread {
 	 * 
 	 * @return List of {@link be.maximvdw.spigotsite.api.forum.Post}
 	 */
-	public List<Post> getReplies();
+	List<Post> getReplies();
 
 	/**
 	 * Get original post
 	 * 
 	 * @return {@link be.maximvdw.spigotsite.api.forum.Post}
 	 */
-	public Post getOriginalPost();
+	Post getOriginalPost();
 
 	/**
 	 * Get thread creator
 	 * 
 	 * @return Thread creator
 	 */
-	public User getCreator();
+	User getCreator();
 }

src/main/java/be/maximvdw/spigotsite/api/resource/Buyer.java

@@ -0,0 +1,40 @@
+package be.maximvdw.spigotsite.api.resource;
+
+import be.maximvdw.spigotsite.api.user.User;
+
+import java.util.Date;
+
+/**
+ * Premium resource Buyer
+ *
+ * @author Maxim Van de Wynckel
+ */
+public interface Buyer extends User {
+    /**
+     * Get purchase date time
+     *
+     * @return purchase date
+     */
+    Date getPurchaseDateTime();
+
+    /**
+     * Get the currency it was bought with
+     *
+     * @return currency
+     */
+    String getPurchaseCurrency();
+
+    /**
+     * Get the price the buyer paid for
+     *
+     * @return purchase price
+     */
+    double getPurchasePrice();
+
+    /**
+     * Check if the buyer was actually added by the buyer
+     *
+     * @return added by buyer or not
+     */
+    boolean addedByAuthor();
+}

src/main/java/be/maximvdw/spigotsite/api/resource/ResourceManager.java

@@ -16,26 +16,29 @@ public interface ResourceManager {
      *
      * @param resourceid Resource identifier
      * @return Spigot Resource
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    Resource getResourceById(int resourceid);
+    Resource getResourceById(int resourceid) throws ConnectionFailedException;
 
     /**
      * Get a {@link be.maximvdw.spigotsite.api.resource.Resource} by identifier
      *
      * @param resourceid Resource identifier
      * @param user       Authenticated spigot user
      * @return Spigot Resource
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    Resource getResourceById(int resourceid, User user);
+    Resource getResourceById(int resourceid, User user) throws ConnectionFailedException;
 
     /**
      * Get a list of {@link be.maximvdw.spigotsite.api.resource.Resource} from a
      * {@link be.maximvdw.spigotsite.api.user.User}
      *
      * @param user {@link be.maximvdw.spigotsite.api.user.User}
      * @return List of {@link be.maximvdw.spigotsite.api.resource.Resource}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<Resource> getResourcesByUser(User user);
+    List<Resource> getResourcesByUser(User user) throws ConnectionFailedException;
 
     /**
      * Get a list of {@link be.maximvdw.spigotsite.api.resource.Resource} from a
@@ -44,17 +47,19 @@ public interface ResourceManager {
      * @param user         {@link be.maximvdw.spigotsite.api.user.User}
      * @param loggedInUser {@link be.maximvdw.spigotsite.api.user.User} used to get hidden plugins
      * @return List of {@link be.maximvdw.spigotsite.api.resource.Resource}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<Resource> getResourcesByUser(User user, User loggedInUser);
+    List<Resource> getResourcesByUser(User user, User loggedInUser) throws ConnectionFailedException;
 
     /**
      * Get a list of {@link be.maximvdw.spigotsite.api.resource.Resource} from a
      * {@link be.maximvdw.spigotsite.api.user.User}
      *
      * @param id User identifier
      * @return List of {@link be.maximvdw.spigotsite.api.resource.Resource}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<Resource> getResourcesByUser(int id);
+    List<Resource> getResourcesByUser(int id) throws ConnectionFailedException;
 
     /**
      * Get a list of {@link be.maximvdw.spigotsite.api.resource.Resource} from a
@@ -63,15 +68,17 @@ public interface ResourceManager {
      * @param id           User identifier
      * @param loggedInUser {@link be.maximvdw.spigotsite.api.user.User} used to get hidden plugins
      * @return List of {@link be.maximvdw.spigotsite.api.resource.Resource}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<Resource> getResourcesByUser(int id, User loggedInUser);
+    List<Resource> getResourcesByUser(int id, User loggedInUser) throws ConnectionFailedException;
 
     /**
      * Get a list of {@link be.maximvdw.spigotsite.api.resource.Resource} bought
      * by a {@link be.maximvdw.spigotsite.api.user.User}
      *
      * @param user Authenticated {@link be.maximvdw.spigotsite.api.user.User}
      * @return List of {@link be.maximvdw.spigotsite.api.resource.Resource}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
     List<Resource> getPurchasedResources(User user)
             throws ConnectionFailedException;
@@ -81,42 +88,47 @@ List<Resource> getPurchasedResources(User user)
      *
      * @return List of
      * {@link be.maximvdw.spigotsite.api.resource.ResourceCategory}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<ResourceCategory> getResourceCategories();
+    List<ResourceCategory> getResourceCategories() throws ConnectionFailedException;
 
     /**
      * Get {@link be.maximvdw.spigotsite.api.resource.ResourceCategory} by
      * identifier
      *
      * @param id Resource Category identifier
      * @return Resource Category
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    ResourceCategory getResourceCategoryById(int id);
+    ResourceCategory getResourceCategoryById(int id) throws ConnectionFailedException;
 
     /**
      * Get all resources from a specific category
      *
      * @param category List of {@link be.maximvdw.spigotsite.api.resource.Resource}
      * @return
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<Resource> getResourcesByCategory(ResourceCategory category);
+    List<Resource> getResourcesByCategory(ResourceCategory category) throws ConnectionFailedException;
 
     /**
      * Get the last version of a resource
      *
      * @param resourceid Resource identifier
      * @return Version string
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    String getLastVersion(int resourceid);
+    String getLastVersion(int resourceid) throws ConnectionFailedException;
 
     /**
      * Get premium resource buyers
      *
      * @param resource Premium resource
      * @param user     The authenticated author of the plugin
-     * @return List of {@link be.maximvdw.spigotsite.api.user.User}
+     * @return List of {@link be.maximvdw.spigotsite.api.resource.Buyer}
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    List<User> getPremiumResourceBuyers(PremiumResource resource,
+    List<Buyer> getPremiumResourceBuyers(PremiumResource resource,
                                         User user) throws ConnectionFailedException;
 
     /**
@@ -125,52 +137,58 @@ List<User> getPremiumResourceBuyers(PremiumResource resource,
      * @param resource Premium resource
      * @param user     The authenticated plugin author
      * @param buyer    The buyer
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void addBuyer(PremiumResource resource, User user, User buyer);
+    void addBuyer(PremiumResource resource, User user, User buyer) throws ConnectionFailedException;
 
     /**
      * Add a buyer to a spigot premium resource
      *
      * @param resource Premium resource
      * @param user     The authenticated plugin author
      * @param userid   User identifier
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void addBuyer(PremiumResource resource, User user, int userid);
+    void addBuyer(PremiumResource resource, User user, int userid) throws ConnectionFailedException;
 
     /**
      * Add a buyer to a spigot premium resource
      *
      * @param resource Premium resource
      * @param user     The authenticated plugin author
      * @param username The text username
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void addBuyer(PremiumResource resource, User user, String username);
+    void addBuyer(PremiumResource resource, User user, String username) throws ConnectionFailedException;
 
     /**
      * Add a buyer to a spigot premium resource
      *
      * @param resource Premium resource
      * @param user     The authenticated plugin author
      * @param buyers   A list of buyers
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void addBuyers(PremiumResource resource, User user, List<User> buyers);
+    void addBuyers(PremiumResource resource, User user, List<User> buyers) throws ConnectionFailedException;
 
     /**
      * Add a buyer to a spigot premium resource
      *
      * @param resource  Premium resource
      * @param user      The authenticated plugin author
      * @param usernames A list of usernames
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
     void addBuyers(PremiumResource resource, User user,
-                   String[] usernames);
+                   String[] usernames) throws ConnectionFailedException;
 
     /**
      * Remove a buyer from a spigot premium resource
      *
      * @param resource Premium resource
      * @param user     The authenticated plugin author
-     * @param buyer     Buyer to remove
+     * @param buyer    Buyer to remove
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void removeBuyer(PremiumResource resource, User user, int buyer);
+    void removeBuyer(PremiumResource resource, User user, int buyer) throws ConnectionFailedException;
 }

src/main/java/be/maximvdw/spigotsite/api/user/Conversation.java

@@ -3,6 +3,7 @@
 import java.util.Date;
 import java.util.List;
 
+import be.maximvdw.spigotsite.api.exceptions.ConnectionFailedException;
 import be.maximvdw.spigotsite.api.exceptions.SpamWarningException;
 
 /**
@@ -79,20 +80,23 @@ public interface Conversation {
      * Leave the conversation
      *
      * @param user Authenticated user
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void leave(User user);
+    void leave(User user) throws ConnectionFailedException;
 
     /**
      * Mark conversation as read
      *
      * @param user Authenticated user
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void markAsRead(User user);
+    void markAsRead(User user) throws ConnectionFailedException;
 
     /**
      * Mark conversation as unread
      *
      * @param user Authenticated user
+     * @throws ConnectionFailedException Connection to Spigot failed
      */
-    void markAsUnread(User user);
+    void markAsUnread(User user) throws ConnectionFailedException;
 }