Package eliasstar.jsonrpc

Class ConnectionBuilder

java.lang.Object

eliasstar.jsonrpc.ConnectionBuilder

public final class ConnectionBuilder
extends Object

Use this Builder to construct a customized Connection instance.

To get a Connection with default settings, you can use JsonRpc.connect(String).

Since:

0.1.0

Author:

Elias*

Constructor Summary

Constructors

Constructor	Description
ConnectionBuilder(HttpClient client)	Creates a ConnectionBuilder with the specified HttpClient.
ConnectionBuilder(HttpClient client, String url)	Creates a ConnectionBuilder with the specified HttpClient and url.

Method Summary

Modifier and Type	Method	Description
Connection	build()	Creates a Connection.
ConnectionBuilder	changeClient(HttpClient newClient)	Changes the client used for a new Connection.
ConnectionBuilder	setGson(com.google.gson.Gson gson)	Sets the GsonBuilder to be used by a created Connection.
ConnectionBuilder	setGson(com.google.gson.GsonBuilder gson)	Sets the gson builder used for creating the gson instance used by a new Connection.
ConnectionBuilder	setRequestBuilder(HttpRequest.Builder reqBuilder)	Sets the request builder used by a new Connection.
ConnectionBuilder	withId(String id)	Sets the id used by the created Connection.
ConnectionBuilder	withUrl(String url)	Sets the url of a new Connection.
ConnectionBuilder	withUrl(URI url)	Sets the url of a new Connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionBuilder

public ConnectionBuilder(HttpClient client)

Creates a ConnectionBuilder with the specified HttpClient.

Parameters:

client - The client used a new Connection

ConnectionBuilder

public ConnectionBuilder(HttpClient client,
                         String url)

Creates a ConnectionBuilder with the specified HttpClient and url.

Parameters:

client - The client used a new Connection

url - The url used to create a HttpRequest.Builder

Method Detail

withId

public ConnectionBuilder withId(String id)

Sets the id used by the created Connection.

If null is provided, a Connection without an id will be created.

Parameters:

id - The id of the new Connection

Returns:

this to satisfy the builder pattern

changeClient

public ConnectionBuilder changeClient(HttpClient newClient)

Changes the client used for a new Connection.

Parameters:

newClient - The client used by a new Connection.

Returns:

this to satisfy the builder pattern

setRequestBuilder

public ConnectionBuilder setRequestBuilder(HttpRequest.Builder reqBuilder)

Sets the request builder used by a new Connection.

The builder should already contain an url. If this is not the case, a url may be set afterwards using withUrl(URI) or withUrl(String).

Parameters:

reqBuilder - The HttpRequest.Builder

Returns:

this to satisfy the builder pattern

withUrl

public ConnectionBuilder withUrl(URI url)

Sets the url of a new Connection.

If no request builder was set beforehand, a new one with default settings is created.

Parameters:

url - The service url

Returns:

this to satisfy the builder pattern

withUrl

public ConnectionBuilder withUrl(String url)

Sets the url of a new Connection.

If no request builder was set beforehand, a new one with default settings is created.

Parameters:

url - The service url

Returns:

this to satisfy the builder pattern

setGson

public ConnectionBuilder setGson(com.google.gson.Gson gson)

Sets the GsonBuilder to be used by a created Connection.

Creates a new GsonBuilder with the same settings as the Gson instance.

Parameters:

gson - The Gson from which a GsonBuilder is created

Returns:

this to satisfy the builder pattern

setGson

public ConnectionBuilder setGson(com.google.gson.GsonBuilder gson)

Sets the gson builder used for creating the gson instance used by a new Connection.

Parameters:

gson - The GsonBuilder to be used for a created Connection

Returns:

this to satisfy the builder pattern

build

public Connection build()

Creates a Connection.

If no Gson or GsonBuilder was set, a new one is created with default settings.

The "Content-Type" header is set to "application/json" on the HttpRequest.Builder.

OptionalTypeAdapterFactory and RpcTypeAdapterFactory are registered to the GsonBuilder instance. Before building GsonBuilder.serializeNulls() is called.

Returns:

A new Connection with the settings of this ConnectionBuilder

Throws:

IllegalStateException - If neither a HttpRequest.Builder nor a URI was set