Renamed facade class to CodeBottleAPI

Author: Tobias Burdow [Kaleidox]

…n/java/io/codebottle/api/CodeBottle.java …ava/io/codebottle/api/CodeBottleAPI.javasrc/main/java/io/codebottle/api/CodeBottle.java renamed to src/main/java/io/codebottle/api/CodeBottleAPI.java src/main/java/io/codebottle/api/CodeBottle.java renamed to src/main/java/io/codebottle/api/CodeBottleAPI.java

@@ -21,7 +21,7 @@
 /**
  * API Class. Create an instance of this using {@code #builder()} to use the API.
  */
-public final class CodeBottle {
+public final class CodeBottleAPI {
     private final Map<String, Language> languageCache = new ConcurrentHashMap<>();
     private final Map<String, Category> categoryCache = new ConcurrentHashMap<>();
     private final Map<String, Snippet> snippetCache = new ConcurrentHashMap<>();
@@ -34,7 +34,7 @@ public final class CodeBottle {
      */
     public final CompletableFuture<Void> lazyLoading = CompletableFuture.allOf(requestLanguages(), requestCategories());
 
-    private CodeBottle(@Nullable String token, OkHttpClient httpClient) {
+    private CodeBottleAPI(@Nullable String token, OkHttpClient httpClient) {
         this.token = token;
         this.httpClient = httpClient;
     }
@@ -43,9 +43,9 @@ private CodeBottle(@Nullable String token, OkHttpClient httpClient) {
      * Waits for {@linkplain #lazyLoading lazy loading} to finish using {@link CompletableFuture#join()}.
      * This method is intended to be used for API chaining, otherwise it is recommended to wait for {@link #lazyLoading} yourself.
      *
-     * @return this {@link CodeBottle} instance.
+     * @return this {@link CodeBottleAPI} instance.
      */
-    public CodeBottle waitForLazyLoading() {
+    public CodeBottleAPI waitForLazyLoading() {
         lazyLoading.join();
 
         return this;
@@ -359,8 +359,8 @@ public void setHttpClient(OkHttpClient httpClient) {
             this.httpClient = httpClient;
         }
 
-        public CodeBottle build() {
-            return new CodeBottle(token, httpClient);
+        public CodeBottleAPI build() {
+            return new CodeBottleAPI(token, httpClient);
         }
     }
 }

src/main/java/io/codebottle/api/model/AbstractEntity.java

@@ -2,21 +2,21 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 
 public abstract class AbstractEntity {
-    protected final CodeBottle context;
+    protected final CodeBottleAPI context;
 
     protected final @JsonProperty(required = true) String id;
 
-    protected AbstractEntity(CodeBottle context, JsonNode data) {
+    protected AbstractEntity(CodeBottleAPI context, JsonNode data) {
         this.context = context;
         this.id = data.get("id").asText();
 
         update(data);
     }
 
-    public AbstractEntity(CodeBottle context, int id) {
+    public AbstractEntity(CodeBottleAPI context, int id) {
         this.context = context;
 
         this.id = String.valueOf(id);
@@ -26,7 +26,7 @@ public String getID() {
         return id;
     }
 
-    public CodeBottle getContext() {
+    public CodeBottleAPI getContext() {
         return context;
     }
 

src/main/java/io/codebottle/api/model/Category.java

@@ -2,13 +2,13 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 
 public class Category extends AbstractEntity {
     private @JsonProperty(required = true) int id;
     private @JsonProperty(required = true) String name;
 
-    public Category(CodeBottle context, JsonNode data) {
+    public Category(CodeBottleAPI context, JsonNode data) {
         super(context, data);
     }
 

src/main/java/io/codebottle/api/model/Language.java

@@ -2,13 +2,13 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 
 public class Language extends AbstractEntity {
     private @JsonProperty(required = true) int id;
     private @JsonProperty(required = true) String name;
 
-    public Language(CodeBottle context, JsonNode data) {
+    public Language(CodeBottleAPI context, JsonNode data) {
         super(context, data);
     }
 

src/main/java/io/codebottle/api/model/Snippet.java

@@ -11,7 +11,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 import io.codebottle.api.rest.CodeBottleRequest;
 import io.codebottle.api.rest.Endpoint;
 import org.jetbrains.annotations.Contract;
@@ -32,7 +32,7 @@ public class Snippet extends AbstractEntity {
     private @JsonProperty(required = true) Instant createdAt;
     private @JsonProperty(required = true) Instant updatedAt;
 
-    public Snippet(CodeBottle context, JsonNode data) {
+    public Snippet(CodeBottleAPI context, JsonNode data) {
         super(context, data);
 
         revisions = new ArrayList<>();
@@ -181,7 +181,7 @@ public static class Revision extends AbstractEntity implements Comparable<Revisi
         private @JsonProperty(required = true) String explanation;
         private @JsonProperty(required = true) Instant createdAt;
 
-        protected Revision(CodeBottle context, JsonNode data, int index) {
+        protected Revision(CodeBottleAPI context, JsonNode data, int index) {
             super(context, index);
         }
 

src/main/java/io/codebottle/api/rest/CodeBottleRequest.java

@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 import io.codebottle.api.rest.exception.UnexpectedStatusCodeException;
 import okhttp3.Call;
 import okhttp3.MediaType;
@@ -44,15 +44,15 @@ public final class CodeBottleRequest<T> {
     private final static ObjectMapper objectMapper;
 
     private final Request.Builder httpRequest;
-    private final CodeBottle context;
+    private final CodeBottleAPI context;
 
     private int expected = HTTPCodes.OK;
 
     static {
         objectMapper = new ObjectMapper();
     }
 
-    public CodeBottleRequest(CodeBottle context) {
+    public CodeBottleRequest(CodeBottleAPI context) {
         this.context = context;
         this.httpRequest = new Request.Builder()
                 .addHeader("Accept", "application/vnd.codebottle.v1+json"); // fixed request header
@@ -62,7 +62,7 @@ public CodeBottleRequest(CodeBottle context) {
         context.getToken().ifPresent(token -> httpRequest.addHeader("Authorization", token));
     }
 
-    public CodeBottle getContext() {
+    public CodeBottleAPI getContext() {
         return context;
     }
 

src/test/java/io/codebottle/api/test/PerformanceTest.java

@@ -2,7 +2,7 @@
 
 import java.util.concurrent.CompletableFuture;
 
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 import org.junit.Test;
 
 import static java.lang.System.currentTimeMillis;
@@ -16,18 +16,18 @@ public void requestEverything() {
 
         out.print("Requesting everything...");
 
-        final CodeBottle codeBottle = new CodeBottle.Builder().build();
+        final CodeBottleAPI codeBottleAPI = new CodeBottleAPI.Builder().build();
 
         // wait for all loading to finish
-        CompletableFuture.allOf(codeBottle.lazyLoading, codeBottle.requestAllRevisions())
+        CompletableFuture.allOf(codeBottleAPI.lazyLoading, codeBottleAPI.requestAllRevisions())
                 .join();
 
         out.print(" OK!\n");
 
-        final int languageCount = codeBottle.getLanguages().size();
-        final int categoryCount = codeBottle.getCategories().size();
-        final int snippetCount = codeBottle.getSnippets().size();
-        final int revisionCount = codeBottle.getSnippetRevisions().size();
+        final int languageCount = codeBottleAPI.getLanguages().size();
+        final int categoryCount = codeBottleAPI.getCategories().size();
+        final int snippetCount = codeBottleAPI.getSnippets().size();
+        final int revisionCount = codeBottleAPI.getSnippetRevisions().size();
 
         out.print("Checking for cache integrity...");
 

src/test/java/io/codebottle/api/test/RequestTest.java

@@ -1,32 +1,32 @@
 package io.codebottle.api.test;
 
-import io.codebottle.api.CodeBottle;
+import io.codebottle.api.CodeBottleAPI;
 import io.codebottle.api.model.Snippet;
 import org.junit.Before;
 import org.junit.Test;
 
 import static org.junit.Assert.assertNotNull;
 
 public class RequestTest {
-    private CodeBottle codeBottle;
+    private CodeBottleAPI codeBottleAPI;
 
     @Before
     public void setUp() {
-        codeBottle = new CodeBottle.Builder()
+        codeBottleAPI = new CodeBottleAPI.Builder()
                 .build()
                 .waitForLazyLoading();
     }
 
     @Test
     public void testRequestSnippetByID() {
-        final Snippet snippet = codeBottle.requestSnippetByID("1b6c6604d6").join();
+        final Snippet snippet = codeBottleAPI.requestSnippetByID("1b6c6604d6").join();
 
         assertNotNull("Requested Snippet is null!", snippet);
     }
 
     @Test
     public void testRequestRevisionByID() {
-        final Snippet.Revision revision = codeBottle.requestSnippetRevisionByID("1b6c6604d6", 1).join();
+        final Snippet.Revision revision = codeBottleAPI.requestSnippetRevisionByID("1b6c6604d6", 1).join();
 
         assertNotNull("Requested Revision is null!", revision);
     }