com.suncode.pwfl.translation

Interface TranslatorRegistry

@Api
public interface TranslatorRegistry

Registry of available Translator. Translators are registered with #register(Translator, TranslatorScope) method in given scope. Name must be unique within given scope.

Additionally, if Translator implements PackageTranslator interface, then it is possible to fetch him by package name.

Author:

Cezary Kozar 19 sie 2015

Method Summary

Modifier and Type	Method and Description
Translator	forClass(Class<?> clazz) Returns Translator for package of given class registered in TranslatorScope.SERVER scope.
Translator	get(String name) Returns Translator with given name for scope TranslatorScope.SERVER.
Translator	get(String name, TranslatorScope scope) Returns Translator with given name and scope.
List<Translator>	getAll(TranslatorScope scope) Returns all translators Translator with given scope.
Map<String,Translator>	getAllByName(TranslatorScope scope) Returns the map of all translators with the given scope, where key is the translator name.
TranslatorRegistration	register(String name, Translator translator, TranslatorScope scope) Registers given translator under provided name in given scope.

Method Detail

get

Translator get(String name)

Returns Translator with given name for scope TranslatorScope.SERVER. If there is no such translator, returns EmptyTranslator instance.

Parameters:

name - translator name

getAll

List<Translator> getAll(TranslatorScope scope)

Returns all translators Translator with given scope.

Parameters:

scope -

Returns:

translators list

getAllByName

Map<String,Translator> getAllByName(TranslatorScope scope)

Returns the map of all translators with the given scope, where key is the translator name.

Parameters:

scope -

Returns:

all translators map

get

Translator get(String name,
               TranslatorScope scope)

Returns Translator with given name and scope. If there is no such translator, returns EmptyTranslator instance.

Parameters:

name - translator name

scope - translator scope

forClass

Translator forClass(Class<?> clazz)

Returns Translator for package of given class registered in TranslatorScope.SERVER scope. If there is no such translator, returns EmptyTranslator instance.

Parameters:

clazz - class

See Also:

forClass(Class)

register

TranslatorRegistration register(String name,
                                Translator translator,
                                TranslatorScope scope)

Registers given translator under provided name in given scope.

NOTE: Translator name within single TranslatorScope must be unique.

Parameters:

name - translator name

translator - registered translator

scope - scope target scope