• Home
• org.spincast
• spincast-website
• 2.1.1
• source code
• SpincastDictionaryDefault.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

public.javadoc.org.spincast.plugins.dictionary.SpincastDictionaryDefault.html Maven / Gradle / Ivy

Package org.spincast.plugins.dictionary
Class SpincastDictionaryDefault

java.lang.Object
org.spincast.core.dictionary.DictionaryBase
org.spincast.plugins.dictionary.SpincastDictionaryDefault




All Implemented Interfaces:
Dictionary


public class SpincastDictionaryDefault
extends DictionaryBase
implements Dictionary
Default implementation of the Dictionary.
 

 Provides a value for the core Spincast messages
 required by any application.
 

 You have to override the addMessages() method to
 add your own messages.






Field Summary
Fields

Modifier and Type
Field
Description
protected static final org.slf4j.Logger
logger
 






Constructor Summary
Constructors

Constructor
Description
SpincastDictionaryDefault(LocaleResolver localeResolver,
 TemplatingEngine templatingEngine,
 SpincastConfig spincastConfig,
 Set<DictionaryEntries> dictionaryEntries)
 






Method Summary

All MethodsInstance MethodsConcrete Methods


Modifier and Type
Method
Description
protected void
addCoreAndPluginsMessages()
 
protected void
addMessages()

To override to add messages to the dictionary.

String
get(String key)

Gets a message.

String
get(String key,
 boolean forceTemplatingEngine)

Gets a message.

String
get(String key,
 Locale locale)

Gets a message.

String
get(String key,
 Locale locale,
 boolean forceEvaluation)

Gets a message.

String
get(String key,
 Locale locale,
 Map<String,Object> params)

Gets a message.

String
get(String key,
 Locale locale,
 Map<String,Object> params,
 Locale originalLocale)
 
String
get(String key,
 Locale locale,
 Pair... params)

Gets a message.

String
get(String key,
 Map<String,Object> params)

Gets a message.

final String
get(String key,
 Pair... params)

Gets a message.

Map<String,String>
getAll(String key)

Return all the possible values, for all languages used,
 by language abreviation.

Map<String,String>
getAll(String key,
 Map<String,Object> params)

Return all the possible values, for all languages used,
 by language abreviation.

Map<String,String>
getAll(String key,
 Pair... params)

Return all the possible values, for all languages used,
 by language abreviation.

protected Locale
getDefaultLocale()
 
protected Set<DictionaryEntries>
getDictionaryEntries()
 
protected SpincastConfig
getSpincastConfig()
 
protected TemplatingEngine
getTemplatingEngine()
 
boolean
hasKey(String key)

Contains this key?

protected String
keyNotFound(String key,
 Locale originalLocale,
 Map<String,Object> params)
 




Methods inherited from class org.spincast.core.dictionary.DictionaryBase
getAllKeys, getMessages, key, msg

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

Methods inherited from interface org.spincast.core.dictionary.Dictionary
getAllKeys









Field Details



logger
protected static final org.slf4j.Logger logger








Constructor Details



SpincastDictionaryDefault
@Inject
public SpincastDictionaryDefault(LocaleResolver localeResolver,
 TemplatingEngine templatingEngine,
 SpincastConfig spincastConfig,
 @Nullable
 Set<DictionaryEntries> dictionaryEntries)








Method Details



getDefaultLocale
protected Locale getDefaultLocale()




getTemplatingEngine
protected TemplatingEngine getTemplatingEngine()




getSpincastConfig
protected SpincastConfig getSpincastConfig()




getDictionaryEntries
protected Set<DictionaryEntries> getDictionaryEntries()




hasKey
public boolean hasKey(String key)
Description copied from interface: Dictionary
Contains this key?

Specified by:
hasKey in interface Dictionary





get
public String get(String key)
Gets a message.

 Will use the proper Locale as provided by the
 LocaleResolver.

Specified by:
get in interface Dictionary





