Add Basic MyWaifuClient.java

This class will be the main entry point for Users who wish to use this wrapper
pull/2/head
Hammy 4 years ago
parent 6d71d60e28
commit 184327f723

@ -0,0 +1,127 @@
package org.goudham.me;
import org.goudham.me.api.MyWaifuWrapper;
import org.jetbrains.annotations.NotNull;
import javax.net.ssl.SSLParameters;
import java.net.Authenticator;
import java.net.CookieHandler;
import java.net.ProxySelector;
import java.net.http.HttpClient;
import java.time.Duration;
import java.util.concurrent.Executor;
/**
* A MyWaifuClient
*
* <p> Main entry point for retrieving information from MyWaifuList. </p>
* <p> {@link MyWaifuWrapper} is utilised to make the API requests </p>
* <p> Examples of such methods include:
* <li>{@link }</li>
* </p>
*/
public class MyWaifuClient {
private final MyWaifuWrapper myWaifuWrapper;
private HttpClient httpClient;
/**
* Creates an instance of MyWaifuClient
*
* <p>See <a href="https://mywaifulist.docs.stoplight.io/">MyWaifuList</a> for obtaining an API Key</p>
* @param apiKey API Key to authorise API request
*/
MyWaifuClient(@NotNull String apiKey) {
myWaifuWrapper = new MyWaifuWrapper(apiKey);
}
/**
* Creates an instance of {@link MyWaifuClient} with default {@link HttpClient} settings
*
* @param apiKey API Key to authorise API request
* @return {@link MyWaifuClient}
*/
public static MyWaifuClient createDefault(@NotNull String apiKey) {
MyWaifuClient myWaifuClient = new MyWaifuClient(apiKey);
myWaifuClient.setHttpClient(HttpClient.newBuilder()
.version(HttpClient.Version.HTTP_2)
.followRedirects(HttpClient.Redirect.NORMAL)
.connectTimeout(Duration.ofSeconds(20))
.build());
return myWaifuClient;
}
/**
* Sets an instance of HttpClient
*
* @param httpClient HttpClient for executing API requests
*/
public void setHttpClient(HttpClient httpClient) {
this.httpClient = httpClient;
}
/**
* Builder for MyWaifuClient
*/
public static class Builder {
private final String apiKey;
private final MyWaifuWrapper myWaifuWrapper;
private HttpClient.Builder httpClientBuilder;
public Builder(String apiKey) {
this.apiKey = apiKey;
myWaifuWrapper = new MyWaifuWrapper(apiKey);
}
public Builder withCookieHandler(CookieHandler cookieHandler) {
httpClientBuilder.cookieHandler(cookieHandler);
return this;
}
public Builder withConnectTimeout(Duration duration) {
httpClientBuilder.connectTimeout(duration);
return this;
}
public Builder withSslParameters(SSLParameters sslParameters) {
httpClientBuilder.sslParameters(sslParameters);
return this;
}
public Builder withExecutor(Executor executor) {
httpClientBuilder.executor(executor);
return this;
}
public Builder withFollowRedirects(HttpClient.Redirect policy) {
httpClientBuilder.followRedirects(policy);
return this;
}
public Builder withVersion(HttpClient.Version version) {
httpClientBuilder.version(version);
return this;
}
public Builder withPriority(int priority) {
httpClientBuilder.priority(priority);
return this;
}
public Builder withProxy(ProxySelector proxySelector) {
httpClientBuilder.proxy(proxySelector);
return this;
}
public Builder withAuthenticator(Authenticator authenticator) {
httpClientBuilder.authenticator(authenticator);
return this;
}
public MyWaifuClient build() {
MyWaifuClient myWaifuClient = new MyWaifuClient(apiKey);
myWaifuClient.setHttpClient(httpClientBuilder.build());
return myWaifuClient;
}
}
}
Loading…
Cancel
Save