Retrofit2 (Yakhont 0.9.19 API)

java.lang.Object
- akha.yakhont.technology.retrofit.BaseRetrofit<T,Retrofit.Builder>
- - akha.yakhont.technology.retrofit.Retrofit2<T>

Type Parameters:
T - The type of Retrofit API
```
public class Retrofit2<T>
extends BaseRetrofit<T,Retrofit.Builder>
```
The component to work with Retrofit 2.x APIs.

See Also:
BaseResponseLoaderWrapper.CoreLoad

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Retrofit2.Retrofit2AdapterWrapper<D>` Extends the `ValuesCacheAdapterWrapper` class to provide Retrofit 2 support.
`static class`	`Retrofit2.Retrofit2Rx<D>` Extends the `BaseRx.LoaderRx` class to provide Retrofit 2 support.

Constructor Summary

Constructors
Constructor and Description

Retrofit2()
Initialises a newly created Retrofit2 object.

Constructors
Constructor and Description
`Retrofit2()` Initialises a newly created `Retrofit2` object.

Method Summary

Methods
Modifier and Type	Method and Description
`protected okhttp3.Cookie`	`createCookie(String name, String value, okhttp3.HttpUrl url)` Creates a cookie.
`Retrofit.Builder`	`getDefaultBuilder(String retrofitBase)` Please refer to the base method description.
`okhttp3.OkHttpClient.Builder`	`getDefaultOkHttpClientBuilder()` Returns the default `OkHttpClient` builder.
`okhttp3.OkHttpClient.Builder`	`getDefaultOkHttpClientBuilder(int connectTimeout, int readTimeout, Map<String,String> headers, Map<String,String> cookies)` Returns the default `OkHttpClient` builder.
`Class<T>`	`getService()` Returns the service interface.
`void`	`init(Class<T> service, Retrofit.Builder builder, int connectTimeout, int readTimeout)` Please refer to the base method description.
`void`	`init(Class<T> service, String retrofitBase, int connectTimeout, int readTimeout, Map<String,String> headers)` Please refer to the base method description.
`void`	`init(Class<T> service, String retrofitBase, int connectTimeout, int readTimeout, Map<String,String> headers, Map<String,String> cookies)` Initialises Retrofit client.

Methods inherited from class akha.yakhont.technology.retrofit.BaseRetrofit
getApi, getConnectionTimeout, init, init

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Retrofit2
```
public Retrofit2()
```
  Initialises a newly created Retrofit2 object.

Method Detail

getService
```
public Class<T> getService()
```
Returns the service interface.

Returns:
The service interface

init
```
public void init(@NonNull
        Class<T> service,
        @NonNull
        String retrofitBase,
        int connectTimeout,
        int readTimeout,
        @Nullable
        Map<String,String> headers)
```
Please refer to the base method description.

Specified by:

init in class BaseRetrofit<T,Retrofit.Builder>

Parameters:
service - The service interface
retrofitBase - The Retrofit API endpoint URL
connectTimeout - The connection timeout (in seconds)
readTimeout - The read timeout (in seconds)
headers - The optional HTTP headers (or null)

init

public void init(@NonNull
        Class<T> service,
        @NonNull
        String retrofitBase,
        int connectTimeout,
        int readTimeout,
        @Nullable
        Map<String,String> headers,
        @Nullable
        Map<String,String> cookies)

Initialises Retrofit client.

Parameters:: service - The service interface; retrofitBase - The Retrofit API endpoint URL; connectTimeout - The connection timeout (in seconds); readTimeout - The read timeout (in seconds); headers - The optional HTTP headers (or null); cookies - The optional cookies (or null)

init
```
public void init(@NonNull
        Class<T> service,
        @NonNull
        Retrofit.Builder builder,
        int connectTimeout,
        int readTimeout)
```
Please refer to the base method description.

Overrides:

init in class BaseRetrofit<T,Retrofit.Builder>

Parameters:
service - The service interface
builder - The RetrofitBuilder
connectTimeout - The connection timeout (in seconds)
readTimeout - The read timeout (in seconds)

getDefaultBuilder
```
public Retrofit.Builder getDefaultBuilder(@NonNull
                                 String retrofitBase)
```
Please refer to the base method description.

Specified by:

getDefaultBuilder in class BaseRetrofit<T,Retrofit.Builder>

Parameters:
retrofitBase - The service API endpoint URL

Returns:
The Retrofit builder

getDefaultOkHttpClientBuilder
```
public okhttp3.OkHttpClient.Builder getDefaultOkHttpClientBuilder()
```
Returns the default OkHttpClient builder.

Returns:
The OkHttpClient builder

getDefaultOkHttpClientBuilder

public okhttp3.OkHttpClient.Builder getDefaultOkHttpClientBuilder(int connectTimeout,
                                                         int readTimeout,
                                                         @Nullable
                                                         Map<String,String> headers,
                                                         @Nullable
                                                         Map<String,String> cookies)

Returns the default OkHttpClient builder.

Parameters:: connectTimeout - The connection timeout (in seconds); readTimeout - The read timeout (in seconds); headers - The optional HTTP headers (or null); cookies - The optional cookies (or null)
Returns:: The OkHttpClient builder

createCookie

protected okhttp3.Cookie createCookie(String name,
                          String value,
                          okhttp3.HttpUrl url)

Creates a cookie.

Parameters:: name - The name; value - The value; url - The url
Returns:: The cookie

Copyright © 2015-2017 akha, a.k.a. Alexander Kharitonov

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Class Retrofit2<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class akha.yakhont.technology.retrofit.BaseRetrofit

Methods inherited from class java.lang.Object

Constructor Detail

Retrofit2

Method Detail

getService

init

init

init

getDefaultBuilder

getDefaultOkHttpClientBuilder

getDefaultOkHttpClientBuilder

createCookie