get
public String get(String key,
 Locale locale)
Description copied from interface: Dictionary
Gets a message.
 

 Uses the specified Locale.
 

 The behavior if the key is not found can be configured using
 SpincastConfig#getDictionaryEntryNotFoundFallbackTo() and
 SpincastConfig.getDictionaryEntryNotFoundBehavior().

Specified by:
get in interface Dictionary





get
public String get(String key,
 boolean forceTemplatingEngine)
Gets a message.

 Will use the proper Locale as provided by the
 LocaleResolver.

Specified by:
get in interface Dictionary
forceTemplatingEngine - if true,
 the TemplatingEngine will be used even there
 are no parameters. This may be useful to trigger some
 templating function that don't need parameters. We don't
 use the templting engine will default since it is costy.
 

 The behavior if the key is not found can be configured using
 SpincastConfig#getDictionaryEntryNotFoundFallbackTo() and
 SpincastConfig.getDictionaryEntryNotFoundBehavior().





get
public String get(String key,
 Locale locale,
 boolean forceEvaluation)
Description copied from interface: Dictionary
Gets a message.
 

 Uses the specified Locale.
 


Specified by:
get in interface Dictionary
forceEvaluation - if true,
 the TemplatingEngine will be used even there
 are no parameters. This may be useful to trigger some
 templating function that don't need parameters. We don't
 use the templting engine will default since it is costy.
 

 The behavior if the key is not found can be configured using
 SpincastConfig#getDictionaryEntryNotFoundFallbackTo() and
 SpincastConfig.getDictionaryEntryNotFoundBehavior().





get
public final String get(String key,
 Pair... params)
Gets a message.

 Will use the proper Locale as provided by the
 LocaleResolver.

Specified by:
get in interface Dictionary





get
public String get(String key,
 Locale locale,
 Pair... params)
Description copied from interface: Dictionary
Gets a message.
 

 Uses the specified Locale.
 

 The behavior if the key is not found can be configured using
 SpincastConfig#getDictionaryEntryNotFoundFallbackTo() and
 SpincastConfig.getDictionaryEntryNotFoundBehavior().

Specified by:
get in interface Dictionary





get
public String get(String key,
 Map<String,Object> params)
Gets a message.

 Will use the proper Locale as provided by the
 LocaleResolver.

Specified by:
get in interface Dictionary





get
public String get(String key,
 Locale locale,
 Map<String,Object> params)
Description copied from interface: Dictionary
Gets a message.
 

 Uses the specified Locale.
 

 The behavior if the key is not found can be configured using
 SpincastConfig#getDictionaryEntryNotFoundFallbackTo() and
 SpincastConfig.getDictionaryEntryNotFoundBehavior().

Specified by:
get in interface Dictionary





get
public String get(String key,
 Locale locale,
 Map<String,Object> params,
 Locale originalLocale)




keyNotFound
protected String keyNotFound(String key,
 Locale originalLocale,
 Map<String,Object> params)




addCoreAndPluginsMessages
protected void addCoreAndPluginsMessages()




getAll
public Map<String,String> getAll(String key)
Description copied from interface: Dictionary
Return all the possible values, for all languages used,
 by language abreviation.

Specified by:
getAll in interface Dictionary





getAll
public Map<String,String> getAll(String key,
 Pair... params)
Description copied from interface: Dictionary
Return all the possible values, for all languages used,
 by language abreviation.

Specified by:
getAll in interface Dictionary





getAll
public Map<String,String> getAll(String key,
 Map<String,Object> params)
Description copied from interface: Dictionary
Return all the possible values, for all languages used,
 by language abreviation.

Specified by:
getAll in interface Dictionary





addMessages
protected void addMessages()
To override to add messages to the dictionary.
 


 Example :

 
 protected void addMessages() {
     super.addMessages();

     key("my.message.key",
         msg("en", "The message in english"),
         msg("fr", "Le message en français"));
 }