org.genesys2.transifex.client

Interface TransifexService

All Known Implementing Classes:

TransifexServiceImpl

public interface TransifexService

Transifex client.

Author:

matijaobreza

Method Summary

Modifier and Type	Method and Description
void	createXhtmlResource(String slug, String title, String content) Create a new XHTML resource.
boolean	deleteResource(String slug) Delete resource.
String	downloadTranslatedResource(String slug, Locale locale) Download translated resource.
String	getTranslatedResource(String slug, Locale locale) Gets the translated resource.
boolean	resourceExists(String slug) Checks if resource exists on Transifex
void	testCredentials() Ping service to test credentials
void	updatePropertiesXmlResource(String slug, String title, File file) Create or update Java XML Properties resource.
void	updateXhtmlResource(String slug, String title, String content) Create or update XHTML resource.

Method Detail

resourceExists

boolean resourceExists(String slug)

Checks if resource exists on Transifex

Parameters:

slug - the resource slug

Returns:

true, if successful

deleteResource

boolean deleteResource(String slug)
                throws TransifexException

Delete resource.

Parameters:

slug - the resource slug

Returns:

true, if successful

Throws:

TransifexException - the transifex exception

getTranslatedResource

String getTranslatedResource(String slug,
                             Locale locale)
                      throws TransifexException

Gets the translated resource.

Parameters:

slug - the resource slug

locale - the locale

Returns:

the translated resource

Throws:

TransifexException - the transifex exception

createXhtmlResource

void createXhtmlResource(String slug,
                         String title,
                         String content)
                  throws IOException

Create a new XHTML resource. Fails if resource exists.

Parameters:

slug - the slug

title - the title

content - the content

Throws:

IOException - Signals that an I/O exception has occurred.

updateXhtmlResource

void updateXhtmlResource(String slug,
                         String title,
                         String content)
                  throws IOException

Create or update XHTML resource.

Parameters:

slug - the slug

title - the title

content - the content

Throws:

IOException - Signals that an I/O exception has occurred.

updatePropertiesXmlResource

void updatePropertiesXmlResource(String slug,
                                 String title,
                                 File file)
                          throws IOException

Create or update Java XML Properties resource.

Parameters:

slug - the slug

title - the title

file - the file

Throws:

IOException - Signals that an I/O exception has occurred.

downloadTranslatedResource

String downloadTranslatedResource(String slug,
                                  Locale locale)
                           throws TransifexException

Download translated resource.

Parameters:

slug - the slug

locale - the locale

Returns:

the string

Throws:

TransifexException - the transifex exception

testCredentials

void testCredentials()
              throws TransifexException

Ping service to test credentials

Throws:

TransifexException - the transifex exception