com.contentful.java.cma

Class ModuleLocales

java.lang.Object

com.contentful.java.cma.ModuleLocales

public class ModuleLocales
extends java.lang.Object

This module contains all the locale options available to this SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleLocales.Async Handler for asynchronous requests.

Constructor Summary

Constructors

Constructor and Description
ModuleLocales(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor) Create a new locale module.

Method Summary

Modifier and Type	Method and Description
ModuleLocales.Async	async() Use all functionalities of this module asynchronously.
CMALocale	create(java.lang.String spaceId, CMALocale locale) Create a new locale.
protected ServiceLocales	createService(retrofit2.Retrofit retrofit) Initialize retrofit with the current service.
int	delete(java.lang.String spaceId, CMALocale locale) Delete the given locale instance.
CMAArray<CMALocale>	fetchAll(java.lang.String spaceId) Fetch all locales of this space.
CMAArray<CMALocale>	fetchAll(java.lang.String spaceId, java.util.Map<java.lang.String,java.lang.String> query) Fetch specific locales of this space.
CMALocale	fetchOne(java.lang.String spaceId, java.lang.String localeId) Fetches one locale by its id from Contentful.
CMALocale	update(CMALocale locale) Update the given locale instance on Contentful.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleLocales

public ModuleLocales(retrofit2.Retrofit retrofit,
                     java.util.concurrent.Executor callbackExecutor)

Create a new locale module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

Method Detail

createService

protected ServiceLocales createService(retrofit2.Retrofit retrofit)

Initialize retrofit with the current service.

Parameters:

retrofit - the instance to use the service with.

Returns:

a populated instance of the service to be used.

async

public ModuleLocales.Async async()

Use all functionalities of this module asynchronously.

Returns:

an asynchronous handling instance.

fetchAll

public CMAArray<CMALocale> fetchAll(java.lang.String spaceId)

Fetch all locales of this space.

Parameters:

spaceId - the space identifier identifying the space.

Returns:

the array of locales.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMALocale> fetchAll(java.lang.String spaceId,
                                    java.util.Map<java.lang.String,java.lang.String> query)

Fetch specific locales of this space.

Parameters:

spaceId - the space identifier identifying the space.

query - the search criteria to search for.

Returns:

the array of locales.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchOne

public CMALocale fetchOne(java.lang.String spaceId,
                          java.lang.String localeId)

Fetches one locale by its id from Contentful.

Parameters:

spaceId - the space this locale is hosted by.

localeId - the id of the locale to be found.

Returns:

null if no locale was found, otherwise the found locale.

Throws:

java.lang.IllegalArgumentException - if space id is null.

java.lang.IllegalArgumentException - if locale id is null.

create

public CMALocale create(java.lang.String spaceId,
                        CMALocale locale)

Create a new locale.

Parameters:

spaceId - the space id to host the locale.

locale - the new locale to be created.

Returns:

the newly created locale.

Throws:

java.lang.IllegalArgumentException - if space id is null.

java.lang.IllegalArgumentException - if locale is null.

update

public CMALocale update(CMALocale locale)

Update the given locale instance on Contentful.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

locale - the locale fetched from Contentful, updated by caller, to be updated.

Returns:

the updated locale.

Throws:

java.lang.IllegalArgumentException - if space id is null.

java.lang.IllegalArgumentException - if locale is null.

java.lang.IllegalArgumentException - if locale id is null.

java.lang.IllegalArgumentException - if locale does not have a version attached.

delete

public int delete(java.lang.String spaceId,
                  CMALocale locale)

Delete the given locale instance.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

spaceId - the id of the space to be used.

locale - the locale fetched from Contentful, updated by caller, to be deleted.

Returns:

the code of the response (200 means success).

Throws:

java.lang.IllegalArgumentException - if space id is null.

java.lang.IllegalArgumentException - if locale id is null.