From 45e493a35a37be53f163ab4cdfffc84221daf922 Mon Sep 17 00:00:00 2001
From: 0xboobface <0xboobface@gmail.com>
Date: Tue, 4 Dec 2018 18:28:30 +0100
Subject: [PATCH] Add javadoc

---
 common/src/main/java/ctbrec/Model.java | 38 ++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/common/src/main/java/ctbrec/Model.java b/common/src/main/java/ctbrec/Model.java
index e13f2fcd..895f711e 100644
--- a/common/src/main/java/ctbrec/Model.java
+++ b/common/src/main/java/ctbrec/Model.java
@@ -14,33 +14,71 @@ import ctbrec.sites.Site;
 
 public interface Model {
     public String getUrl();
+
     public void setUrl(String url);
+
     public String getDisplayName();
+
     public void setDisplayName(String name);
+
     public String getName();
+
     public void setName(String name);
+
     public String getPreview();
+
     public void setPreview(String preview);
+
     public List<String> getTags();
+
     public void setTags(List<String> tags);
+
     public String getDescription();
+
     public void setDescription(String description);
+
     public int getStreamUrlIndex();
+
     public void setStreamUrlIndex(int streamUrlIndex);
+
     public boolean isOnline() throws IOException, ExecutionException, InterruptedException;
+
     public boolean isOnline(boolean ignoreCache) throws IOException, ExecutionException, InterruptedException;
+
     public String getOnlineState(boolean failFast) throws IOException, ExecutionException;
+
     public List<StreamSource> getStreamSources() throws IOException, ExecutionException, ParseException, PlaylistException;
+
     public void invalidateCacheEntries();
+
     public void receiveTip(int tokens) throws IOException;
+
+    /**
+     * Determines the stream resolution for this model
+     *
+     * @param failFast
+     *            If set to true, the method returns emmediately, even if the resolution is unknown. If
+     *            the resolution is unknown, the array contains 0,0
+     *
+     * @return a tupel of width and height represented by an int[2]
+     * @throws ExecutionException
+     */
     public int[] getStreamResolution(boolean failFast) throws ExecutionException;
+
     public boolean follow() throws IOException;
+
     public boolean unfollow() throws IOException;
+
     public void setSite(Site site);
+
     public Site getSite();
+
     public void writeSiteSpecificData(JsonWriter writer) throws IOException;
+
     public void readSiteSpecificData(JsonReader reader) throws IOException;
+
     public boolean isSuspended();
+
     public void setSuspended(boolean suspended);
 
 }
\ No newline at end of file